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