1 /*******************************************************************************
\r
2 * Copyright (c) 2007, 2010 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
10 * VTT Technical Research Centre of Finland - initial API and implementation
\r
11 *******************************************************************************/
\r
12 package org.simantics.diagram.ui.e4;
\r
14 import java.awt.geom.Point2D;
\r
16 import org.eclipse.e4.ui.model.application.ui.basic.MPart;
\r
17 import org.eclipse.e4.ui.model.application.ui.menu.MMenu;
\r
18 import org.eclipse.e4.ui.model.application.ui.menu.MMenuFactory;
\r
19 import org.eclipse.e4.ui.model.application.ui.menu.MPopupMenu;
\r
20 import org.eclipse.jface.action.GroupMarker;
\r
21 import org.eclipse.jface.action.IMenuListener2;
\r
22 import org.eclipse.jface.action.IMenuManager;
\r
23 import org.eclipse.jface.action.MenuManager;
\r
24 import org.eclipse.swt.SWT;
\r
25 import org.eclipse.swt.events.MenuAdapter;
\r
26 import org.eclipse.swt.events.MenuEvent;
\r
27 import org.eclipse.swt.events.MenuListener;
\r
28 import org.eclipse.swt.graphics.Point;
\r
29 import org.eclipse.swt.widgets.Control;
\r
30 import org.eclipse.swt.widgets.Display;
\r
31 import org.eclipse.swt.widgets.Event;
\r
32 import org.eclipse.swt.widgets.Listener;
\r
33 import org.eclipse.swt.widgets.Menu;
\r
34 import org.eclipse.ui.IWorkbenchActionConstants;
\r
35 import org.eclipse.ui.IWorkbenchPartSite;
\r
36 import org.simantics.diagram.ui.WorkbenchSelectionProvider;
\r
37 import org.simantics.g2d.canvas.ICanvasContext;
\r
38 import org.simantics.g2d.canvas.impl.AbstractCanvasParticipant;
\r
39 import org.simantics.g2d.canvas.impl.DependencyReflection.Dependency;
\r
40 import org.simantics.g2d.diagram.DiagramHints;
\r
41 import org.simantics.g2d.participant.TransformUtil;
\r
42 import org.simantics.scenegraph.g2d.events.EventHandlerReflection.EventHandler;
\r
43 import org.simantics.scenegraph.g2d.events.command.CommandEvent;
\r
44 import org.simantics.scenegraph.g2d.events.command.ShowPopup;
\r
45 import org.simantics.utils.datastructures.hints.HintListenerAdapter;
\r
46 import org.simantics.utils.datastructures.hints.IHintContext.Key;
\r
47 import org.simantics.utils.datastructures.hints.IHintListener;
\r
48 import org.simantics.utils.datastructures.hints.IHintObservable;
\r
51 * A participant that initializes an SWT pop-up menu and registers it with the
\r
52 * Eclipse workbench if a workbench site is provided. The client can specify the
\r
53 * ID of the menu to create which allows the user to control contributions via
\r
54 * Eclipse's declarative command mechanisms.
\r
56 * @author Tuukka Lehtonen
\r
58 public class SWTPopupMenuParticipant extends AbstractCanvasParticipant {
\r
61 WorkbenchSelectionProvider wbsp;
\r
63 TransformUtil trUtil;
\r
68 MenuManager menuManager;
\r
71 IHintListener popupListener = new HintListenerAdapter() {
\r
73 public void hintChanged(IHintObservable sender, Key key, Object oldValue, Object newValue) {
\r
74 if (key == DiagramHints.SHOW_POPUP_MENU) {
\r
75 if (newValue != null) {
\r
76 Control c = control;
\r
77 if (display.isDisposed() || c == null || c.isDisposed())
\r
80 showPopup((Point2D) newValue);
\r
86 IMenuListener2 menuManagerListener = new IMenuListener2() {
\r
88 public void menuAboutToShow(IMenuManager manager) {
\r
89 manager.add(new GroupMarker(IWorkbenchActionConstants.WB_START));
\r
90 // manager.add(new GroupMarker(IWorkbenchActionConstants.NEW_EXT));
\r
91 // manager.add(new GroupMarker(IWorkbenchActionConstants.IMPORT_EXT));
\r
92 // manager.add(new Separator(IWorkbenchActionConstants.MB_ADDITIONS));
\r
93 // manager.add(new GroupMarker(IWorkbenchActionConstants.WB_END));
\r
96 public void menuAboutToHide(IMenuManager manager) {
\r
100 MenuListener menuListener = new MenuAdapter() {
\r
102 public void menuShown(MenuEvent e) {
\r
103 asyncExec(new Runnable() {
\r
105 public void run() {
\r
106 final long time = System.currentTimeMillis();
\r
107 //System.out.println("popup shown: " + time);
\r
108 setHint(DiagramHints.POPUP_MENU_SHOWN, time);
\r
109 removeHint(DiagramHints.POPUP_MENU_HIDDEN);
\r
114 public void menuHidden(MenuEvent e) {
\r
115 asyncExec(new Runnable() {
\r
117 public void run() {
\r
118 final long time = System.currentTimeMillis();
\r
119 //System.out.println("popup closed: " + time);
\r
120 removeHint(DiagramHints.POPUP_MENU_SHOWN);
\r
121 setHint(DiagramHints.POPUP_MENU_HIDDEN, time);
\r
128 * NOTE: this constructor must currently be invoked from the SWT display
\r
134 * @deprecated use {@link #SWTPopupMenuParticipant(IWorkbenchPartSite, Control, Display, String)} instead
\r
136 public SWTPopupMenuParticipant(MPart part, Control control, String menuId) {
\r
137 this(part, control, control.getDisplay(), menuId);
\r
140 public SWTPopupMenuParticipant(MPart part, Control control, Display display, String menuId) {
\r
143 this.control = control;
\r
144 this.display = display;
\r
145 this.menuId = menuId;
\r
146 control.addListener(SWT.Dispose, new Listener() {
\r
149 public void handleEvent(Event event) {
\r
150 SWTPopupMenuParticipant.this.control = null;
\r
151 if(menuManager != null) {
\r
152 menuManager.removeAll();
\r
153 menuManager.dispose();
\r
154 menuManager = null;
\r
162 public void addedToContext(ICanvasContext ctx) {
\r
163 super.addedToContext(ctx);
\r
165 display.asyncExec(new Runnable() {
\r
167 public void run() {
\r
168 if (control == null || control.isDisposed())
\r
170 menuManager = createPopupMenu();
\r
171 if (menuManager != null) {
\r
172 Menu menu = menuManager.createContextMenu(control);
\r
173 menu.addMenuListener(menuListener);
\r
174 control.setMenu(menu);
\r
175 if (part != null) {
\r
176 // #TODO Finish this when we are going to use full E4 workbench
\r
177 // site.registerContextMenu(menuManager.getId(), menuManager, wbsp);
\r
183 getHintStack().addKeyHintListener(DiagramHints.SHOW_POPUP_MENU, popupListener);
\r
187 public void removedFromContext(ICanvasContext ctx) {
\r
188 getHintStack().removeKeyHintListener(DiagramHints.SHOW_POPUP_MENU, popupListener);
\r
189 super.removedFromContext(ctx);
\r
192 protected MenuManager createPopupMenu() {
\r
193 // #TODO Finish this when we are going to use full E4 workbench
\r
194 // MPopupMenu popupMenu = MMenuFactory.INSTANCE.createPopupMenu();
\r
195 // popupMenu.setLabel("Canvas Popup");
\r
196 // popupMenu.setElementId(menuId);
\r
199 final MenuManager mm = new MenuManager("Canvas Popup", menuId);
\r
200 mm.setRemoveAllWhenShown(true);
\r
201 mm.addMenuListener(menuManagerListener);
\r
205 @EventHandler(priority = 0)
\r
206 public boolean handleCommands(CommandEvent e) {
\r
207 if (e.command instanceof ShowPopup) {
\r
208 showPopup(((ShowPopup) e.command).getControlPosition());
\r
216 * @thread canvas-thread (AWT)
\r
218 protected void showPopup(Point2D newValue) {
\r
219 final Point2D cp = (Point2D) newValue;
\r
220 setHint(DiagramHints.POPUP_MENU_CONTROL_POSITION, cp);
\r
221 setHint(DiagramHints.POPUP_MENU_CANVAS_POSITION, trUtil.controlToCanvas(cp, null));
\r
222 display.asyncExec(new Runnable() {
\r
224 public void run() {
\r
225 if (control == null || control.isDisposed())
\r
227 Point p = control.toDisplay((int) cp.getX(), (int) cp.getY());
\r
228 menuManager.getMenu().setLocation(p);
\r
229 menuManager.getMenu().setVisible(true);
\r