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