bundles/org.simantics.g2d/src/org/simantics/g2d/element/ElementHints.java

   1 /*******************************************************************************
   2  * Copyright (c) 2007, 2010 Association for Decentralized Information Management
   3  * in Industry THTH ry.
   4  * All rights reserved. This program and the accompanying materials
   5  * are made available under the terms of the Eclipse Public License v1.0
   6  * which accompanies this distribution, and is available at
   7  * http://www.eclipse.org/legal/epl-v10.html
   8  *
   9  * Contributors:
  10  *     VTT Technical Research Centre of Finland - initial API and implementation
  11  *******************************************************************************/
  12 package org.simantics.g2d.element;
  13
  14 import java.awt.AlphaComposite;
  15 import java.awt.Color;
  16 import java.awt.Composite;
  17 import java.awt.Font;
  18 import java.awt.Stroke;
  19 import java.awt.geom.AffineTransform;
  20 import java.awt.geom.Rectangle2D;
  21 import java.util.Collection;
  22 import java.util.HashMap;
  23 import java.util.Set;
  24
  25 import org.simantics.g2d.canvas.Hints;
  26 import org.simantics.g2d.connection.ConnectionEntity;
  27 import org.simantics.g2d.connection.IConnectionAdvisor;
  28 import org.simantics.g2d.element.handler.SceneGraph;
  29 import org.simantics.g2d.element.handler.EdgeVisuals.ArrowType;
  30 import org.simantics.g2d.element.handler.EdgeVisuals.StrokeType;
  31 import org.simantics.g2d.image.Image;
  32 import org.simantics.g2d.utils.Alignment;
  33 import org.simantics.scenegraph.Node;
  34 import org.simantics.utils.datastructures.Callback;
  35 import org.simantics.utils.datastructures.hints.IHintContext.Key;
  36 import org.simantics.utils.datastructures.hints.IHintContext.KeyOf;
  37
  38 /**
  39  * @author Toni Kalajainen
  40  */
  41 public class ElementHints {
  42
  43     /**
  44      * For attaching a paintable scene graph node to a diagram element.
  45      */
  46     public static final Key KEY_SG_NODE = new SceneGraphNodeKey(Node.class, "SG_NODE");
  47
  48     /**
  49      * For attaching a callback to an element that is invoked when KEY_SG_NODE
  50      * is initialized and set.
  51      */
  52     public static final Key KEY_SG_CALLBACK = new SceneGraphNodeKey(Callback.class, "SG_NODE_CALLBACK");
  53
  54     /**
  55      * For describing the local affine transformation of an element.
  56      */
  57     public static final Key KEY_TRANSFORM = new KeyOf(AffineTransform.class, "TRANSFORM");
  58
  59     /**
  60      * For defining the rectangular boundaries of an element.
  61      */
  62     public static final Key KEY_BOUNDS = new KeyOf(Rectangle2D.class, "BOUNDS");
  63
  64     /**
  65      * For defining the parent element of an element to create element hierarchy
  66      * in otherwise flat diagrams.
  67      */
  68     public static final Key KEY_PARENT_ELEMENT = new KeyOf(IElement.class, "PARENT_ELEMENT");
  69
  70     /**
  71      * A collection of {@link SceneGraph} instances. Used for decorating the
  72      * owner element. Run-time decorators are not touched by back-end
  73      * synchronization, they are controlled purely from the diagram run-time
  74      * code. If modified, the {@link Hints#KEY_DIRTY} hint should be set with
  75      * the value {@link Hints#VALUE_SG_DIRTY} to update the scenegraph of the
  76      * element.
  77      *
  78      * @deprecated diagram profile styles should be used instead
  79      */
  80     public static final Key KEY_DECORATORS = new KeyOf(Collection.class, "DECORATORS");
  81
  82     public static final Key KEY_ANCHOR = new KeyOf(IElement.class, "ANCHOR");
  83
  84     public static final Key KEY_TEXT = new KeyOf(String.class, "TEXT");
  85     public static final Key KEY_FONT = new KeyOf(Font.class, "FONT");
  86
  87     public static final Key KEY_TEXT_COLOR = new KeyOf(Color.class, "TEXT_COLOR");
  88     public static final Key KEY_BORDER_COLOR = new KeyOf(Color.class, "BORDER_COLOR");
  89     public static final Key KEY_FILL_COLOR = new KeyOf(Color.class, "FILL_COLOR");
  90     public static final Key KEY_ADDITIONAL_COLOR = new KeyOf(Color.class, "ADDITIONAL_COLOR");
  91     public static final Key KEY_STROKE = new KeyOf(Stroke.class, "STROKE");
  92
  93     public static final Key KEY_ENABLED = new KeyOf(Boolean.class, "ENABLED");
  94
  95     public static final Key KEY_EDGE_STROKE = new KeyOf(Stroke.class, "EDGE_STROKE");
  96     public static final Key KEY_EDGE_STROKE_TYPE = new KeyOf(StrokeType.class, "EDGE_STROKE_TYPE");
  97     public static final Key KEY_BEGIN_ARROW = new KeyOf(ArrowType.class, "BEGIN_ARROW");
  98     public static final Key KEY_END_ARROW = new KeyOf(ArrowType.class, "END_ARROW");
  99     public static final Key KEY_BEGIN_ARROW_SIZE = new KeyOf(Double.class, "BEGIN_ARROW_SIZE");
 100     public static final Key KEY_END_ARROW_SIZE = new KeyOf(Double.class, "END_ARROW_SIZE");
 101
 102     /** Source of data in external data model */
 103     public static final Key KEY_OBJECT = new KeyOf(Object.class, "OBJECT");
 104     public static final Key KEY_TYPE_CLASS = new KeyOf(String.class, "TYPE_CLASS");
 105
 106     /**
 107      * Used for identifying elements that should be ignored in all matters
 108      * concerning rendering/measuring/interaction.
 109      */
 110     public static final Key KEY_HIDDEN = new KeyOf(HideState.class, "HIDDEN");
 111
 112     /**
 113      * Used for specifying the name prefix of the scene graph node to generate
 114      * for the owner element. See {@link ElementUtils#generateNodeId(IElement)}.
 115      */
 116     public static final Key KEY_SG_NAME = new KeyOf(String.class, "SG_NAME");
 117
 118     /** Points to the external data model object which this element is a copy of. */
 119     public static final Key KEY_COPY_OF_OBJECT = new KeyOf(Object.class, "COPY_OF_OBJECT");
 120
 121     /** Value of a widget */
 122     public static final Key KEY_VALUE = new KeyOf(Double.class, "VALUE");
 123     public static final Key KEY_MIN_VALUE = new KeyOf(Double.class, "MIN_VALUE");
 124     public static final Key KEY_MAX_VALUE = new KeyOf(Double.class, "MAX_VALUE");
 125
 126     /** Is widget locked (unusable) */
 127     public static final Key KEY_LOCKED = new KeyOf(Boolean.class, "LOCKED");
 128
 129     public static final Key KEY_SELECTED = new KeyOf(Boolean.class, "SELECTED");
 130
 131     /** Is mouse cursor on top of element **/
 132     public static final Key KEY_HOVER = new KeyOf(Boolean.class, "HOVER");
 133
 134     /** Can the element be resized **/
 135     public static final Key KEY_RESIZABLE = new KeyOf(Boolean.class, "RESIZABLE");
 136
 137     public static final Key KEY_IMAGE = new KeyOf(Image.class, "IMAGE");
 138
 139     /**
 140      * Composition rule for element painting. If this hint is found from an
 141      * element, it should be applied before painting the element. The only
 142      * implementation of {@link Composite} is {@link AlphaComposite} so that
 143      * should be used.
 144      */
 145     public static final Key KEY_COMPOSITE = new KeyOf(Composite.class, "COMPOSITE");
 146
 147     /**
 148      * An optional type hint for a connection to be created. This hint is used
 149      * for storing something returned by
 150      * {@link IConnectionAdvisor#canBeConnected(Object, IElement, org.simantics.g2d.diagram.handler.Topology.Terminal, IElement, org.simantics.g2d.diagram.handler.Topology.Terminal)}
 151      */
 152     public static final Key KEY_CONNECTION_TYPE = new KeyOf(Object.class, "CONNECTION_TYPE");
 153
 154     public static final Key KEY_HORIZONTAL_ALIGN = new KeyOf(Alignment.class, "HORIZONTAL_ALIGN");
 155
 156     public static final Key KEY_VERTICAL_ALIGN   = new KeyOf(Alignment.class, "VERTICAL_ALIGN");
 157
 158     /**
 159      * For storing a connection entity within each connection and connection
 160      * part element.
 161      */
 162     public static final Key KEY_CONNECTION_ENTITY = new KeyOf(ConnectionEntity.class, "CONNECTION_ENTITY");
 163
 164     /**
 165      * A set of ILayer instances identifying the layers the element containing
 166      * this hint can be considered to be visible on.
 167      */
 168     public static final Key KEY_VISIBLE_LAYERS = new KeyOf(Set.class, "VISIBLE_LAYERS");
 169
 170     /**
 171      * A set of ILayer instances identifying the layers the element containing
 172      * this hint can be considered to be focusable on.
 173      */
 174     public static final Key KEY_FOCUS_LAYERS = new KeyOf(Set.class, "FOCUS_LAYERS");
 175
 176     /**
 177      * Properties map
 178      */
 179     public static final Key KEY_ELEMENT_PROPERTIES = new KeyOf(Properties.class, "ELEMENT_PROPERTIES");
 180
 181     public static class Properties extends HashMap<String, Object> {
 182         private static final long serialVersionUID = 6986415032113675720L;
 183     }
 184
 185     /**
 186      * A base class for keys that are to be considered discardable in
 187      * synchronization.
 188      */
 189     public static class DiscardableKey extends KeyOf {
 190         public DiscardableKey(Class<?> clazz) {
 191             super(clazz);
 192         }
 193         public DiscardableKey(Class<?> clazz, String string) {
 194             super(clazz, string);
 195         }
 196     }
 197
 198 }