bundles/org.simantics.modeling.ui/src/org/simantics/modeling/ui/actions/ModeledActions.java

   1 /*******************************************************************************\r
   2  * Copyright (c) 2011, 2016 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 - refactoring\r
  12  *******************************************************************************/\r
  13 package org.simantics.modeling.ui.actions;\r
  14 \r
  15 import java.util.ArrayList;\r
  16 import java.util.Arrays;\r
  17 import java.util.Collection;\r
  18 import java.util.Collections;\r
  19 import java.util.Comparator;\r
  20 import java.util.HashMap;\r
  21 import java.util.List;\r
  22 import java.util.Map;\r
  23 import java.util.Set;\r
  24 \r
  25 import org.eclipse.core.runtime.CoreException;\r
  26 import org.eclipse.core.runtime.IAdaptable;\r
  27 import org.eclipse.core.runtime.IConfigurationElement;\r
  28 import org.eclipse.core.runtime.IExecutableExtension;\r
  29 import org.eclipse.core.runtime.IStatus;\r
  30 import org.eclipse.core.runtime.Status;\r
  31 import org.eclipse.jface.action.Action;\r
  32 import org.eclipse.jface.action.ActionContributionItem;\r
  33 import org.eclipse.jface.action.IContributionItem;\r
  34 import org.eclipse.jface.action.MenuManager;\r
  35 import org.eclipse.jface.action.Separator;\r
  36 import org.simantics.Logger;\r
  37 import org.simantics.browsing.ui.NodeContext;\r
  38 import org.simantics.browsing.ui.common.NodeContextBuilder;\r
  39 import org.simantics.browsing.ui.model.InvalidContribution;\r
  40 import org.simantics.browsing.ui.model.actions.ActionBrowseContext;\r
  41 import org.simantics.browsing.ui.model.actions.IActionCategory;\r
  42 import org.simantics.db.ReadGraph;\r
  43 import org.simantics.db.Resource;\r
  44 import org.simantics.db.exception.DatabaseException;\r
  45 import org.simantics.modeling.ui.Activator;\r
  46 import org.simantics.project.ontology.ProjectResource;\r
  47 import org.simantics.ui.contribution.DynamicMenuContribution;\r
  48 import org.simantics.ui.selection.WorkbenchSelectionElement;\r
  49 import org.simantics.ui.selection.WorkbenchSelectionUtils;\r
  50 \r
  51 public class ModeledActions extends DynamicMenuContribution implements IExecutableExtension {\r
  52 \r
  53     public static final Set<String> defaultBrowseContexts = Collections.singleton(ProjectResource.URIs.ProjectActionContext);\r
  54 \r
  55     protected Set<String> browseContexts = defaultBrowseContexts;\r
  56 \r
  57     protected static final Comparator<Action> ACTION_COMPARATOR = new Comparator<Action>() {\r
  58         @Override\r
  59         public int compare(Action o1, Action o2) {\r
  60             String t1 = o1.getText();\r
  61             String t2 = o2.getText();\r
  62             if(t1 == null) {\r
  63                 if(t2 == null)\r
  64                     return 0;\r
  65                 else\r
  66                     return -1;\r
  67             }           \r
  68             else {\r
  69                 if(t2 == null)\r
  70                     return 1;\r
  71                 else\r
  72                     return t1.compareTo(t2);\r
  73             }\r
  74         }\r
  75     };\r
  76 \r
  77     @Override\r
  78     public void setInitializationData(IConfigurationElement config, String propertyName, Object data) throws CoreException {\r
  79         if(data instanceof String) {\r
  80             String str = (String)data;\r
  81             String[] parms = str.split(";");\r
  82             for(String parm : parms) {\r
  83                 String[] keyValue = parm.split("=");\r
  84                 if(keyValue.length == 2) {\r
  85                     String key = keyValue[0].trim();\r
  86                     if("context".equals(key)) {\r
  87                         browseContexts = Collections.singleton(keyValue[1]);\r
  88                     }\r
  89                 }\r
  90             }\r
  91         }\r
  92     }\r
  93 \r
  94     protected Collection<String> getBrowseContexts() {\r
  95         return browseContexts;\r
  96     }\r
  97 \r
  98     protected Collection<Resource> getBrowseContextResources(ReadGraph graph) throws DatabaseException {\r
  99         Collection<String> names = getBrowseContexts(); \r
 100         ArrayList<Resource> result = new ArrayList<>(names.size());\r
 101         for(String name : names)\r
 102             result.add(graph.getResource(name));\r
 103         return result;\r
 104     }\r
 105 \r
 106     protected List<NodeContext> getContexts(Object[] selection) {\r
 107         if (selection.length == 0)\r
 108             return Collections.emptyList();\r
 109 \r
 110         ArrayList<NodeContext> result = new ArrayList<>(selection.length);\r
 111 \r
 112         for (Object o : selection) {\r
 113             if ((o instanceof IAdaptable)) {\r
 114                     NodeContext nodeContext = ((IAdaptable) o).getAdapter(NodeContext.class);\r
 115                     if (nodeContext != null)\r
 116                         result.add(nodeContext);\r
 117             } else if (o instanceof WorkbenchSelectionElement) {\r
 118                 try {\r
 119                                         Resource res = WorkbenchSelectionUtils.getPossibleResource((WorkbenchSelectionElement)o);\r
 120                                         if(res != null) {\r
 121                                                 result.add(NodeContextBuilder.buildWithInput(res));\r
 122                                         }\r
 123                                 } catch (DatabaseException e) {\r
 124                                         Logger.defaultLogError(e);\r
 125                                 }\r
 126             }\r
 127         }\r
 128 \r
 129         return result;\r
 130     }\r
 131 \r
 132     protected List<NodeContext> getContexts(ReadGraph graph, Object[] selection) throws DatabaseException {\r
 133         return getContexts(selection);\r
 134     }\r
 135 \r
 136     protected static IContributionItem[] toContributionItems(Map<IActionCategory, List<Action>> map) {\r
 137         if (map.isEmpty())\r
 138             return NONE;\r
 139 \r
 140         IActionCategory[] categories = map.keySet().toArray(new IActionCategory[map.size()]);\r
 141         Arrays.sort(categories, IActionCategory.ACTION_CATEGORY_COMPARATOR);\r
 142 \r
 143         ArrayList<IContributionItem> items = new ArrayList<IContributionItem>();\r
 144         boolean first = true;\r
 145         for (IActionCategory category : categories) {\r
 146             List<Action> actions = map.get(category);\r
 147             Collections.sort(actions, ACTION_COMPARATOR);\r
 148 \r
 149             if (category != null && category.isSubmenu()) {\r
 150                 MenuManager manager = new MenuManager(category.getLabel());\r
 151                 for (Action action : actions)\r
 152                     manager.add(new ActionContributionItem(action));\r
 153                 items.add(manager);\r
 154             }\r
 155             else {\r
 156                 if (first)\r
 157                     first = false;\r
 158                 else\r
 159                     items.add(new Separator(category == null ? "" : category.getLabel()));\r
 160                 for (Action action : actions)\r
 161                     items.add(new ActionContributionItem(action));\r
 162             }\r
 163         }\r
 164         return items.toArray(new IContributionItem[items.size()]);\r
 165     }\r
 166 \r
 167     @Override\r
 168     protected Object[] getSelectedObjects() {\r
 169         Object[] sel = super.getSelectedObjects();\r
 170         List<NodeContext> contexts = getContexts(sel);\r
 171         return contexts.toArray(NodeContext.NONE);\r
 172     }\r
 173 \r
 174     @Override\r
 175     protected IContributionItem[] getContributionItems(ReadGraph graph, Object[] selection)\r
 176             throws DatabaseException\r
 177     {\r
 178         List<NodeContext> contexts = Arrays.asList( (NodeContext[]) selection );\r
 179         if (contexts.isEmpty())\r
 180             return NONE;\r
 181 \r
 182         try {\r
 183             NodeContext nodeContext = contexts.get(0);\r
 184 \r
 185             ActionBrowseContext defaultContext = ActionBrowseContext.create(graph, getBrowseContextResources(graph));\r
 186             ActionBrowseContext browseContext = ActionBrowseContext.get(graph, nodeContext, defaultContext);\r
 187 \r
 188             Map<IActionCategory, List<Action>> result = browseContext.getActions(graph, nodeContext, contexts);\r
 189             Map<IActionCategory, List<Action>> current = result;\r
 190 \r
 191             for (int i = 1; i < contexts.size(); i++) {\r
 192 \r
 193                 browseContext = ActionBrowseContext.get(graph, nodeContext, defaultContext);\r
 194 \r
 195                 Map<IActionCategory, List<Action>> m = browseContext.getActions(graph, contexts.get(i), contexts);\r
 196 \r
 197                 result = new HashMap<>();\r
 198 \r
 199                 for(Map.Entry<IActionCategory, List<Action>> entry : m.entrySet()) {\r
 200                     List<Action> exist = current.get(entry.getKey());\r
 201                     if (exist == null)\r
 202                         continue;\r
 203 \r
 204                     ArrayList<Action> l = new ArrayList<Action>();\r
 205                     for(Action e : exist) {\r
 206                         String id = e.getId();\r
 207                         boolean found = false;\r
 208                         for(Action a : entry.getValue()) {\r
 209                             if(id.equals(a.getId())) {\r
 210                                 found = true;\r
 211                                 break;\r
 212                             }\r
 213                         }\r
 214                         if(found) l.add(e);\r
 215                     }\r
 216                     if(!l.isEmpty()) result.put(entry.getKey(), l);\r
 217                 }\r
 218 \r
 219                 current = result;\r
 220 \r
 221             }\r
 222 \r
 223             return toContributionItems(result);\r
 224 \r
 225         } catch (InvalidContribution e) {\r
 226             Activator.getDefault().getLog().log(new Status(IStatus.ERROR, Activator.PLUGIN_ID,\r
 227                     "Invalid contribution encountered in " + getClass().getSimpleName() + ".", e));\r
 228         }\r
 229         return NONE;\r
 230     }\r
 231 \r
 232 }\r