Eclipse插件开发--深入理解菜单(Menu)功能及其扩展点

1、引言Eclipse 具有丰富的菜单功能，给开发人员提供了很好的用户体验。总体而言，Eclipse 菜单种类包括视图 / 编辑器菜单，主菜单（Main Menu），视图 / 编辑器菜单（ViewPart/EditorPart Menu）和上下文菜单（Context Menu）。插件开发人员通过灵活应用这些菜单，可以给用户提供很好的体验。由于视图和编辑器菜单功能类似，因此本文重点讲述视图菜单（视图下拉菜单及其工具栏菜单），除此之外，还将讲述主菜单和上下文菜单。如图 1 所示为 Project Explorer 视图的菜单，包括视图下拉菜单和工具栏菜单（折叠树节点）。通常而言，出现在视图工具栏的菜单

2、都会出现在视图的下拉菜单，也就是说，比较常用的视图菜单放在视图的工具栏。图 1. Project Explorer 视图的菜单如图 2 所示为 Project Explorer 视图中的上下文菜单，只有当我们右键点击时才会出现。通常而言，出现频率较高的菜单项才会出现在菜单中。上下文菜单具有很强的灵活项，它可以随着我们点击的对象不同，弹出的菜单也会有相应的变化。图 2. Project Explorer 视图中的上下文菜单如图 3 所示为 Eclipse 的主菜单，包括最上面的主菜单项（不可移动）及其下面的工具栏菜单（可以移动，并且 Eclipse 提供了显示 / 不显示这些菜单的功能），Ecl

3、ipse 并不建议我们为每一个插件都添加新的主菜单，这样容易造成冗余，而且不方便用户操作。通常，我们可以把菜单项添加到 Eclipse 已有的菜单，如插件的查找功能可以添加一个查找菜单项到 Eclipse 的 Search 主菜单上。图 3. Eclipse 的主菜单前面讲到 Eclipse 的各种菜单，那么，如何在开发插件或 RCP 应用程序的时候添加这些菜单？本文下面的篇幅将详细介绍如何扩展 Eclipse 的菜单功能，使读者深入了解 Eclipse 的菜单功能，并能够开发具有这些菜单的应用程序。因此，必须掌握三方面的内容：菜单种类，菜单的扩展点，菜单控制（显示 / 隐藏或启用 / 禁用菜

4、单项）。下面从概念上介绍这三方面内容，下一小节将会进行详细介绍。菜单种类正如前面所讲到的，Eclipse 的菜单包括视图菜单，主菜单及上下文菜单三个种类。菜单项的扩展点Eclipse 提供了两种扩展点供用户添加菜单项到相应的位置。这两种扩展点为 mands（本文简称为 Commands 方式）和 org.eclipse.ui.actionSets（本文简称为 Actions 方式）。Actions 方式为界面上不同区域的表现方式提供了相应的扩展点，并且没有分离其界面表现和内在实现。恰恰相反，Commands 方式通过三步有效的达到界面表现和内部实现的分离：首先，通过 mands 扩展点创建命令

5、和类别（Category），并且可以把某些命令放在一个类别（Category）中；然后，通过 org.eclipse.ui.menus 指定命令出现在界面的哪个区域（视图菜单 / 主菜单 / 上下文菜单）；最后通过 org.eclipse.ui.handlers 指定命令的实现。因此，Eclipse 推荐新开发的插件使用 Commands 来创建您的界面菜单。当然，由于 Actions 在现有的插件中用得比较多，如果我们需要扩展或基于之前的插件开发，也需要对其进行了解。除此之外，针对上下文菜单，虽然 Commands 和 Actions 方式均可以创建上下文菜单，但是 Eclipse 还提供了

6、另外一种创建上下文菜单的扩展点 org.eclipse.ui.popupMenus（本文简称为 popupMenus 方式），本文将就这三种扩展点做详细的介绍。菜单控制菜单控制是一个非常常见的功能，例如，随着选定的内容或当前窗口的不同，菜单中的菜单项会有相应的变化（显示 / 隐藏或启用 / 禁用菜单项），因此，如何控制菜单是插件开发人员必须掌握的知识。Eclipse 为菜单控制提供了两种方法，一种是通过扩展点；另一种是通过 API 的方式编写程序控制。回页首Eclipse 菜单功能及其扩展点至此，我们对 Eclipse 菜单有了感观的认识。由上一节我们可知，要深入理解 Eclipse 菜单功能

