bundles/org.simantics.modeling.ui/src/org/simantics/modeling/ui/diagramEditor/handlers/e4/StructuralBrowsingHandler.java

   1 /*******************************************************************************\r
   2  * Copyright (c) 2007, 2014 Association for Decentralized Information Management\r
   3  * in Industry THTH ry.\r
   4  * All rights reserved. This program and the accompanying materials\r
   5  * are made available under the terms of the Eclipse Public License v1.0\r
   6  * which accompanies this distribution, and is available at\r
   7  * http://www.eclipse.org/legal/epl-v10.html\r
   8  *\r
   9  * Contributors:\r
  10  *     VTT Technical Research Centre of Finland - initial API and implementation\r
  11  *     Semantum Oy - support SHIFT+left double click browsing outside of model configuration\r
  12  *******************************************************************************/\r
  13 package org.simantics.modeling.ui.diagramEditor.handlers.e4;\r
  14 \r
  15 import java.util.HashMap;\r
  16 import java.util.Map;\r
  17 import java.util.Set;\r
  18 \r
  19 import org.eclipse.e4.ui.model.application.ui.basic.MPart;\r
  20 import org.eclipse.e4.ui.model.application.ui.basic.MWindow;\r
  21 import org.eclipse.ui.PlatformUI;\r
  22 import org.simantics.db.ReadGraph;\r
  23 import org.simantics.db.Resource;\r
  24 import org.simantics.db.common.request.PossibleIndexRoot;\r
  25 import org.simantics.db.common.request.UniqueRead;\r
  26 import org.simantics.db.exception.DatabaseException;\r
  27 import org.simantics.db.layer0.variable.RVI;\r
  28 import org.simantics.db.layer0.variable.Variable;\r
  29 import org.simantics.db.layer0.variable.Variables;\r
  30 import org.simantics.db.management.ISessionContext;\r
  31 import org.simantics.diagram.flag.FlagUtil;\r
  32 import org.simantics.diagram.stubs.DiagramResource;\r
  33 import org.simantics.diagram.ui.DiagramModelHints;\r
  34 import org.simantics.g2d.canvas.impl.DependencyReflection.Dependency;\r
  35 import org.simantics.g2d.diagram.participant.AbstractDiagramParticipant;\r
  36 import org.simantics.g2d.diagram.participant.Selection;\r
  37 import org.simantics.g2d.element.ElementHints;\r
  38 import org.simantics.g2d.element.IElement;\r
  39 import org.simantics.layer0.utils.operations.IOperation;\r
  40 import org.simantics.modeling.ModelingOperationConstants;\r
  41 import org.simantics.modeling.ModelingResources;\r
  42 import org.simantics.modeling.actions.NavigateToTarget;\r
  43 import org.simantics.scenegraph.g2d.events.EventHandlerReflection.EventHandler;\r
  44 import org.simantics.scenegraph.g2d.events.MouseEvent.MouseDoubleClickedEvent;\r
  45 import org.simantics.structural.stubs.StructuralResource2;\r
  46 import org.simantics.ui.workbench.IResourceEditorInput2;\r
  47 import org.simantics.ui.workbench.e4.E4ResourceEditorConstants;\r
  48 import org.simantics.ui.workbench.e4.E4WorkbenchUtils;\r
  49 import org.simantics.utils.datastructures.persistent.ContextMap;\r
  50 import org.simantics.utils.ui.ErrorLogger;\r
  51 \r
  52 /**\r
  53  * StructuralBrowsingHandler supports visual browsing into subcomponents through\r
  54  * mouse events.\r
  55  * \r
  56  * @author Tuukka Lehtonen\r
  57  */\r
  58 public class StructuralBrowsingHandler extends AbstractDiagramParticipant {\r
  59 \r
  60     @Dependency\r
  61     Selection             selection;\r
  62     MPart                 part;\r
  63     ISessionContext       sessionContext;\r
  64     IResourceEditorInput2 input;\r
  65 \r
  66     public StructuralBrowsingHandler(ISessionContext sessionContext, MPart part, IResourceEditorInput2 input) {\r
  67         this.sessionContext = sessionContext;\r
  68         this.part = part;\r
  69         this.input = input;\r
  70     }\r
  71 \r
  72     @EventHandler(priority = 0)\r
  73     public boolean handleDoubleClick(MouseDoubleClickedEvent me) {\r
  74         if (sessionContext == null || diagram == null)\r
  75             return false;\r
  76         \r
  77         Set<IElement> sel = selection.getSelection(0);\r
  78         if (sel.size() == 1) {\r
  79             IElement e = sel.iterator().next();\r
  80             Object data = e.getHint(ElementHints.KEY_OBJECT);\r
  81             final Resource runtime = diagram.getHint(DiagramModelHints.KEY_DIAGRAM_RUNTIME_RESOURCE);\r
  82             if (data instanceof Resource) {\r
  83                 final Resource element = (Resource) data;\r
  84                 final int stateMask = me.stateMask;\r
  85                 try {\r
  86                     return sessionContext.getSession().syncRequest(new UniqueRead<Boolean>() {\r
  87                         @Override\r
  88                         public Boolean perform(ReadGraph graph) throws DatabaseException {\r
  89                             return browse(graph, element, runtime, stateMask);\r
  90                         }\r
  91                     });\r
  92                 } catch (DatabaseException e1) {\r
  93                     ErrorLogger.defaultLogError(e1);\r
  94                 }\r
  95             }\r
  96         }\r
  97 \r
  98         return false;\r
  99     }\r
 100     \r
 101     private boolean browse(ReadGraph graph, Resource element, Resource runtimeDiagram, int stateMask) throws DatabaseException {\r
 102         DiagramResource DIA = DiagramResource.getInstance(graph);\r
 103         ModelingResources mr = ModelingResources.getInstance(graph);\r
 104         DiagramResource dr = DiagramResource.getInstance(graph);\r
 105         StructuralResource2 sr = StructuralResource2.getInstance(graph);\r
 106 \r
 107         if (graph.isInstanceOf(element, dr.Flag)) {\r
 108             ContextMap parameters = new ContextMap();\r
 109             parameters.put(ModelingOperationConstants.WORKBENCH_WINDOW, part.getContext().get(MWindow.class));\r
 110             parameters.put(ModelingOperationConstants.WORKBENCH_PART, part);\r
 111             parameters.put(IOperation.SUBJECT, element);\r
 112             new NavigateToTarget().exec(graph.getSession(), parameters);\r
 113             // Return true only if the flag is joined somewhere and navigation is possible.\r
 114             return FlagUtil.isJoined(graph, element);\r
 115         }\r
 116 \r
 117         if((stateMask & MouseDoubleClickedEvent.SHIFT_MASK) == 0)\r
 118             return false;\r
 119 \r
 120         if(runtimeDiagram == null || !graph.isInstanceOf(runtimeDiagram, DIA.RuntimeDiagram))\r
 121             return false;\r
 122 \r
 123         final Resource component = graph.getPossibleObject(element, mr.ElementToComponent);\r
 124         if (component == null)\r
 125             return false;\r
 126 \r
 127         Resource type = graph.getPossibleType(component, sr.Component);\r
 128         if (type == null)\r
 129             return false;\r
 130         if(graph.hasStatement(type, sr.ComponentType_Locked))\r
 131             return false;\r
 132 \r
 133         Resource definedBy = graph.getPossibleObject(type, sr.IsDefinedBy);\r
 134         if (definedBy == null)\r
 135             return false;\r
 136 \r
 137         final Resource diagram = graph.getPossibleObject(definedBy, mr.CompositeToDiagram);\r
 138         if (diagram == null)\r
 139             return false;\r
 140 \r
 141         Resource model = input.getModel(graph);\r
 142         RVI subprocessRVI = null;\r
 143 \r
 144         String rvis = (String) graph.getPossibleRelatedValue(runtimeDiagram, DIA.RuntimeDiagram_HasRVI);\r
 145         if (rvis != null) {\r
 146             RVI rvi = RVI.fromResourceFormat(graph, rvis);\r
 147             Variable base = Variables.getConfigurationContext(graph, model);\r
 148             Variable current = rvi.resolve(graph, base);\r
 149             Variable subprocess = current.browse(graph, component);\r
 150             subprocessRVI = subprocess.getRVI(graph);\r
 151         } else {\r
 152             // Not in a model configuration context.\r
 153             // Probably in a component type configuration.\r
 154             // Use the index root of the diagram to be opened as model[0]\r
 155             // and leave subprocessRVI[0] as null.\r
 156             model = graph.syncRequest(new PossibleIndexRoot(definedBy));\r
 157         }\r
 158 \r
 159         PlatformUI.getWorkbench().getDisplay().asyncExec(navigateToSubstructure(diagram, model, subprocessRVI));\r
 160         return true;\r
 161     }\r
 162 \r
 163     private Runnable navigateToSubstructure(final Resource diagram, final Resource model, final RVI subprocessRVI) {\r
 164         return new Runnable() {\r
 165             @Override\r
 166             public void run() {\r
 167                 String inputId = Long.toString(diagram.getResourceId());\r
 168                 Map<String, Object> inputMap = new HashMap<>();\r
 169                 inputMap.put(E4ResourceEditorConstants.KEY_RESOURCE, diagram);\r
 170                 inputMap.put(E4ResourceEditorConstants.KEY_MODEL, model);\r
 171                 inputMap.put(E4ResourceEditorConstants.KEY_RVI, subprocessRVI);\r
 172                 E4WorkbenchUtils.openEditor(part.getElementId(), "", "", inputId, inputMap);\r
 173             }\r
 174         };\r
 175     }\r
 176 \r
 177 }\r