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     private 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 void setEditorId(String editorId) {
  77                 this.editorId = editorId;
  78         }
  79
  80     @Override
  81     public void dispose() {
  82         if (resourceManager != null) {
  83             resourceManager.dispose();
  84             resourceManager = null;
  85         }
  86         super.dispose();
  87     }
  88
  89     protected Object extractResource(ReadGraph graph, Object object) throws DatabaseException {
  90         Resource resource = WorkbenchSelectionUtils.getPossibleResourceFromSelection(graph, object);
  91         return resource != null ? resource : object;
  92     }
  93
  94     @Override
  95     protected boolean preAcceptSelection(Object[] selection) {
  96         return selection.length == 1;
  97     }
  98
  99     protected String getText() {
 100         return "Open With";
 101     }
 102
 103     @Override
 104     protected IContributionItem[] getContributionItems(ReadGraph graph, Object[] selection) throws DatabaseException {
 105         final Object r = extractResource(graph, selection[0]);
 106         if (r == null)
 107             return NONE;
 108         EditorAdapter[] _editorAdapters = EditorRegistry.getInstance().getAdaptersFor(graph, r);
 109         final EditorAdapter[] editorAdapters = filter(_editorAdapters, editorId);
 110         if (editorAdapters.length == 0)
 111             return NONE;
 112
 113
 114         return new IContributionItem[] {
 115                 new ContributionItem() {
 116                     @Override
 117                     public void fill(Menu menu, int index) {
 118                         MenuItem openWith = new MenuItem(menu, SWT.CASCADE, index);
 119                         openWith.setText(getText());
 120                         openWith.setEnabled(editorAdapters.length > 0);
 121                         Menu subMenu = new Menu(menu);
 122                         openWith.setMenu(subMenu);
 123
 124                         if (editorAdapters.length > 0) {
 125                             // Sort the open with actions in descending priority order.
 126                             Adapter[] adapters = new Adapter[editorAdapters.length];
 127                             for (int i = 0; i < editorAdapters.length; i++)
 128                                 adapters[i] = new Adapter(editorAdapters[i], r, true);
 129                             Arrays.sort(adapters, new Comparator<Adapter>() {
 130                                 @Override
 131                                 public int compare(Adapter o1, Adapter o2) {
 132                                     int delta = o2.getPriority() - o1.getPriority();
 133                                     if (delta != 0)
 134                                         return delta;
 135                                     return AlphanumComparator.CASE_INSENSITIVE_COMPARATOR.compare(o1.getText(), o2.getText());
 136                                 }
 137                             });
 138
 139                             for (Adapter a : adapters)
 140                                 addMenuItem(subMenu, a, r);
 141                         }
 142                     }
 143                 }
 144         };
 145     }
 146
 147     protected EditorAdapter[] filter(EditorAdapter[] adapters, String id) {
 148         if (id == null)
 149                 return adapters;
 150         List<EditorAdapter> editorAdapters = new ArrayList<EditorAdapter>();
 151         for (EditorAdapter a : adapters) {
 152                 if (id.equals(a.getEditorId()))
 153                         continue;
 154                 editorAdapters.add(a);
 155         }
 156         return editorAdapters.toArray(new EditorAdapter[editorAdapters.size()]);
 157     }
 158
 159     private void addMenuItem(Menu subMenu, Adapter adapter, Object r) {
 160         MenuItem item = new MenuItem(subMenu, SWT.PUSH);
 161         String text = adapter.getText();
 162         if (DEBUG_ADAPTERS) {
 163             text = text + " (" + adapter.getAdapter().getClass().getCanonicalName() + ") [" + adapter.getPriority() + "]";
 164         }
 165         item.setText(text);
 166         ImageDescriptor descriptor = adapter.getImageDescriptor();
 167         if (descriptor != null) {
 168             item.setImage(resourceManager.createImage(descriptor));
 169         }
 170         item.addSelectionListener(adapter);
 171     }
 172
 173     static class Adapter extends ResourceEditorAdapterAction implements SelectionListener {
 174         boolean remember;
 175
 176         public Adapter(EditorAdapter adapter, Object r, boolean remember) {
 177             super(adapter, r);
 178             this.remember = remember;
 179         }
 180
 181         @Override
 182         public void widgetDefaultSelected(SelectionEvent e) {
 183             widgetSelected(e);
 184         }
 185
 186         @Override
 187         public void widgetSelected(SelectionEvent e) {
 188             run();
 189         }
 190
 191         @Override
 192         protected void safeRun() throws Exception {
 193             super.safeRun();
 194
 195             if (remember) {
 196                 // Make this choice the default for the next time.
 197                 EditorRegistry.getInstance().getMappings().put(getResource(), getAdapter());
 198             }
 199         }
 200     }
 201
 202 }