7、，我们需要从三个方面去掌握：菜单种类，菜单的扩展点和菜单控制。下面将进行详细讲述。菜单种类针对各种菜单，Eclipse 提供了相应的扩展点，因此，开发人员可以通过这些扩展点把菜单放到界面的不同区域，详细内容请参考 2.2 小节。菜单的扩展点视图菜单的扩展点采用 Commands 方式创建视图菜单，需要引入 org.eclipse.ui.menus 扩展点；而 Actions 方式需要引入 org.eclipse.ui.actionSets.1、视图菜单（Commands 方式）：MenuContribution locationURI = “Scheme:id?argument-list”其中

8、，Scheme 为该菜单项出现的区域，menu 为视图的下拉菜单，toolbar 为视图的工具栏菜单；id 为菜单区域 ID；argument-list 为该菜单项出现在指定菜单的位置。例如：在 ProbelmView 的下拉菜单加一个菜单项，其 MenuContribution 的 locationURI 应为：menu:org.eclipse.ui.views.ProblemView?after=additions；在 ProblemView 的工具栏菜单中加入一个菜单项，其 locationURI 应为：toolbar:org.eclipse.ui.views.ProblemView?a

9、fter=additions。2、视图菜单（Actions 方式）：采用 Actions 方式创建菜单，需要引入 org.eclipse.ui.actionSets 扩展点，并通过设定 action 的 menubarPath 指定下拉菜单 / 菜单项出现的位置；通过设定 action 的 toolbarPath 设定工具栏菜单 / 菜单项出现的位置。例如，添加一个下拉菜单项到 Problems 视图中，其 menubarPath 应为：org.eclipse.ui.views.ProblemView/additions主菜单的扩展点1、主菜单（Commands 方式）通过 Commands

10、方式把菜单项添加到主菜单及其工具栏上，和视图菜单一样，也是通过扩展点 org.eclipse.ui.menus 实现，需要设定其 menuContribution 的 locationURI。例如，添加一个菜单（菜单可以包含若干个菜单项）到主菜单一栏中，其 locationURI 为：menu:org.eclipse.ui.main.menu?after=additions添加一个菜单到工具栏之中，其 locationURI 为：toolbar:org.eclipse.ui.main.toolbar?after=additions当然，我们也可以把菜单项添加到已经存在的菜单当中，例如添加一个菜

11、单项到 Eclipse 的 Search 主菜单当中，其 locationURI 为：menu:org.eclipse.search.menu?dialogGroup2、主菜单（Actions 方式）通过 Actions 方式把菜单项添加到主菜单及其工具栏上，和视图菜单一样，也是通过扩展点 org.eclipse.ui.actionSets 实现，需要设定 action 的 menubarPath 和 toolbarPath 实现。例如，添加一个菜单项到 Eclipse 的 Search 主菜单中，其 menubarPath 应为：org.eclipse.search.menu/dialogG

12、roup注意：如果采用上述方式添加一个菜单项到 Search 主菜单，当我们运行时并没有出现添加的菜单项，这时候需要换一个 workspace，其原因是 Eclipse 缓存了与其相关的某些信息在 workspace 当中。上下文菜单的扩展点上下文菜单除了通过 Commands 和 Actions 方式添加，还可以使用扩展点 org.eclipse.ui.popupMenus 方式添加，下面分别进行介绍。1、上下文菜单（Commands 方式）Commands 方式与添加视图菜单和主菜单的方式一样，通过设定其 menuContribution 的 locationURI 来实现。例如，添加一个

13、上下文菜单到 Problems 视图中，其 locationURI 为：popup:org.eclipse.ui.views.ProblemView?after=additions。如果我们想让某个上下文菜单项出现在任何区域，则可以使用下面的 locationURI：popup:org.eclipse.ui.popup.any?after=additions2、上下文菜单（Actions 方式）Actions 方式没有直接提供扩展点添加上下文菜单，但是我们可以通过编程的方式实现，如下代码清单 1 为 TreeViewer 添加上下文菜单，通过 IMenuManager 的 add 方法添加 a

