bundles/org.simantics.modeling.ui/src/org/simantics/modeling/ui/diagramEditor/OpenDiagramFromConfigurationAdapter.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.modeling.ui.diagramEditor;
  13
  14 import java.util.Collection;
  15 import java.util.Collections;
  16 import java.util.HashSet;
  17 import java.util.Set;
  18
  19 import org.eclipse.ui.PlatformUI;
  20 import org.simantics.Simantics;
  21 import org.simantics.db.ReadGraph;
  22 import org.simantics.db.Resource;
  23 import org.simantics.db.common.request.PossibleIndexRoot;
  24 import org.simantics.db.common.request.PossibleTypedParent;
  25 import org.simantics.db.common.request.ReadRequest;
  26 import org.simantics.db.exception.DatabaseException;
  27 import org.simantics.db.layer0.variable.RVI;
  28 import org.simantics.db.layer0.variable.Variable;
  29 import org.simantics.db.layer0.variable.Variables;
  30 import org.simantics.diagram.stubs.DiagramResource;
  31 import org.simantics.g2d.canvas.ICanvasContext;
  32 import org.simantics.g2d.diagram.DiagramHints;
  33 import org.simantics.layer0.Layer0;
  34 import org.simantics.modeling.ComponentUtils;
  35 import org.simantics.modeling.ModelingResources;
  36 import org.simantics.modeling.actions.NavigateToTarget;
  37 import org.simantics.modeling.ui.Activator;
  38 import org.simantics.structural.stubs.StructuralResource2;
  39 import org.simantics.ui.workbench.editor.AbstractResourceEditorAdapter;
  40 import org.simantics.utils.datastructures.Pair;
  41 import org.simantics.utils.threads.ThreadUtils;
  42
  43 /**
  44  * @author Tuukka Lehtonen
  45  */
  46 public class OpenDiagramFromConfigurationAdapter extends AbstractResourceEditorAdapter {
  47
  48     private static final String EDITOR_ID = "org.simantics.modeling.ui.diagramEditor"; //$NON-NLS-1$
  49
  50     public OpenDiagramFromConfigurationAdapter() {
  51         super(Messages.OpenDiagramFromConfigurationAdapter_DiagramEditor, Activator.COMPOSITE_ICON);
  52     }
  53
  54     protected String getEditorId(ReadGraph g, Resource composite) throws DatabaseException {
  55         ModelingResources MOD = ModelingResources.getInstance(g);
  56         String preferredEditorId = g.getPossibleRelatedValue(composite, MOD.PreferredDiagramEditorID);
  57         if(preferredEditorId != null)
  58             return preferredEditorId;
  59         else
  60             return EDITOR_ID;
  61     }
  62
  63     @Override
  64     public boolean canHandle(ReadGraph g, Resource r) throws DatabaseException {
  65         Resource diagram = getDiagram(g, r, Collections.emptySet());
  66         if(diagram == null)
  67             return false;
  68
  69         // Check if the diagram is locked, because of the locked component type
  70         return !isLocked(g, diagram);
  71
  72 //        return ComponentUtils.compositeHasDiagram(g, r) /*|| ComponentUtils.componentHasDiagram(g, r)*/;
  73     }
  74
  75     public static boolean isLocked(ReadGraph g, Resource diagram) throws DatabaseException {
  76         StructuralResource2 STR = StructuralResource2.getInstance(g);
  77         Resource componentType = g.syncRequest(new PossibleTypedParent(diagram, STR.ComponentType));
  78         if(componentType == null)
  79             return false; // Not part of a component type
  80
  81         return g.hasStatement(componentType, STR.ComponentType_Locked);
  82     }
  83
  84     @Override
  85     public void openEditor(final Resource r) throws Exception {
  86         Simantics.getSession().asyncRequest(new ReadRequest() {
  87             @Override
  88             public void run(ReadGraph g) throws DatabaseException {
  89                 openEditor(g, r, getEditorId(g, r));
  90             }
  91         });
  92     }
  93
  94     /**
  95      * @param g
  96      * @param configurationComposite
  97      * @param editorId
  98      * @throws DatabaseException
  99      */
 100     public static boolean openEditor(ReadGraph g, Resource configurationComposite, final String editorId) throws DatabaseException {
 101         return openEditor(g, configurationComposite, editorId, Collections.emptySet());
 102     }
 103
 104     protected static Resource getDiagram(ReadGraph graph, Resource r, final Collection<Object> selectedObjects) throws DatabaseException {
 105
 106         Layer0 L0 = Layer0.getInstance(graph);
 107         DiagramResource DIA = DiagramResource.getInstance(graph);
 108
 109         if(graph.isInstanceOf(r, DIA.Diagram)) return r;
 110
 111         Resource diagram = ComponentUtils.getPossibleCompositeDiagram(graph, r);
 112         if(diagram != null) return diagram;
 113
 114         // TODO: what if the selected objects are from different diagrams?
 115         if (selectedObjects.size() > 0) {
 116             Set<Resource> diagrams = new HashSet<>();
 117             for (Object o : selectedObjects) {
 118                 if (o instanceof Resource) {
 119                     Resource res = (Resource)o;
 120                     if (graph.isInstanceOf(res, DIA.Element)) {
 121                         diagrams.add(graph.getPossibleObject(res, L0.PartOf));
 122                     }
 123                 }
 124             }
 125             if (diagrams.size() == 1) {
 126                 return diagrams.iterator().next();
 127             }
 128         }
 129         return null;
 130
 131     }
 132
 133     public static Pair<Resource, RVI> getModelAndRVI(ReadGraph graph, Resource configurationComposite) throws DatabaseException {
 134         Variable compositeVariable = Variables.getPossibleVariable(graph, configurationComposite);
 135         if (compositeVariable == null)
 136             return null;
 137
 138         Layer0 L0 = Layer0.getInstance(graph);
 139         StructuralResource2 STR = StructuralResource2.getInstance(graph);
 140         boolean isComponentType = graph.hasStatement(configurationComposite, STR.Defines);
 141         Resource rviContext = graph.syncRequest(new PossibleTypedParent(configurationComposite, L0.RVIContext));
 142
 143         if (isComponentType || rviContext == null) {
 144             Resource indexRoot = graph.sync(new PossibleIndexRoot(configurationComposite));
 145             if (indexRoot == null)
 146                 return null;
 147
 148             return Pair.make(indexRoot, null);
 149         }
 150
 151         final Resource model = Variables.getPossibleModel(graph, compositeVariable);
 152         if (model == null)
 153             return null;
 154         final RVI rvi = compositeVariable.getPossibleRVI(graph);
 155
 156         return Pair.make(model, rvi);
 157     }
 158
 159     /**
 160      * @param g
 161      * @param configurationComposite
 162      * @param editorId
 163      * @param selectedObjects
 164      * @throws DatabaseException
 165      */
 166     public static boolean openEditor(ReadGraph g, Resource r, String editorId, Collection<Object> selectedObjects) throws DatabaseException {
 167         Resource diagram = getDiagram(g, r, selectedObjects);
 168         Resource configurationComposite = diagram != null ? ComponentUtils.getPossibleDiagramComposite(g, diagram) : null;
 169         Pair<Resource, RVI> modelAndRVI = configurationComposite != null ? getModelAndRVI(g, configurationComposite) : null;
 170         //System.out.println("modelAndRVI: " + modelAndRVI);
 171         if (modelAndRVI == null)
 172             return false;
 173         scheduleOpenEditor(editorId, diagram, modelAndRVI.first, modelAndRVI.second, selectedObjects);
 174         return true;
 175     }
 176
 177     /**
 178      * @param g
 179      * @param configurationComposite
 180      * @param editorId
 181      * @param selectedObjects
 182      * @throws DatabaseException
 183      */
 184     public static boolean openEditor(ReadGraph g, Resource r, String editorId, Collection<Object> selectedObjects, Resource model, RVI rvi) throws DatabaseException {
 185         Resource diagram = getDiagram(g, r, selectedObjects);
 186         if (diagram == null)
 187             return false;
 188         scheduleOpenEditor(editorId, diagram, model, rvi, selectedObjects);
 189         return true;
 190     }
 191
 192     /**
 193      * @param g
 194      * @param configurationComposite
 195      * @param editorId
 196      * @param selectedObjects
 197      * @throws DatabaseException
 198      */
 199     private static void scheduleOpenEditor(String editorId, Resource diagram, Resource model, RVI rvi, Collection<Object> selectedObjects) throws DatabaseException {
 200         Runnable editorActivator = NavigateToTarget.editorActivator(editorId, diagram, model, rvi, part -> {
 201             if (selectedObjects.isEmpty())
 202                 return;
 203             ICanvasContext openedCanvas = (ICanvasContext) part.getAdapter(ICanvasContext.class);
 204             assert openedCanvas != null;
 205             // CanvasContext-wide denial of initial zoom-to-fit on diagram open.
 206             openedCanvas.getDefaultHintContext().setHint(DiagramHints.KEY_INITIAL_ZOOM_TO_FIT, Boolean.FALSE);
 207             ThreadUtils.asyncExec(openedCanvas.getThreadAccess(),
 208                     NavigateToTarget.elementSelectorZoomer(openedCanvas, selectedObjects, false));
 209         });
 210         PlatformUI.getWorkbench().getDisplay().asyncExec(editorActivator);
 211     }
 212
 213 }