1 /*******************************************************************************
2 * Copyright (c) 2007, 2010 Association for Decentralized Information Management
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
10 * VTT Technical Research Centre of Finland - initial API and implementation
11 *******************************************************************************/
12 package org.simantics.diagram.ui;
14 import org.simantics.db.Resource;
15 import org.simantics.db.UndoContext;
16 import org.simantics.db.common.ResourceArray;
17 import org.simantics.diagram.adapter.ConnectionVisualsLoader;
18 import org.simantics.diagram.adapter.ElementFactory;
19 import org.simantics.diagram.adapter.IDiagramLoader;
20 import org.simantics.diagram.synchronization.graph.ElementLoader;
21 import org.simantics.diagram.synchronization.graph.ElementWriter;
22 import org.simantics.g2d.canvas.ICanvasContext;
23 import org.simantics.g2d.diagram.IDiagram;
24 import org.simantics.simulation.experiment.IExperiment;
25 import org.simantics.structural2.modelingRules.IModelingRules;
26 import org.simantics.utils.datastructures.hints.IHintContext.Key;
27 import org.simantics.utils.datastructures.hints.IHintContext.KeyOf;
31 * @Author Toni Kalajainen
33 public class DiagramModelHints {
35 public static final Key KEY_DIAGRAM_RESOURCE = new KeyOf(Resource.class, "DIAGRAM_RESOURCE");
37 public static final Key KEY_DIAGRAM_MODEL_URI = new KeyOf(String.class, "DIAGRAM_MODEL_URI");
39 public static final Key KEY_DIAGRAM_RUNTIME_RESOURCE = new KeyOf(Resource.class, "DIAGRAM_RUNTIME_RESOURCE");
41 public static final Key KEY_DIAGRAM_RESOURCE_ARRAY = new KeyOf(ResourceArray.class, "DIAGRAM_RESOURCE_ARRAY");
44 * A hint for defining and extra pass for loading/initializing an element
45 * after the current pass. It is possible to request for infinitely many
46 * passes by always setting a new ElementLoader hint into the loaded element
47 * during loading. The loading process will loop until none of the loaded
48 * elements have a loader hint. An {@link ElementFactory} or
49 * {@link ElementLoader} is only allowed to set this hint on the element it
50 * is loading, not on any other element.
52 public static final Key KEY_ELEMENT_LOADER = new KeyOf(ElementLoader.class, "ELEMENT_LOADER");
55 * Allows customizable external control over how the an IElement gets
56 * written into backing storage (graph) when it is added to a diagram.
58 * This hint will be removed after it has been used by the synchronizer.
60 public static final Key KEY_ELEMENT_WRITER = new KeyOf(ElementWriter.class, "ELEMENT_WRITER");
63 * TODO: what is this for?
65 public static final Key KEY_ACTIVE_EXPERIMENT = new KeyOf(IExperiment.class, "ACTIVE_EXPERIMENT");
68 * Operating UI requires this for some unknown reason.
69 * TODO: find out what this is
71 public static final Key KEY_SESSION_ID = new KeyOf(String.class, "SESSION_ID");
74 * Externally definable rules for topological modeling, i.e. how nodes and
75 * edges and their connectivity is bounded.
77 public static final Key KEY_MODELING_RULES = new KeyOf(IModelingRules.class, "MODELING_RULES");
80 * For customizing how connection segments are loaded for a diagram. Give
81 * this hint as an initial hint to {@link IDiagramLoader} to use your own
82 * version in diagram loading.
84 public static final Key KEY_CONNECTION_VISUALS_LOADER = new KeyOf(ConnectionVisualsLoader.class, "CONNECTION_VISUALS_LOADER");
87 * For storing an {@link UndoContext} in {@link IDiagram} or
88 * {@link ICanvasContext}.
90 * @deprecated to be removed down, do not use anymore
92 public static final Key KEY_UNDO_CONTEXT = new KeyOf(UndoContext.class, "UNDO_CONTEXT");
95 * An informational hint that functions only as a trigger for listeners to
96 * tell that the diagram contents have changed and that the changes have
97 * been noticed and updated into the runtime diagram model ({@link IDiagram}
98 * ). The hint is given the value {@link Boolean#TRUE} every time the update
99 * happens, i.e. the value is of no importance, only the trigger aspect is.
101 public static final Key KEY_DIAGRAM_CONTENTS_UPDATED = new KeyOf(Boolean.class, "DIAGRAM_CONTENTS_UPDATED");