14、ctions。清单 1. 通过 Actions 方式编程实现添加上下文菜单 private void hookContextMenu() IMenuManager fMenuMgr = new MenuManager(“#PopupMenu”); fMenuMgr.setRemoveAllWhenShown(true); / 添加 Actions fMenuMgr.add(action ) fMenuMgr.createContextMenu(treeViewer.getControl(); treeViewer.getControl().setMenu(fMenu); getSite().r

15、egisterContextMenu(fMenuMgr, treeViewer); 3、上下文菜单（popupMenus 方式）通过 popupMenus 扩展点实现上下文菜单，需要设定 objectContribution 的 objectClass 属性把上下文菜单添加到相应的区域。例如，如果我们想当用户点击 Eclipse 中的资源时，弹出的上下文菜单包括某个菜单项，我们可以设定 objectClass 属性为：org.eclipse.core.resources.IResource通过 Commands 方式创建菜单项通过 Commands 方式创建菜单项，首先需要创建 Command

16、，通过扩展点 mands，然后我们可以把这个 Command 放到任何区域，上一小节已经讲到，通过 org.eclipse.ui.menus 扩展点确定菜单创建的区域，最后通过扩展点 org.eclipse.ui.handlers 定义这个 command 的具体行为。在创建 Command 时，我们可以先创建一个 Category，并把相关的一些命令放到这个 Category 中，这样有利于管理。代码清单 2 创建一个 Command(“Show in Glossary Explorer”)，并放到一个 Category 中，然后把该 Command 放到 BGSearchResultVie

17、w 视图的上下文菜单中，最后通过扩展 org.eclipse.ui.handlers 定义该 Command 的实现类。清单 2. 通过 Commands 方式添加菜单项 <!- 添加 command -> <extension point="mands"> <category description="Business Glossary" id="mands.category" name="%category.BusinessG"> </categ

18、ory> <command categoryId="mands.category" description="Show in Glossary Explorer" id="mands.BGShowInBrowser" name="%command.ShowInGE.name"> </command> </extension> <!- 把 Command 放到界面的对应区域 -> <extension point="org.eclipse.ui.m

19、enus"> <menuContribution locationURI= "popup:ernal.ui.search.BGSearchResultView?after=additions"> <command commandId="mands.BGShowInBrowser" style="push" tooltip="%command.ShowInGE.tooltip"> </command> </menuContribut

20、ion> </extension> <!- 定义 command 的实现类 -> <extension point="org.eclipse.ui.handlers"> <handler class="ernal.ui.handlers.BGShowInBrowser" commandId="mands.BGShowInBrowser"> </handler> </extension>通过 Actions 方式创建菜单项正如前面讲

21、到，Actions 方式没有分离界面的表现和内部实现，因此，所有这些均通过 action 来完成。如下代码清单 3 为添加一个 Search 菜单项到 Eclipse 的 Search 主菜单（通过 action 的 menubarPath 指定）中，其中 class 对应的值为该 Action 的实现类，该类需要实现接口 IWorkbenchWindowActionDelegate。清单 3. 通过 Actions 方式添加菜单项 <extension point="org.eclipse.ui.actionSets"> <actionSet id=&q

22、uot;com.ibm.bg.ui.workbenchActionSet" label="%.0" visible="true"> <action class="ernal.ui.handlers.BGSearchHandler" definitionId="mands.BGSearch" icon="icons/search.png" id="mands.BGSearch" label="

23、%action.searchGlossayInMainMenu.label" menubarPath="org.eclipse.search.menu/dialogGroup" style="push"> </action> </actionSet> </extension>通过 popupMenus 方式创建菜单项popupMenus 方式创建上下文菜单项也是通过 action 来实现，下面例子为添加一个菜单项到用户右击 IGraphicalEditPart 对象时弹出的上下文菜单，通过 menuba

24、rPath 指定该 Action 出现的区域，通过 class 指定该 action 的实现类，该类需要实现接口 IObjectActionDelegate。清单 4. 通过 popupMenus 方式添加菜单项 <extension point="org.eclipse.ui.popupMenus"> <objectContribution adaptable="false" id="com.ibm.bg.uml.objectContributions.BGAssignToGlossary" objectClass

25、="org.eclipse.gmf.runtime.diagram.ui.editparts.IGraphicalEditPart"> <action class="ernal.uml.actions.BGAssignToGlossary" enablesFor="+" icon="icons/assign.png" id="ernal.uml.actions.BGAssignToGlossary" label="%B

26、GAssignToGlossary.item" menubarPath="com.ibm.bg.uml.popupMenuGroup"> </action> </objectContribution> </extension>菜单控制视图菜单的控制主要包括启用 / 禁用，显示 / 隐藏菜单。通过 Command 方式创建的菜单，可以通过 mands 的 visibleWhen 属性控制菜单的隐藏和显示，通过 org.eclipse.ui.handlers 的 activewhen 或 enabledWhen 控制菜单的启用

27、或禁用。通过 Actions 方式创建的菜单，可以通过 action 的 enablement 属性控制菜单的启用 / 禁用。通过 popupMenus 方式创建的菜单，可以通过 objectContribution 的 visibility 和 enablement 来设置该 objectContribution 下的 action 的显示 / 隐藏和启用 / 禁用，我们也可以设置 action 的 enablement 来控制该菜单的启用 / 禁用。这里不详细讲述 enablement，visibleWhen 和 enabledWhen 的参数及如何设置，读者可以参考第三节的例子和本文的参

28、考文献。回页首编程实践本文将结合前两节讲到的知识，以例子的形式说明如何创建并且控制菜单。首先创建一个视图（Menu Example），然后分别通过 Commands，Actions 和 popupMenus 方式创建若干个菜单，并添加相应的菜单控制点。创建 Menu Example 视图扩展 org.eclipse.views 创建“Menu Example”视图，如下代码清单 5 为创建视图的 xml 代码。清单 5. 扩展 org.eclipse.ui.views 创建视图 <extension point="org.eclipse.ui.views"> &

29、lt;category id="com.free.menu.category" name="Menu Example View"> </category> <view category="com.free.menu.category" class="com.free.menu.view.MenuExplorer" id="com.free.menu.view.MenuExplorer" name="Menu Explorer" restorable=&

30、quot;true"> </view> </extension>创建 Commands采用 Command 方式创建“Menu Example”主菜单（包含 AngryCommand 和 JokeCommand 两个菜单项），并且基于这两个菜单项创建了 Menu Example 视图的下拉菜单和工具栏菜单，及其 TreeViewer 的上下文菜单。如下代码清单 6 为扩展 mands 创建 Menu Example 命令和类别，并且包含两个命令：Joke Command 和 Angry Command。清单 6. 扩展 mands 创建命令 <ex

31、tension point="mands"> <category id="com.free.menu.category" name="Menu Example"> </category> <command categoryId="com.free.menu.category" id="mands.jokeCommand" name="Joke Command"> </command> <command categor

32、yId="com.free.menu.category" id="mands.angryCommand" name="Angry Command"> </command> </extension>关联 Commands 到主菜单如下代码清单 7 为扩展 org.eclipse.ui.menus，并基于前面创建的 Comands，添加一个主菜单 Menu Example，并且包含 Joke Command 和 Angry Command 菜单项。清单 7. 创建 Menu Example 主菜单 <m

33、enuContribution locationURI="menu:org.eclipse.ui.main.menu?after=additions"> <menu id="com.free.menu.MenuExample" label="Menu Example"> <command commandId="mands.jokeCommand" style="push"> </command> <command commandId="m

34、ands.angryCommand" style="push"> </command> </menu> </menuContribution>关联 Commands 到视图菜单如下代码清单 8 为扩展 org.eclipse.ui.menus，并基于 Commands 方式创建 Menu Example 视图的下拉菜单，工具栏菜单和上下文菜单，通过 locationURI 来设定。Joke Command 即为下拉菜单也是工具栏菜单，只有当我们选择了 TreeViewer 中的节点时该菜单项才是可见的，参考下面的 visi

35、bleWhen->with->iterate->or->instanceof。清单 8. 通过 Commands 方式创建视图菜单 <extension point="org.eclipse.ui.menus"> <menuContribution locationURI="menu:com.free.menu.view.MenuExplorer?after=additions"> <command commandId="mands.jokeCommand" icon="

36、icons/searchres.gif" style="push"> <visibleWhen checkEnabled="false"> <with variable="selection"> <iterate ifEmpty="true" operator="or"> <or> <instanceof value="com.free.menu.model.Person"> </instanc

37、eof> </or> </iterate> </with> </visibleWhen> </command> </menuContribution> <menuContribution locationURI="toolbar:com.free.menu.view.MenuExplorer?after=additions"> <command commandId="mands.jokeCommand" icon="icons/searchres.g

38、if" style="push"> <visibleWhen checkEnabled="false"> <with variable="selection"> <iterate ifEmpty="true" operator="or"> <or> <instanceof value="com.free.menu.model.Person"> </instanceof> </or&g

39、t; </iterate> </with> </visibleWhen> </command> </menuContribution> <menuContribution locationURI="popup:com.free.menu.view.MenuExplorer?after=additions"> <command commandId="mands.jokeCommand" icon="icons/searchres.gif" style=&quo

40、t;push"> </command> <command commandId="mands.angryCommand" style="push"> </command> </menuContribution> </extension>Commands 的实现类如下代码清单 9 所示扩展 org.eclipse.ui.handlers 为 Joke Command 和 Angry Command 创建事件处理类，其中 Joke Command 通过 enabledWhen 属性控制

41、该菜单项是否启用，当我们同时选择了两个对象时 Joke Command 处于启用状态，否则为禁用。清单 9. 扩展 org.eclipse.ui.handlers 为 Commands 创建实现类 <extension point="org.eclipse.ui.handlers"> <handler class="com.free.menu.actions.JokeCommand" commandId="mands.jokeCommand"> <enabledWhen> <count val

42、ue="2"> </count> </enabledWhen> </handler> <handler class="com.free.menu.actions.AngryCommand" commandId="mands.angryCommand"> </handler> </extension>创建 Action 并关联到 Eclipse 的 Search 主菜单采用 Actions 方式在 Eclipse 的主菜单 Search 中添加创建菜单项 Sm

43、ileAction。扩展 org.eclipse.ui.actionSets 在 Eclipse 的主菜单 Search 中添加一个菜单项 Smile Action。如下代码清单 10 所示创建该 action 并添加到 search 主菜单，只有当我们选择至少一个对象时（设置 enablesFor 属性为“+”），该菜单项才处于启用状态。清单 10. 通过 Actions 方式创建菜单项 <extension point="org.eclipse.ui.actionSets"> <actionSet id="com.free.menu.acti

44、onSet.MenuExample" label="Menu Example" visible="true"> <action class="com.free.menu.actions.SmileAction" enablesFor="+" icon="icons/searchres.gif" id="com.free.menu.actions.smileAction" label="Smile Action" menubarPath

45、="org.eclipse.search.menu/dialogGroup" style="push"> </action> </actionSet> </extension>pupupMenus 方式创建 Action 并关联到 IResource 资源的上下文菜单扩展 org.eclipse.ui.popupMenus 创建菜单“Menu Example”，该菜单包含一个菜单项 HelloAction。当我们在 Eclipse 任何区域右击 org.eclipse.core.resources.IResour

46、ce 资源时弹出的上下文菜单中会出现“Menu Example”菜单。如下代码清单 11 为创建该上下文菜单的 xml 代码。清单 11. popupMenus 方式创建上下文菜单 <extension point="org.eclipse.ui.popupMenus"> <objectContribution adaptable="true" id="com.free.menu.popupMenu" objectClass="org.eclipse.core.resources.IResource&quo

47、t;> <menu label="Menu Example" path="additions" id="com.free.menu.popupSubMenu"> <separator name="additions"> </separator> </menu> <action label="Hello Action" class="com.free.menu.popup.actions.HelloAction" me

48、nubarPath="com.free.menu.popupSubMenu/additions" enablesFor="1" id="com.free.menu.newAction"> </action> </objectContribution> </extension>pupupMenus 方式创建 Action 并关联到 IResource 资源的上下文菜单扩展 org.eclipse.ui.popupMenus 创建菜单项 GreetAction 和 CryAction，当我们右击

49、Menu Example 视图中的 TreeViewer 节点时弹出。如下代码清单 12 所示扩展 org.eclipse.ui.popupMenus 为 Menu Example 视图创建 GreetAction 和 CryAction 上下文菜单项。使用 visiblity 的 objectState 属性控制菜单项的可见状态，使用该属性要求其选择的对象实现了 org.eclipse.ui.IActionFilter 接口，具体可参见 Person 类的实现。清单 12. 扩展 org.eclipse.ui.popupMenus 创建菜单 <extension point="

50、;org.eclipse.ui.popupMenus"> <objectContribution adaptable="false" id="com.free.menu.views.popupMenu" objectClass="com.free.menu.model.Person"> <action class="com.free.menu.actions.GreetAction" enablesFor="+" id="com.free.menu.a

51、ctions.greetAction" label="Greet Action" menubarPath="additions"> </action> <visibility> <objectState name="firstName" value="Dan"> </objectState> </visibility> </objectContribution> </extension> <extension

52、point="org.eclipse.ui.popupMenus"> <objectContribution adaptable="false" id="com.free.menu.views.popupMenu2" objectClass="com.free.menu.model.Person"> <action class="com.free.menu.actions.CryAction" enablesFor="+" id="com.f

53、ree.menu.actions.cryAction" label="Cry Action" menubarPath="additions"> <enablement> <objectState name="firstName" value="David"> </objectState> </enablement> </action> <visibility> <objectState name="lastName" value="Rubel"> </objectState> </visibility> </objectContribution> </extension>Menu Example 视图的代码实现类如下代码清单 13 所示为 Menu Example 视图的代码，该视图中有一个