bundles/org.simantics.diagram/src/org/simantics/diagram/ui/SWTPopupMenuParticipant.java

   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
   8  *\r
   9  * Contributors:\r
  10  *     VTT Technical Research Centre of Finland - initial API and implementation\r
  11  *******************************************************************************/\r
  12 package org.simantics.diagram.ui;\r
  13 \r
  14 import java.awt.geom.Point2D;\r
  15 \r
  16 import org.eclipse.jface.action.GroupMarker;\r
  17 import org.eclipse.jface.action.IMenuListener2;\r
  18 import org.eclipse.jface.action.IMenuManager;\r
  19 import org.eclipse.jface.action.MenuManager;\r
  20 import org.eclipse.swt.SWT;\r
  21 import org.eclipse.swt.events.MenuAdapter;\r
  22 import org.eclipse.swt.events.MenuEvent;\r
  23 import org.eclipse.swt.events.MenuListener;\r
  24 import org.eclipse.swt.graphics.Point;\r
  25 import org.eclipse.swt.widgets.Control;\r
  26 import org.eclipse.swt.widgets.Display;\r
  27 import org.eclipse.swt.widgets.Event;\r
  28 import org.eclipse.swt.widgets.Listener;\r
  29 import org.eclipse.swt.widgets.Menu;\r
  30 import org.eclipse.swt.widgets.Widget;\r
  31 import org.eclipse.ui.IWorkbenchActionConstants;\r
  32 import org.eclipse.ui.IWorkbenchPartSite;\r
  33 import org.simantics.g2d.canvas.ICanvasContext;\r
  34 import org.simantics.g2d.canvas.impl.AbstractCanvasParticipant;\r
  35 import org.simantics.g2d.canvas.impl.DependencyReflection.Dependency;\r
  36 import org.simantics.g2d.diagram.DiagramHints;\r
  37 import org.simantics.g2d.participant.TransformUtil;\r
  38 import org.simantics.scenegraph.g2d.events.EventHandlerReflection.EventHandler;\r
  39 import org.simantics.scenegraph.g2d.events.command.CommandEvent;\r
  40 import org.simantics.scenegraph.g2d.events.command.ShowPopup;\r
  41 import org.simantics.utils.datastructures.hints.HintListenerAdapter;\r
  42 import org.simantics.utils.datastructures.hints.IHintContext.Key;\r
  43 import org.simantics.utils.datastructures.hints.IHintListener;\r
  44 import org.simantics.utils.datastructures.hints.IHintObservable;\r
  45 \r
  46 /**\r
  47  * A participant that initializes an SWT pop-up menu and registers it with the\r
  48  * Eclipse workbench if a workbench site is provided. The client can specify the\r
  49  * ID of the menu to create which allows the user to control contributions via\r
  50  * Eclipse's declarative command mechanisms.\r
  51  * \r
  52  * @author Tuukka Lehtonen\r
  53  */\r
  54 public class SWTPopupMenuParticipant extends AbstractCanvasParticipant {\r
  55 \r
  56     @Dependency\r
  57     WorkbenchSelectionProvider wbsp;\r
  58     @Dependency\r
  59     TransformUtil              trUtil;\r
  60 \r
  61     IWorkbenchPartSite         site;\r
  62     Control                    control;\r
  63     Display                    display;\r
  64     MenuManager                menuManager;\r
  65     String                     menuId;\r
  66 \r
  67     IHintListener popupListener = new HintListenerAdapter() {\r
  68         @Override\r
  69         public void hintChanged(IHintObservable sender, Key key, Object oldValue, Object newValue) {\r
  70             if (key == DiagramHints.SHOW_POPUP_MENU) {\r
  71                 if (newValue != null) {\r
  72                     Control c = control;\r
  73                     if (display.isDisposed() || c == null || c.isDisposed())\r
  74                         return;\r
  75 \r
  76                     showPopup((Point2D) newValue);\r
  77                 }\r
  78             }\r
  79         }\r
  80     };\r
  81 \r
  82     IMenuListener2 menuManagerListener = new IMenuListener2() {\r
  83         @Override\r
  84         public void menuAboutToShow(IMenuManager manager) {\r
  85             manager.add(new GroupMarker(IWorkbenchActionConstants.WB_START));\r
  86 //            manager.add(new GroupMarker(IWorkbenchActionConstants.NEW_EXT));\r
  87 //            manager.add(new GroupMarker(IWorkbenchActionConstants.IMPORT_EXT));\r
  88 //            manager.add(new Separator(IWorkbenchActionConstants.MB_ADDITIONS));\r
  89 //            manager.add(new GroupMarker(IWorkbenchActionConstants.WB_END));\r
  90         }\r
  91         @Override\r
  92         public void menuAboutToHide(IMenuManager manager) {\r
  93         }\r
  94     };\r
  95 \r
  96     MenuListener menuListener = new MenuAdapter() {\r
  97         @Override\r
  98         public void menuShown(MenuEvent e) {\r
  99                 SWTPopupMenuParticipant.this.menuShown(e);\r
 100         }\r
 101         @Override\r
 102         public void menuHidden(MenuEvent e) {\r
 103                 SWTPopupMenuParticipant.this.menuHidden(e);\r
 104         }\r
 105     };\r
 106     \r
 107     protected void menuShown(MenuEvent e) {\r
 108         asyncExec(new Runnable() {\r
 109             @Override\r
 110             public void run() {\r
 111                 final long time = System.currentTimeMillis();\r
 112                 //System.out.println("popup shown: " + time);\r
 113                 setHint(DiagramHints.POPUP_MENU_SHOWN, time);\r
 114                 removeHint(DiagramHints.POPUP_MENU_HIDDEN);\r
 115                 \r
 116             }\r
 117         });\r
 118     }\r
 119     \r
 120     protected void menuHidden(MenuEvent e) {\r
 121         asyncExec(new Runnable() {\r
 122             @Override\r
 123             public void run() {\r
 124                 final long time = System.currentTimeMillis();\r
 125                 //System.out.println("popup closed: " + time);\r
 126                 removeHint(DiagramHints.POPUP_MENU_SHOWN);\r
 127                 setHint(DiagramHints.POPUP_MENU_HIDDEN, time);\r
 128             }\r
 129         });\r
 130     }\r
 131 \r
 132     /**\r
 133      * NOTE: this constructor must currently be invoked from the SWT display\r
 134      * thread.\r
 135      * \r
 136      * @param site\r
 137      * @param control\r
 138      * @param menuId\r
 139      * @deprecated use {@link #SWTPopupMenuParticipant(IWorkbenchPartSite, Control, Display, String)} instead\r
 140      */\r
 141     public SWTPopupMenuParticipant(IWorkbenchPartSite site, Control control, String menuId) {\r
 142         this(site, control, control.getDisplay(), menuId);\r
 143     }\r
 144 \r
 145     public SWTPopupMenuParticipant(IWorkbenchPartSite site, Control control, Display display, String menuId) {\r
 146         super();\r
 147         this.site = site;\r
 148         this.control = control;\r
 149         this.display = display;\r
 150         this.menuId = menuId;\r
 151         control.addListener(SWT.Dispose, new Listener() {\r
 152 \r
 153             @Override\r
 154             public void handleEvent(Event event) {\r
 155                 runDispose();\r
 156             }\r
 157             \r
 158         });\r
 159     }\r
 160 \r
 161     protected void runDispose() {\r
 162         SWTPopupMenuParticipant.this.control = null;\r
 163         if(menuManager != null) {\r
 164             menuManager.removeAll();\r
 165             menuManager.dispose();\r
 166             menuManager = null;\r
 167         }\r
 168     }\r
 169     \r
 170     @Override\r
 171     public void addedToContext(ICanvasContext ctx) {\r
 172         super.addedToContext(ctx);\r
 173 \r
 174         display.asyncExec(new Runnable() {\r
 175             @Override\r
 176             public void run() {\r
 177                createControl();\r
 178             }\r
 179         });\r
 180 \r
 181         getHintStack().addKeyHintListener(DiagramHints.SHOW_POPUP_MENU, popupListener);\r
 182     }\r
 183     \r
 184     protected void createControl() {\r
 185          if (control == null || control.isDisposed())\r
 186              return;\r
 187          menuManager = createPopupMenu();\r
 188          if (menuManager != null) {\r
 189              Menu menu = menuManager.createContextMenu(control);\r
 190              menu.addMenuListener(menuListener);\r
 191              control.setMenu(menu);\r
 192              if (site != null) {\r
 193                  site.registerContextMenu(menuManager.getId(), menuManager, wbsp);\r
 194              }\r
 195          }\r
 196     }\r
 197 \r
 198     @Override\r
 199     public void removedFromContext(ICanvasContext ctx) {\r
 200         getHintStack().removeKeyHintListener(DiagramHints.SHOW_POPUP_MENU, popupListener);\r
 201         super.removedFromContext(ctx);\r
 202     }\r
 203 \r
 204     protected MenuManager createPopupMenu() {\r
 205         final MenuManager mm = new MenuManager("Canvas Popup", menuId);\r
 206         mm.setRemoveAllWhenShown(true);\r
 207         mm.addMenuListener(menuManagerListener);\r
 208         return mm;\r
 209     }\r
 210 \r
 211     @EventHandler(priority = 0)\r
 212     public boolean handleCommands(CommandEvent e) {\r
 213         if (e.command instanceof ShowPopup) {\r
 214             showPopup(((ShowPopup) e.command).getControlPosition());\r
 215             return true;\r
 216         }\r
 217         return false;\r
 218     }\r
 219 \r
 220     /**\r
 221      * @param newValue\r
 222      * @thread canvas-thread (AWT)\r
 223      */\r
 224     protected void showPopup(Point2D newValue) {\r
 225         final Point2D cp = (Point2D) newValue;\r
 226         setHint(DiagramHints.POPUP_MENU_CONTROL_POSITION, cp);\r
 227         setHint(DiagramHints.POPUP_MENU_CANVAS_POSITION, trUtil.controlToCanvas(cp, null));\r
 228         display.asyncExec(new Runnable() {\r
 229             @Override\r
 230             public void run() {\r
 231                 if (control == null || control.isDisposed())\r
 232                     return;\r
 233                 \r
 234                 Point p = control.toDisplay((int) cp.getX(), (int) cp.getY());\r
 235                 menuManager.getMenu().setLocation(p);\r
 236                 menuManager.getMenu().setVisible(true);\r
 237             }\r
 238         });\r
 239     }\r
 240 \r
 241 }\r