]> gerrit.simantics Code Review - simantics/platform.git/blob - bundles/org.simantics.ui/src/org/simantics/ui/contribution/OpenWithMenuContribution.java
Merge "Allow overriding Open With menu's name"
[simantics/platform.git] / 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.Arrays;
15 import java.util.Comparator;
16
17 import org.eclipse.jface.action.ContributionItem;
18 import org.eclipse.jface.action.IContributionItem;
19 import org.eclipse.jface.resource.ImageDescriptor;
20 import org.eclipse.jface.resource.JFaceResources;
21 import org.eclipse.jface.resource.LocalResourceManager;
22 import org.eclipse.jface.resource.ResourceManager;
23 import org.eclipse.swt.SWT;
24 import org.eclipse.swt.events.SelectionEvent;
25 import org.eclipse.swt.events.SelectionListener;
26 import org.eclipse.swt.widgets.Menu;
27 import org.eclipse.swt.widgets.MenuItem;
28 import org.simantics.db.ReadGraph;
29 import org.simantics.db.Resource;
30 import org.simantics.db.exception.DatabaseException;
31 import org.simantics.ui.selection.WorkbenchSelectionUtils;
32 import org.simantics.ui.workbench.action.ResourceEditorAdapterAction;
33 import org.simantics.ui.workbench.editor.EditorAdapter;
34 import org.simantics.ui.workbench.editor.EditorRegistry;
35 import org.simantics.utils.strings.AlphanumComparator;
36
37
38 /**
39  * @author Tuukka Lehtonen
40  */
41 public class OpenWithMenuContribution extends DynamicMenuContribution {
42
43     private static final boolean DEBUG_ADAPTERS = false;
44
45     private ResourceManager resourceManager;
46
47     public OpenWithMenuContribution() {
48         resourceManager = new LocalResourceManager(JFaceResources.getResources());
49     }
50
51     @Override
52     public void dispose() {
53         if (resourceManager != null) {
54             resourceManager.dispose();
55             resourceManager = null;
56         }
57         super.dispose();
58     }
59
60     protected Object extractResource(ReadGraph graph, Object object) throws DatabaseException {
61         Resource resource = WorkbenchSelectionUtils.getPossibleResourceFromSelection(graph, object);
62         return resource != null ? resource : object;
63     }
64
65     @Override
66     protected boolean preAcceptSelection(Object[] selection) {
67         return selection.length == 1;
68     }
69
70     protected String getText() {
71         return "Open With";
72     }
73
74     @Override
75     protected IContributionItem[] getContributionItems(ReadGraph graph, Object[] selection) throws DatabaseException {
76         final Object r = extractResource(graph, selection[0]);
77         if (r == null)
78             return NONE;
79         final EditorAdapter[] editorAdapters = EditorRegistry.getInstance().getAdaptersFor(graph, r);
80         if (editorAdapters.length == 0)
81             return NONE;
82
83         return new IContributionItem[] {
84                 new ContributionItem() {
85                     @Override
86                     public void fill(Menu menu, int index) {
87                         MenuItem openWith = new MenuItem(menu, SWT.CASCADE, index);
88                         openWith.setText(getText());
89                         openWith.setEnabled(editorAdapters.length > 0);
90                         Menu subMenu = new Menu(menu);
91                         openWith.setMenu(subMenu);
92
93                         if (editorAdapters.length > 0) {
94                             // Sort the open with actions in descending priority order.
95                             Adapter[] adapters = new Adapter[editorAdapters.length];
96                             for (int i = 0; i < editorAdapters.length; i++)
97                                 adapters[i] = new Adapter(editorAdapters[i], r, true);
98                             Arrays.sort(adapters, new Comparator<Adapter>() {
99                                 @Override
100                                 public int compare(Adapter o1, Adapter o2) {
101                                     int delta = o2.getPriority() - o1.getPriority();
102                                     if (delta != 0)
103                                         return delta;
104                                     return AlphanumComparator.CASE_INSENSITIVE_COMPARATOR.compare(o1.getText(), o2.getText());
105                                 }
106                             });
107
108                             for (Adapter a : adapters)
109                                 addMenuItem(subMenu, a, r);
110                         }
111                     }
112                 }
113         };
114     }
115
116     private void addMenuItem(Menu subMenu, Adapter adapter, Object r) {
117         MenuItem item = new MenuItem(subMenu, SWT.PUSH);
118         String text = adapter.getText();
119         if (DEBUG_ADAPTERS) {
120             text = text + " (" + adapter.getAdapter().getClass().getCanonicalName() + ") [" + adapter.getPriority() + "]";
121         }
122         item.setText(text);
123         ImageDescriptor descriptor = adapter.getImageDescriptor();
124         if (descriptor != null) {
125             item.setImage(resourceManager.createImage(descriptor));
126         }
127         item.addSelectionListener(adapter);
128     }
129
130     static class Adapter extends ResourceEditorAdapterAction implements SelectionListener {
131         boolean remember;
132
133         public Adapter(EditorAdapter adapter, Object r, boolean remember) {
134             super(adapter, r);
135             this.remember = remember;
136         }
137
138         @Override
139         public void widgetDefaultSelected(SelectionEvent e) {
140             widgetSelected(e);
141         }
142
143         @Override
144         public void widgetSelected(SelectionEvent e) {
145             run();
146         }
147
148         @Override
149         protected void safeRun() throws Exception {
150             super.safeRun();
151
152             if (remember) {
153                 // Make this choice the default for the next time.
154                 EditorRegistry.getInstance().getMappings().put(getResource(), getAdapter());
155             }
156         }
157     }
158
159 }