bundles/org.simantics.g2d/src/org/simantics/g2d/participant/RulerPainter.java

   1 /*******************************************************************************\r
   2  * Copyright (c) 2007, 2010 Association for Decentralized Information Management\r
   3  * in Industry THTH ry.\r
   4  * All rights reserved. This program and the accompanying materials\r
   5  * are made available under the terms of the Eclipse Public License v1.0\r
   6  * which accompanies this distribution, and is available at\r
   7  * http://www.eclipse.org/legal/epl-v10.html\r
   8  *\r
   9  * Contributors:\r
  10  *     VTT Technical Research Centre of Finland - initial API and implementation\r
  11  *******************************************************************************/\r
  12 /*\r
  13  *\r
  14  * @author Toni Kalajainen\r
  15  */\r
  16 package org.simantics.g2d.participant;\r
  17 \r
  18 import java.awt.AlphaComposite;\r
  19 import java.awt.Color;\r
  20 import java.awt.Composite;\r
  21 \r
  22 import org.simantics.g2d.canvas.Hints;\r
  23 import org.simantics.g2d.canvas.ICanvasContext;\r
  24 import org.simantics.g2d.canvas.impl.AbstractCanvasParticipant;\r
  25 import org.simantics.g2d.canvas.impl.SGNodeReflection.SGCleanup;\r
  26 import org.simantics.g2d.canvas.impl.SGNodeReflection.SGInit;\r
  27 import org.simantics.scenegraph.g2d.G2DParentNode;\r
  28 import org.simantics.scenegraph.g2d.events.EventHandlerReflection.EventHandler;\r
  29 import org.simantics.scenegraph.g2d.events.command.CommandEvent;\r
  30 import org.simantics.scenegraph.g2d.events.command.Commands;\r
  31 import org.simantics.scenegraph.g2d.nodes.RulerNode;\r
  32 import org.simantics.utils.datastructures.hints.HintListenerAdapter;\r
  33 import org.simantics.utils.datastructures.hints.IHintListener;\r
  34 import org.simantics.utils.datastructures.hints.IHintObservable;\r
  35 import org.simantics.utils.datastructures.hints.IHintContext.Key;\r
  36 import org.simantics.utils.datastructures.hints.IHintContext.KeyOf;\r
  37 import org.simantics.utils.page.MarginUtils;\r
  38 import org.simantics.utils.page.MarginUtils.Margin;\r
  39 import org.simantics.utils.page.MarginUtils.Margins;\r
  40 \r
  41 \r
  42 public class RulerPainter extends AbstractCanvasParticipant {\r
  43 \r
  44     public static final int PAINT_PRIORITY = Integer.MAX_VALUE - 1000;\r
  45 \r
  46     public static final double RULER_WIDTH = 20.0;\r
  47 \r
  48     /** Ruler width + 5% */\r
  49     public static final Margin RULER_MARGIN5 = MarginUtils.marginOf(5, RulerPainter.RULER_WIDTH, 0);\r
  50     /** Ruler width + 2% */\r
  51     public static final Margin RULER_MARGIN2 = MarginUtils.marginOf(2, RulerPainter.RULER_WIDTH, 0);\r
  52     /** 5% margin + ruler */\r
  53     public static final Margins RULER_MARINGS5 = new Margins(RULER_MARGIN5, MarginUtils.MARGIN5, RULER_MARGIN5, MarginUtils.MARGIN5);\r
  54     /** 2% margin + ruler */\r
  55     public static final Margins RULER_MARINGS2 = new Margins(RULER_MARGIN2, MarginUtils.MARGIN2, RULER_MARGIN2, MarginUtils.MARGIN2);\r
  56 \r
  57     public static final Key KEY_RULER_ENABLED = new KeyOf(Boolean.class, "RULER_ENABLED");\r
  58 \r
  59     /** Background color */\r
  60     public static final Key KEY_RULER_BACKGROUND_COLOR = new KeyOf(Color.class, "RULER_BACKGROUND_COLOR");\r
  61 \r
  62     public static final Key KEY_RULER_TEXT_COLOR = new KeyOf(Color.class, "RULER_TEXT_COLOR");\r
  63 \r
  64     public static Color DEFAULT_RULER_BACKGROUND_COLOR = new Color(192, 192, 192, 192);\r
  65 \r
  66     public static Color DEFAULT_RULER_TEXT_COLOR = Color.BLACK;\r
  67 \r
  68     IHintListener hintListener = new HintListenerAdapter() {\r
  69         public void hintChanged(IHintObservable sender, Key key, Object oldValue, Object newValue) {\r
  70             ICanvasContext cc = getContext();\r
  71             if (cc != null) {\r
  72                 updateNode();\r
  73                 cc.getContentContext().setDirty();\r
  74             }\r
  75         }\r
  76     };\r
  77 \r
  78     @Override\r
  79     public void addedToContext(ICanvasContext ctx) {\r
  80         super.addedToContext(ctx);\r
  81         getHintStack().addKeyHintListener(getThread(), KEY_RULER_ENABLED, hintListener);\r
  82         getHintStack().addKeyHintListener(getThread(), KEY_RULER_BACKGROUND_COLOR, hintListener);\r
  83         getHintStack().addKeyHintListener(getThread(), KEY_RULER_TEXT_COLOR, hintListener);\r
  84         getHintStack().addKeyHintListener(getThread(), GridPainter.KEY_GRID_SIZE, hintListener);\r
  85         getHintStack().addKeyHintListener(getThread(), Hints.KEY_DISABLE_PAINTING, hintListener);\r
  86     }\r
  87 \r
  88     @Override\r
  89     public void removedFromContext(ICanvasContext ctx) {\r
  90         getHintStack().removeKeyHintListener(getThread(), KEY_RULER_ENABLED, hintListener);\r
  91         getHintStack().removeKeyHintListener(getThread(), KEY_RULER_BACKGROUND_COLOR, hintListener);\r
  92         getHintStack().removeKeyHintListener(getThread(), KEY_RULER_TEXT_COLOR, hintListener);\r
  93         getHintStack().removeKeyHintListener(getThread(), GridPainter.KEY_GRID_SIZE, hintListener);\r
  94         getHintStack().removeKeyHintListener(getThread(), Hints.KEY_DISABLE_PAINTING, hintListener);\r
  95         super.removedFromContext(ctx);\r
  96     }\r
  97 \r
  98     @SuppressWarnings("unused")\r
  99     private final Composite transparency = AlphaComposite.SrcOver.derive(0.75f);\r
 100 \r
 101     protected RulerNode node = null;\r
 102 \r
 103     @SGInit\r
 104     public void initSG(G2DParentNode parent) {\r
 105         node = parent.addNode("ruler", RulerNode.class);\r
 106         node.setZIndex(PAINT_PRIORITY);\r
 107         updateNode();\r
 108     }\r
 109 \r
 110     @SGCleanup\r
 111     public void cleanupSG() {\r
 112         node.remove();\r
 113     }\r
 114 \r
 115     void updateNode() {\r
 116         node.setEnabled(isPaintingEnabled());\r
 117         node.setGridSize(getGridSize());\r
 118     }\r
 119 \r
 120     private double getGridSize() {\r
 121         Double d = getHint(GridPainter.KEY_GRID_SIZE);\r
 122         return d != null ? d : 1.0;\r
 123     }\r
 124 \r
 125     boolean isPaintingEnabled()\r
 126     {\r
 127         boolean enabled = isEnabled();\r
 128         Boolean globalDisable = getHint(Hints.KEY_DISABLE_PAINTING);\r
 129         return enabled && !Boolean.TRUE.equals(globalDisable);\r
 130     }\r
 131 \r
 132     public boolean isEnabled()\r
 133     {\r
 134         Boolean b = getHint(KEY_RULER_ENABLED);\r
 135         return !Boolean.FALSE.equals(b);\r
 136     }\r
 137 \r
 138     public Color getRulerTextColor()\r
 139     {\r
 140         Color c = getHint(KEY_RULER_TEXT_COLOR);\r
 141         if (c!=null) return c;\r
 142         return DEFAULT_RULER_TEXT_COLOR;\r
 143     }\r
 144 \r
 145     public Color getRulerBackgroundColor()\r
 146     {\r
 147         Color c = getHint(KEY_RULER_BACKGROUND_COLOR);\r
 148         if (c!=null) return c;\r
 149         return DEFAULT_RULER_BACKGROUND_COLOR;\r
 150     }\r
 151 \r
 152     public void setEnabled(boolean enabled)\r
 153     {\r
 154         node.setEnabled(enabled);\r
 155         setHint(KEY_RULER_ENABLED, enabled);\r
 156     }\r
 157 \r
 158     public void setRulerTextColor(Color c)\r
 159     {\r
 160         setHint(KEY_RULER_TEXT_COLOR, c);\r
 161     }\r
 162 \r
 163     public void setRulerBackgroundColor(Color c)\r
 164     {\r
 165         setHint(KEY_RULER_BACKGROUND_COLOR, c);\r
 166     }\r
 167 \r
 168     @EventHandler(priority = 0)\r
 169     public boolean handleKeyEvent(CommandEvent e) {\r
 170         if (e.command.equals( Commands.RULER_ENABLE)) {\r
 171             setEnabled(true);\r
 172             return true;\r
 173         } else if (e.command.equals( Commands.RULER_DISABLE)) {\r
 174             setEnabled(false);\r
 175             return true;\r
 176         } else if (e.command.equals( Commands.RULER_TOGGLE)) {\r
 177             setEnabled(!isEnabled());\r
 178             return true;\r
 179         }\r
 180         return false;\r
 181     }\r
 182 \r
 183 }\r