bundles/org.simantics.ui/src/org/simantics/ui/contribution/OpenWithMenuContribution.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.ui.contribution;
  13
  14 import java.util.ArrayList;
  15 import java.util.Arrays;
  16 import java.util.Comparator;
  17 import java.util.Hashtable;
  18 import java.util.List;
  19
  20 import org.eclipse.core.runtime.CoreException;
  21 import org.eclipse.core.runtime.IConfigurationElement;
  22 import org.eclipse.core.runtime.IExecutableExtension;
  23 import org.eclipse.jface.action.ContributionItem;
  24 import org.eclipse.jface.action.IContributionItem;
  25 import org.eclipse.jface.resource.ImageDescriptor;
  26 import org.eclipse.jface.resource.JFaceResources;
  27 import org.eclipse.jface.resource.LocalResourceManager;
  28 import org.eclipse.jface.resource.ResourceManager;
  29 import org.eclipse.swt.SWT;
  30 import org.eclipse.swt.events.SelectionEvent;
  31 import org.eclipse.swt.events.SelectionListener;
  32 import org.eclipse.swt.widgets.Menu;
  33 import org.eclipse.swt.widgets.MenuItem;
  34 import org.simantics.db.ReadGraph;
  35 import org.simantics.db.Resource;
  36 import org.simantics.db.exception.DatabaseException;
  37 import org.simantics.ui.selection.WorkbenchSelectionUtils;
  38 import org.simantics.ui.workbench.action.ResourceEditorAdapterAction;
  39 import org.simantics.ui.workbench.editor.EditorAdapter;
  40 import org.simantics.ui.workbench.editor.EditorRegistry;
  41 import org.simantics.utils.strings.AlphanumComparator;
  42 import org.simantics.utils.ui.workbench.WorkbenchUtils;
  43
  44
  45 /**
  46  * @author Tuukka Lehtonen
  47  */
  48 public class OpenWithMenuContribution extends DynamicMenuContribution implements IExecutableExtension{
  49
  50     private static final boolean DEBUG_ADAPTERS = false;
  51
  52     protected ResourceManager resourceManager;
  53
  54     private String editorId = null;
  55     public OpenWithMenuContribution() {
  56         resourceManager = new LocalResourceManager(JFaceResources.getResources());
  57     }
  58
  59     @Override
  60     public void setInitializationData(IConfigurationElement config, String propertyName, Object data)
  61                 throws CoreException {
  62         if ("class".equals(propertyName)) {
  63                 if (data instanceof String) {
  64                         setEditorId((String)data);
  65                 } else if (data instanceof Hashtable) {
  66                         @SuppressWarnings("unchecked")
  67                                 Hashtable<String,String> params = (Hashtable<String, String>)data;
  68                         setEditorId(params.get("editorId"));
  69                 }
  70                 if ("activeEditorId".equals(this.editorId)) {
  71                         setEditorId(WorkbenchUtils.getActiveWorkbenchPart().getSite().getId());
  72                 }
  73         }
  74     }
  75
  76     public String getEditorId() {
  77                 return editorId;
  78         }
  79
  80     public void setEditorId(String editorId) {
  81                 this.editorId = editorId;
  82         }
  83
  84     @Override
  85     public void dispose() {
  86         if (resourceManager != null) {
  87             resourceManager.dispose();
  88             resourceManager = null;
  89         }
  90         super.dispose();
  91     }
  92
  93     protected Object extractResource(ReadGraph graph, Object object) throws DatabaseException {
  94         Resource resource = WorkbenchSelectionUtils.getPossibleResourceFromSelection(graph, object);
  95         return resource != null ? resource : object;
  96     }
  97
  98     @Override
  99     protected boolean preAcceptSelection(Object[] selection) {
 100         return selection.length == 1;
 101     }
 102
 103     protected String getText() {
 104         return "Open With";
 105     }
 106
 107     @Override
 108     protected IContributionItem[] getContributionItems(ReadGraph graph, Object[] selection) throws DatabaseException {
 109         final Object r = extractResource(graph, selection[0]);
 110         if (r == null)
 111             return NONE;
 112         EditorAdapter[] _editorAdapters = EditorRegistry.getInstance().getAdaptersFor(graph, r);
 113         final EditorAdapter[] editorAdapters = filter(_editorAdapters, editorId);
 114         if (editorAdapters.length == 0)
 115             return NONE;
 116
 117
 118         return new IContributionItem[] {
 119                 new ContributionItem() {
 120                     @Override
 121                     public void fill(Menu menu, int index) {
 122                         MenuItem openWith = new MenuItem(menu, SWT.CASCADE, index);
 123                         openWith.setText(getText());
 124                         openWith.setEnabled(editorAdapters.length > 0);
 125                         Menu subMenu = new Menu(menu);
 126                         openWith.setMenu(subMenu);
 127
 128                         if (editorAdapters.length > 0) {
 129                             // Sort the open with actions in descending priority order.
 130                                 Adapter[] adapters = toAdapters(editorAdapters, r);
 131
 132                             for (Adapter a : adapters)
 133                                 addMenuItem(subMenu, a, r);
 134                         }
 135                     }
 136                 }
 137         };
 138     }
 139
 140     protected Adapter[] toAdapters(EditorAdapter[] editorAdapters, Object r) {
 141          Adapter[] adapters = new Adapter[editorAdapters.length];
 142          for (int i = 0; i < editorAdapters.length; i++)
 143              adapters[i] = new Adapter(editorAdapters[i], r, true);
 144          Arrays.sort(adapters, new Comparator<Adapter>() {
 145              @Override
 146              public int compare(Adapter o1, Adapter o2) {
 147                  int delta = o2.getPriority() - o1.getPriority();
 148                  if (delta != 0)
 149                      return delta;
 150                  return AlphanumComparator.CASE_INSENSITIVE_COMPARATOR.compare(o1.getText(), o2.getText());
 151              }
 152          });
 153          return adapters;
 154     }
 155
 156     protected EditorAdapter[] filter(EditorAdapter[] adapters, String id) {
 157         if (id == null)
 158                 return adapters;
 159         List<EditorAdapter> editorAdapters = new ArrayList<EditorAdapter>();
 160         for (EditorAdapter a : adapters) {
 161                 if (id.equals(a.getEditorId()))
 162                         continue;
 163                 editorAdapters.add(a);
 164         }
 165         return editorAdapters.toArray(new EditorAdapter[editorAdapters.size()]);
 166     }
 167
 168     private void addMenuItem(Menu subMenu, Adapter adapter, Object r) {
 169         MenuItem item = new MenuItem(subMenu, SWT.PUSH);
 170         String text = adapter.getText();
 171         if (DEBUG_ADAPTERS) {
 172             text = text + " (" + adapter.getAdapter().getClass().getCanonicalName() + ") [" + adapter.getPriority() + "]";
 173         }
 174         item.setText(text);
 175         ImageDescriptor descriptor = adapter.getImageDescriptor();
 176         if (descriptor != null) {
 177             item.setImage(resourceManager.createImage(descriptor));
 178         }
 179         item.addSelectionListener(adapter);
 180     }
 181
 182     protected static class Adapter extends ResourceEditorAdapterAction implements SelectionListener {
 183         boolean remember;
 184
 185         public Adapter(EditorAdapter adapter, Object r, boolean remember) {
 186             super(adapter, r);
 187             this.remember = remember;
 188         }
 189
 190         @Override
 191         public void widgetDefaultSelected(SelectionEvent e) {
 192             widgetSelected(e);
 193         }
 194
 195         @Override
 196         public void widgetSelected(SelectionEvent e) {
 197             run();
 198         }
 199
 200         @Override
 201         protected void safeRun() throws Exception {
 202             super.safeRun();
 203
 204             if (remember) {
 205                 // Make this choice the default for the next time.
 206                 EditorRegistry.getInstance().getMappings().put(getResource(), getAdapter());
 207             }
 208         }
 209     }
 210
 211 }