bundles/org.simantics.g2d/src/org/simantics/g2d/diagram/DiagramHints.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.diagram;
  13
  14 import java.awt.Color;
  15 import java.awt.Point;
  16 import java.awt.geom.Point2D;
  17 import java.util.List;
  18 import java.util.Map;
  19
  20 import org.simantics.g2d.canvas.ICanvasContext;
  21 import org.simantics.g2d.canvas.ICanvasParticipant;
  22 import org.simantics.g2d.connection.IConnectionAdvisor;
  23 import org.simantics.g2d.diagram.handler.impl.PickContextImpl;
  24 import org.simantics.g2d.diagram.participant.ElementPainter;
  25 import org.simantics.g2d.element.IElement;
  26 import org.simantics.g2d.layers.ILayers;
  27 import org.simantics.g2d.layers.ILayersEditor;
  28 import org.simantics.g2d.routing.IRouter2;
  29 import org.simantics.scenegraph.INode;
  30 import org.simantics.scenegraph.g2d.snap.ISnapAdvisor;
  31 import org.simantics.utils.datastructures.hints.IHintContext.Key;
  32 import org.simantics.utils.datastructures.hints.IHintContext.KeyOf;
  33 import org.simantics.utils.page.MarginUtils.Margins;
  34
  35 /**
  36  * These hints are meant to be used with IDiagram instances.
  37  *
  38  * @author Toni Kalajainen
  39  */
  40 public class DiagramHints {
  41
  42     /**
  43      * A hint for disabling painting of the diagram the hint is associated with.
  44      *
  45      * <p>
  46      * By default diagram viewers perform a zoom-to-fit operation on the opened
  47      * diagram immediately after opening. Sometimes it is desirable to allow
  48      * disabling of this fitting process. Due to the SWT/AWT interplay nature of
  49      * diagram editors, the process of zoom-to-fit is rather asynchronous and
  50      * needs to schedule runnables into the toolkit threads. Since editor
  51      * opening is synchronously performed in the SWT thread we can safely veto
  52      * the zoom-to-fit operation by removing this hint from the diagram after
  53      * opening the editor.
  54      *
  55      * <p>
  56      * Can also be set for an {@link ICanvasContext} to enable or disable
  57      * initial zoom to fit for the context regardless of the diagram in
  58      * question.
  59      */
  60     public static final Key KEY_INITIAL_ZOOM_TO_FIT   = new KeyOf(Boolean.class, "INITIAL_ZOOM_TO_FIT");
  61
  62     /** Diagram */
  63     public static final Key KEY_DIAGRAM               = new KeyOf(IDiagram.class, "DIAGRAM");
  64
  65     public static final Key KEY_SELECTION_FRAME_COLOR = new KeyOf(Color.class, "SELECTION_FRAME_COLOR");
  66
  67     public static final Key KEY_TEXT                  = new KeyOf(String.class, "DIAGRAM_TEXT");
  68
  69     public static final Key KEY_CANVAS_COLOR          = new KeyOf(Color.class, "CANVAS_COLOR");
  70
  71     // Layer composition List<LayerInfo>
  72     public static final Key KEY_LAYER_COMPOSITION     = new KeyOf(List.class, "LAYER_COMPOSITION");
  73
  74     // public static final Key KEY_BOUNDS = ElementHints.KEY_BOUNDS;
  75
  76     public final static Key KEY_MARGINS               = new KeyOf(Margins.class, "MARGINS");
  77
  78     public final static Key KEY_MARGINS_NO_RULER      = new KeyOf(Margins.class, "MARGINS_NO_RULER");
  79
  80     /**
  81      * For diagrams, this hint defines the default routing algorithm applied to
  82      * any connection that does not defined its own routing. For connection
  83      * elements, this hint defines the selected connection-specific routing
  84      * strategy.
  85      */
  86     public static final Key ROUTE_ALGORITHM           = new KeyOf(IRouter2.class, "ROUTE_ALGORITHM");
  87
  88     public static final Key PROPERTIES                = new KeyOf(Map.class, "PROPERTIES");
  89
  90     public static final Key CONNECTION_ADVISOR        = new KeyOf(IConnectionAdvisor.class, "CONNECTION_ADVISOR");
  91
  92     public static final Key SNAP_ADVISOR              = new KeyOf(ISnapAdvisor.class, "SNAP_ADVISOR");
  93
  94     public static final Key KEY_LAYERS                = new KeyOf(ILayers.class, "LAYERS");
  95
  96     public static final Key KEY_LAYERS_EDITOR         = new KeyOf(ILayersEditor.class, "LAYERS_EDITOR");
  97
  98     public static final Key KEY_FIXED_LAYERS          = new KeyOf(String[].class, "FIXED_LAYERS");
  99
 100     public static final Key KEY_MUTATOR                = new KeyOf(DiagramMutator.class, "MUTATIONS");
 101
 102     public static final Key KEY_NAVIGATION_ENABLED = new KeyOf(Boolean.class, "NAVIGATION_ENABLED");
 103
 104     /**
 105      * A hint for describing the target rasterized size of element images in a
 106      * diagram. This is useful for UI components like the symbol library which
 107      * always shows symbols in a certain size in pixels. Images are generally
 108      * pre-rasterized and mipmapped in order to speed up SVG rendering. This
 109      * allows making sure that the symbol is properly rasterized at its target
 110      * resolution instead of having to resort to mipmaps. If this hint is not provided,
 111      * a default procedure for resolving the mipmap sizes is followed.
 112      */
 113     public static final Key KEY_ELEMENT_RASTER_TARGET_SIZE = new KeyOf(Point.class, "ELEMENT_RASTER_TARGET_SIZE");
 114
 115     /**
 116      * This hint is used to mark an element that is being inline edited on a
 117      * diagram. This hint can be used for example to make sure that only one
 118      * element is being inline edited at any given time on a single diagram.
 119      */
 120     public static final Key KEY_ACTIVE_INLINE_EDITOR = new KeyOf(ICanvasParticipant.class, "ACTIVE_INLINE_EDITOR");
 121
 122     /**
 123      * <code>true</code> to allow connection branching. <code>null</code> or
 124      * <code>false</code> will disable connection branching.
 125      *
 126      * This is a hint for editing, not for visualisation.
 127      *
 128      * If the hint is not present, the default interpretation should be to allow branching.
 129      */
 130     public static final Key KEY_ALLOW_CONNECTION_BRANCHING = new KeyOf(Boolean.class, "ALLOW_CONNECTION_BRANCHING");
 131
 132     /**
 133      * <code>true</code> to create flags when connections are left in the air,
 134      * <code>null</code> or <code>false</code> will leave the connections
 135      * hanging in the air.
 136      *
 137      * This is a hint for editing, not for visualisation.
 138      *
 139      * If the hint is not present, the default interpretation should be not to
 140      * use connection flags.
 141      */
 142     public static final Key KEY_USE_CONNECTION_FLAGS = new KeyOf(Boolean.class, "USE_CONNECTION_FLAGS");
 143
 144     /**
 145      * <code>true</code> to allow adding of route points into connections or
 146      * <code>false</code> to deny route points from being added/created.
 147      *
 148      * This is a hint for editing, not for visualisation.
 149      *
 150      * If the hint is not present, the default interpretation should be to use
 151      * route points
 152      */
 153     public static final Key KEY_ALLOW_ROUTE_POINTS = new KeyOf(Boolean.class, "ALLOW_ROUTE_POINTS");
 154
 155
 156     /**
 157      * A Hint for other participants to use for showing the context menu at the
 158      * contol position specified by the Point2D argument.
 159      */
 160     public static final Key SHOW_POPUP_MENU                = new KeyOf(Point2D.class, "SHOW_POPUP_MENU_CMD");
 161
 162     /**
 163      * Screen position of mouse on canvas control when the menu was invoked to
 164      * be opened. For use by menu contributions.
 165      */
 166     public static final Key POPUP_MENU_CONTROL_POSITION    = new KeyOf(Point2D.class, "POPUP_MENU_CONTROL_POSITION");
 167
 168     /**
 169      * Canvas position of mouse on canvas control when the menu was invoked to
 170      * be opened. For use by menu contributions.
 171      */
 172     public static final Key POPUP_MENU_CANVAS_POSITION     = new KeyOf(Point2D.class, "POPUP_MENU_CANVAS_POSITION");
 173
 174     /**
 175      * {@link System#currentTimeMillis()} from the time of processing the popup
 176      * menu show event.
 177      */
 178     public static final Key POPUP_MENU_SHOWN               = new KeyOf(Long.class, "POPUP_MENU_SHOWN");
 179
 180     /**
 181      * {@link System#currentTimeMillis()} from the time of processing the popup
 182      * menu hide event.
 183      */
 184     public static final Key POPUP_MENU_HIDDEN              = new KeyOf(Long.class, "POPUP_MENU_HIDDEN");
 185
 186     /**
 187      * For specifying a user-defined padding for selections
 188      *
 189      * @since 1.33.0
 190      */
 191     public static final Key SELECTION_PADDING_SCALE_FACTOR = new KeyOf(Double.class, "SELECTION_PADDING_SCALE_FACTOR");
 192
 193     /**
 194      * An optional cache map that maps scene graph {@link INode}s to
 195      * {@link IElement}s to speed up IElement lookups based on SG nodes.
 196      *
 197      * @since 1.36.0
 198      * @see PickContextImpl
 199      * @see ElementPainter
 200      */
 201     public static final Key NODE_TO_ELEMENT_MAP = new KeyOf(Map.class, "NODE_TO_ELEMENT_MAP");
 202
 203 }