--- /dev/null
+/*******************************************************************************\r
+ * Copyright (c) 2007, 2010 Association for Decentralized Information Management\r
+ * in Industry THTH ry.\r
+ * All rights reserved. This program and the accompanying materials\r
+ * are made available under the terms of the Eclipse Public License v1.0\r
+ * which accompanies this distribution, and is available at\r
+ * http://www.eclipse.org/legal/epl-v10.html\r
+ *\r
+ * Contributors:\r
+ * VTT Technical Research Centre of Finland - initial API and implementation\r
+ *******************************************************************************/\r
+package org.simantics.g2d.diagram;\r
+\r
+import java.awt.Color;\r
+import java.awt.Point;\r
+import java.awt.geom.Point2D;\r
+import java.util.List;\r
+import java.util.Map;\r
+\r
+import org.simantics.g2d.canvas.ICanvasContext;\r
+import org.simantics.g2d.canvas.ICanvasParticipant;\r
+import org.simantics.g2d.connection.IConnectionAdvisor;\r
+import org.simantics.g2d.layers.ILayers;\r
+import org.simantics.g2d.layers.ILayersEditor;\r
+import org.simantics.g2d.routing.IRouter2;\r
+import org.simantics.scenegraph.g2d.snap.ISnapAdvisor;\r
+import org.simantics.utils.datastructures.hints.IHintContext.Key;\r
+import org.simantics.utils.datastructures.hints.IHintContext.KeyOf;\r
+import org.simantics.utils.page.MarginUtils.Margins;\r
+\r
+/**\r
+ * These hints are meant to be used with IDiagram instances.\r
+ * \r
+ * @author Toni Kalajainen\r
+ */\r
+public class DiagramHints {\r
+\r
+ /**\r
+ * A hint for disabling painting of the diagram the hint is associated with.\r
+ * \r
+ * <p>\r
+ * By default diagram viewers perform a zoom-to-fit operation on the opened\r
+ * diagram immediately after opening. Sometimes it is desirable to allow\r
+ * disabling of this fitting process. Due to the SWT/AWT interplay nature of\r
+ * diagram editors, the process of zoom-to-fit is rather asynchronous and\r
+ * needs to schedule runnables into the toolkit threads. Since editor\r
+ * opening is synchronously performed in the SWT thread we can safely veto\r
+ * the zoom-to-fit operation by removing this hint from the diagram after\r
+ * opening the editor.\r
+ * \r
+ * <p>\r
+ * Can also be set for an {@link ICanvasContext} to enable or disable\r
+ * initial zoom to fit for the context regardless of the diagram in\r
+ * question.\r
+ */\r
+ public static final Key KEY_INITIAL_ZOOM_TO_FIT = new KeyOf(Boolean.class, "INITIAL_ZOOM_TO_FIT");\r
+\r
+ /** Diagram */\r
+ public static final Key KEY_DIAGRAM = new KeyOf(IDiagram.class, "DIAGRAM");\r
+\r
+ public static final Key KEY_SELECTION_FRAME_COLOR = new KeyOf(Color.class, "SELECTION_FRAME_COLOR");\r
+\r
+ public static final Key KEY_TEXT = new KeyOf(String.class, "DIAGRAM_TEXT");\r
+\r
+ public static final Key KEY_CANVAS_COLOR = new KeyOf(Color.class, "CANVAS_COLOR");\r
+\r
+ // Layer composition List<LayerInfo>\r
+ public static final Key KEY_LAYER_COMPOSITION = new KeyOf(List.class, "LAYER_COMPOSITION");\r
+\r
+ // public static final Key KEY_BOUNDS = ElementHints.KEY_BOUNDS;\r
+\r
+ public final static Key KEY_MARGINS = new KeyOf(Margins.class, "MARGINS");\r
+\r
+ public final static Key KEY_MARGINS_NO_RULER = new KeyOf(Margins.class, "MARGINS_NO_RULER");\r
+\r
+ /**\r
+ * For diagrams, this hint defines the default routing algorithm applied to\r
+ * any connection that does not defined its own routing. For connection\r
+ * elements, this hint defines the selected connection-specific routing\r
+ * strategy.\r
+ */\r
+ public static final Key ROUTE_ALGORITHM = new KeyOf(IRouter2.class, "ROUTE_ALGORITHM");\r
+\r
+ public static final Key PROPERTIES = new KeyOf(Map.class, "PROPERTIES");\r
+\r
+ public static final Key CONNECTION_ADVISOR = new KeyOf(IConnectionAdvisor.class, "CONNECTION_ADVISOR");\r
+\r
+ public static final Key SNAP_ADVISOR = new KeyOf(ISnapAdvisor.class, "SNAP_ADVISOR");\r
+\r
+ public static final Key KEY_LAYERS = new KeyOf(ILayers.class, "LAYERS");\r
+\r
+ public static final Key KEY_LAYERS_EDITOR = new KeyOf(ILayersEditor.class, "LAYERS_EDITOR");\r
+\r
+ public static final Key KEY_FIXED_LAYERS = new KeyOf(String[].class, "FIXED_LAYERS");\r
+\r
+ public static final Key KEY_MUTATOR = new KeyOf(DiagramMutator.class, "MUTATIONS");\r
+\r
+ public static final Key KEY_NAVIGATION_ENABLED = new KeyOf(Boolean.class, "NAVIGATION_ENABLED");\r
+\r
+ /**\r
+ * A hint for describing the target rasterized size of element images in a\r
+ * diagram. This is useful for UI components like the symbol library which\r
+ * always shows symbols in a certain size in pixels. Images are generally\r
+ * pre-rasterized and mipmapped in order to speed up SVG rendering. This\r
+ * allows making sure that the symbol is properly rasterized at its target\r
+ * resolution instead of having to resort to mipmaps. If this hint is not provided,\r
+ * a default procedure for resolving the mipmap sizes is followed.\r
+ */\r
+ public static final Key KEY_ELEMENT_RASTER_TARGET_SIZE = new KeyOf(Point.class, "ELEMENT_RASTER_TARGET_SIZE");\r
+\r
+ /**\r
+ * This hint is used to mark an element that is being inline edited on a\r
+ * diagram. This hint can be used for example to make sure that only one\r
+ * element is being inline edited at any given time on a single diagram.\r
+ */\r
+ public static final Key KEY_ACTIVE_INLINE_EDITOR = new KeyOf(ICanvasParticipant.class, "ACTIVE_INLINE_EDITOR");\r
+\r
+ /**\r
+ * <code>true</code> to allow connection branching. <code>null</code> or\r
+ * <code>false</code> will disable connection branching.\r
+ * \r
+ * This is a hint for editing, not for visualisation.\r
+ * \r
+ * If the hint is not present, the default interpretation should be to allow branching.\r
+ */\r
+ public static final Key KEY_ALLOW_CONNECTION_BRANCHING = new KeyOf(Boolean.class, "ALLOW_CONNECTION_BRANCHING");\r
+\r
+ /**\r
+ * <code>true</code> to create flags when connections are left in the air,\r
+ * <code>null</code> or <code>false</code> will leave the connections\r
+ * hanging in the air.\r
+ * \r
+ * This is a hint for editing, not for visualisation.\r
+ * \r
+ * If the hint is not present, the default interpretation should be not to\r
+ * use connection flags.\r
+ */\r
+ public static final Key KEY_USE_CONNECTION_FLAGS = new KeyOf(Boolean.class, "USE_CONNECTION_FLAGS");\r
+\r
+ /**\r
+ * <code>true</code> to allow adding of route points into connections or\r
+ * <code>false</code> to deny route points from being added/created.\r
+ * \r
+ * This is a hint for editing, not for visualisation.\r
+ * \r
+ * If the hint is not present, the default interpretation should be to use\r
+ * route points\r
+ */\r
+ public static final Key KEY_ALLOW_ROUTE_POINTS = new KeyOf(Boolean.class, "ALLOW_ROUTE_POINTS");\r
+\r
+\r
+ /**\r
+ * A Hint for other participants to use for showing the context menu at the\r
+ * contol position specified by the Point2D argument.\r
+ */\r
+ public static final Key SHOW_POPUP_MENU = new KeyOf(Point2D.class, "SHOW_POPUP_MENU_CMD");\r
+\r
+ /**\r
+ * Screen position of mouse on canvas control when the menu was invoked to\r
+ * be opened. For use by menu contributions.\r
+ */\r
+ public static final Key POPUP_MENU_CONTROL_POSITION = new KeyOf(Point2D.class, "POPUP_MENU_CONTROL_POSITION");\r
+\r
+ /**\r
+ * Canvas position of mouse on canvas control when the menu was invoked to\r
+ * be opened. For use by menu contributions.\r
+ */\r
+ public static final Key POPUP_MENU_CANVAS_POSITION = new KeyOf(Point2D.class, "POPUP_MENU_CANVAS_POSITION");\r
+\r
+ /**\r
+ * {@link System#currentTimeMillis()} from the time of processing the popup\r
+ * menu show event.\r
+ */\r
+ public static final Key POPUP_MENU_SHOWN = new KeyOf(Long.class, "POPUP_MENU_SHOWN");\r
+\r
+ /**\r
+ * {@link System#currentTimeMillis()} from the time of processing the popup\r
+ * menu hide event.\r
+ */\r
+ public static final Key POPUP_MENU_HIDDEN = new KeyOf(Long.class, "POPUP_MENU_HIDDEN");\r
+\r
+}\r
Code Review / simantics / platform.git / blobdiff