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

引言

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

如图1 所示为Project Explorer 视图的菜单，包括视图下拉菜单和工具栏菜单（折叠树节点）。通常而言，出现在视图工具栏的菜单都会出现在视图的下拉菜单，也就是说，比较常用的视图菜单放在视图的工具栏。

图 1. Project Explorer 视图的菜单

如图2 所示为Project Explorer 视图中的上下文菜单，只有当我们右键点击时才会出现。通常而言，出现频率较高的菜单项才会出现在菜单中。上下文菜单具有很强的灵活项，它可以随着我们点击的对象不同，弹出的菜单也会有相应的变化。

图 2. Project Explorer 视图中的上下文菜单

如图3 所示为Eclipse 的主菜单，包括最上面的主菜单项（不可移动）及其下面的工具栏菜单（可以移动，并且Eclipse 提供了显示/ 不显示这些菜单的功能），Eclipse 并不建议我们为每一个插件都添加新的主菜单，这样容易造成冗余，而且不方便用户操作。通常，我们可以把菜单项添加到Eclipse 已有的菜单，如插件的查找功能可以添加一个查找菜单项到Eclipse 的Search 主菜单上。

图 3. Eclipse 的主菜单

前面讲到Eclipse 的各种菜单，那么，如何在开发插件或RCP 应用程序的时

候添加这些菜单？本文下面的篇幅将详细介绍如何扩展Eclipse 的菜单功能，

使读者深入了解Eclipse 的菜单功能，并能够开发具有这些菜单的应用程序。

因此，必须掌握三方面的内容：菜单种类，菜单的扩展点，菜单控制（显示/ 隐藏或启用/ 禁用菜单项）。下面从概念上介绍这三方面内容，下一小节将会进

行详细介绍。

菜单种类

正如前面所讲到的，Eclipse 的菜单包括视图菜单，主菜单及上下文菜单三个种类。

菜单项的扩展点

Eclipse 提供了两种扩展点供用户添加菜单项到相应的位置。这两种扩展点为mands（本文简称为Commands 方式）和

org.eclipse.ui.actionSets（本文简称为Actions 方式）。Actions 方式为界面上不同区域的表现方式提供了相应的扩展点，并且没有分离其界面表现和内在实现。恰恰相反，Commands 方式通过三步有效的达到界面表现和内部实现的分离：

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

org.eclipse.ui.popupMenus（本文简称为popupMenus方式），本文将就这三种扩展点做详细的介绍。

菜单控制

菜单控制是一个非常常见的功能，例如，随着选定的内容或当前窗口的不同，菜单中的菜单项会有相应的变化（显示/ 隐藏或启用/ 禁用菜单项），因此，如何控制菜单是插件开发人员必须掌握的知识。Eclipse 为菜单控制提供了两种方法，一种是通过扩展点；另一种是通过API 的方式编写程序控制。

回页首Eclipse 菜单功能及其扩展点

至此，我们对Eclipse 菜单有了感观的认识。由上一节我们可知，要深入理解Eclipse 菜单功能，我们需要从三个方面去掌握：菜单种类，菜单的扩展点和菜单控制。下面将进行详细讲述。

菜单种类

针对各种菜单，Eclipse 提供了相应的扩展点，因此，开发人员可以通过这些扩展点把菜单放到界面的不同区域，详细内容请参考 2.2 小节。

菜单的扩展点

视图菜单的扩展点

采用Commands 方式创建视图菜单，需要引入org.eclipse.ui.menus扩展点；而Actions 方式需要引入org.eclipse.ui.actionSets.

1、视图菜单（Commands 方式）：

MenuContributionlocationURI = “[Scheme]:[id]?[argument-list]”

其中，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?after=additions。

2、视图菜单（Actions 方式）：

采用Actions 方式创建菜单，需要引入org.eclipse.ui.actionSets扩展点，并通过设定action 的menubarPath指定下拉菜单/ 菜单项出现的位置；通过设定action 的toolbarPath设定工具栏菜单/ 菜单项出现的位置。

例如，添加一个下拉菜单项到Problems 视图中，其menubarPath应为：org.eclipse.ui.views.ProblemView/additions

主菜单的扩展点

1、主菜单（Commands 方式）

通过Commands 方式把菜单项添加到主菜单及其工具栏上，和视图菜单一样，也是通过扩展点org.eclipse.ui.menus实现，需要设定其menuContribution的locationURI。

例如，添加一个菜单（菜单可以包含若干个菜单项）到主菜单一栏中，其locationURI为：

menu:org.eclipse.ui.main.menu?after=additions

添加一个菜单到工具栏之中，其locationURI为：

toolbar:org.eclipse.ui.main.toolbar?after=additions

当然，我们也可以把菜单项添加到已经存在的菜单当中，例如添加一个菜单项到Eclipse 的Search 主菜单当中，其locationURI为：

menu:org.eclipse.search.menu?dialogGroup

2、主菜单（Actions 方式）

通过Actions 方式把菜单项添加到主菜单及其工具栏上，和视图菜单一样，也是通过扩展点org.eclipse.ui.actionSets实现，需要设定action 的menubarPath 和toolbarPath实现。

例如，添加一个菜单项到Eclipse 的Search 主菜单中，其menubarPath应为：org.eclipse.search.menu/dialogGroup

注意：如果采用上述方式添加一个菜单项到Search 主菜单，当我们运行时并没有出现添加的菜单项，这时候需要换一个workspace，其原因是Eclipse 缓存了与其相关的某些信息在workspace 当中。

上下文菜单的扩展点

上下文菜单除了通过Commands 和Actions 方式添加，还可以使用扩展点org.eclipse.ui.popupMenus方式添加，下面分别进行介绍。

1、上下文菜单（Commands 方式）

Commands 方式与添加视图菜单和主菜单的方式一样，通过设定其menuContribution的locationURI来实现。