扩展Eclipse的Java开发工具(二)

王朝java/jsp·作者佚名 2008-05-31

在用户界面中，如何显示扩展，显示在何处？

这在很大程度上是一个暖和的提示，因为我们已得到了答案。我们希望对一个或多个选中的方法显示上下文菜单选项，这些菜单选项答应我们只用一个操作就可以更改方法的可视性。我们更喜欢在可以显示方法的任何地方都能使用这些菜单选项，如在 Hierarchy 视图和 Package EXPlorer 中。这把我们带到下一个问题。

通常如何扩展用户界面？

通过示例来学习会更有趣，这方面 Plug-in PRoject 向导可以提供帮助，它提供了一些样本代码，我们可以修改这些代码来满足我们的需要。我们将回答该向导中的几个问题，它将自动启动用于插件开发的专门透视图，称为 Plug-in Development Environment（PDE），以预备测试。该向导包含了可以帮助我们入手的许多示例。事实上，我们的老朋友“Hello World”也在那里。为了沿袭这个传统，我们将生成这个“Hello World”，查看结果以验证是否正确安装了该环境，随后修改它以帮助我们回答当前的问题，并把我们带到下一个问题：对用户界面的扩展如何知道类似于“选择”这样的基本事件？这很重要，因为我们希望将我们新近引入的菜单选项应用到当前选中的方法上。

请注重，这些指示信息假定您正从全新的 Eclipse 安装开始。假如修改了该环境或更改了首选项，那么可能不会完全象如下所述那样工作。您可以考虑从全新的工作空间启动 Eclipse：打开命令提示符窗口，更改到 \eclipse 目录，然后使用 -data 参数启动 Eclipse，如清单 1 所示。

清单 1. 启动全新的 Eclipse 实例

cd c:\eclipse2.1\eclipse

eclipse.exe -data workspaceDevWorks

从使用 New Plug-in Project 向导创建一个插件项目开始。选择 File New Project。在 New Project 对话框中，在向导列表中选择 Plug-in Development and Plug-in Project，然后选择 Next。将项目命名为 com.ibm.lab.helloworld。该向导将根据这个名称创建插件标识，所以它在系统中必须是唯一的（按惯例，项目名和插件标识相同）。使用显示在“Project contents”下面的推荐缺省工作空间位置就可以了；选择 Next。

在下一页上，选择 Next 以接受缺省插件项目结构。该插件代码生成器页推荐了许多样本，向导可以帮助您进一步对该项目进行参数化。选择“Hello, World”选项，然后选择 Next。下一页（显示在图 4 中）推荐了插件名和插件类名。这些名称基于插件项目 com.ibm.lab.helloworld 的最后一个单词。这个示例不需要任何插件类便利方法，所以取消对三个代码生成选项的选择（如图 4 所示），然后选择 Next（不是 Finish；您还有一页要完成）。

图 4. Simple Plug-in Content

您可以在下一页（显示在图 5 中）中指定参数，这些参数对于“Hello, Worlds”示例是唯一的，比如，将要显示的消息。

图 5. Sample Action Set

要简化所产生的代码，将该操作的目标包名从 com.ibm.lab.helloworld.actions 更改成 com.ibm.lab.helloworld，即与该项目的名称相同。尽管在实际的插件中，您可以选择用不同的包对相关的类进行分组，但在本例中，只有两个类，所以不必这样做。这样也遵循了“主”包名和项目名相同这个惯例。现在选择 Finish。

您应该看到一个信息消息：“Plug-ins required to compile java classes in this plug-in are currently disabled. The wizard will enable them to avoid compile errors.”。选择 OK 继续。假如这是个全新的工作空间，那么您还将看到另一个信息消息：“This kind of project is associated with the Plug-in Development Perspective. Do you want to switch to this perspective now?”。选择 Yes 以根据这个消息的建议进行切换。

要验证所有的东西是否都设置正确，让我们测试新插件。选择 Run Run As Run-Time Workbench。这将启动 Eclipse 的第二个实例，它将包含您的插件。这个新实例将创建一个新的名为 runtime-workspace 的工作空间目录，所以不必担心；对这个实例所作的任何测试都不会影响开发设置。您应该看到类似图 6 的样子，其中有一个新的下拉菜单，其标签为 Sample Menu，它有单一的选项 Sample Action。选择它将显示下面的信息消息。假如您不是从全新的工作空间启动，那么可以选择 Window Reset Perspective 以查看新生成的下拉菜单；从现有工作空间启动时不会显示这个菜单，因为工作台“记得”上次 Eclipse 运行时哪些操作集是活动的（您还可以从 Window Customize Perspective...下拉菜单选项上添加／删除操作集）。

图 6. Hello, Eclipse world

让我们快速浏览一下插件清单文件 plugin.xml。双击它，以在 Plug-in Manifest 编辑器中打开它。这个编辑器提供了几个类似于向导的页和一个“原始”源代码页。通过选择 Source 选项卡转到源代码页。您将看到与以下清单 2 显示的代码相似的内容；我们感爱好的是用粗体显示的那几部分。

清单 2. 所生成的“Hello, World” plugin.xml

point="org.eclipse.ui.actionSets"

label="Sample Action Set"

visible="true"

id="com.ibm.lab.helloworld.actionSet"

label="Sample &Menu"

id="sampleMenu"

name="sampleGroup"

label="&Sample Action"

icon="icons/sample.gif"

class="com.ibm.lab.helloworld.SampleAction"

tooltip="Hello, Eclipse world"

menubarPath="sampleMenu/sampleGroup"

toolbarPath="sampleGroup"

id="com.ibm.lab.helloworld.SampleAction"

并不需要过于深入地研究这个代码。我们“旅行”的第 II 部分的目的只是让您熟悉一些基本机制，借此我们可以介绍 JDT 的扩展。这里，您会看到这样一种技术的一个样本：它将菜单和菜单选项作为操作集添加到工作台。它以一个用标记声明的扩展开始。工作台用户界面插件定义了这个扩展点 org.eclipse.ui.actionSets，以及几个类似的扩展点，通过这几个扩展点可以向各种用户界面元素提供其它插件。

我们还未回答如何将菜单选项添加到 Java 方法的上下文菜单中。一个简单示例可以给我们一些提示。首先打开显示“Hello, World”消息的类 SampleAction，请注重其 run 方法。它不是非凡有趣；不过我们还看到了另一个方法 selectionChanged。啊哈！下一个问题的答案有了。

对用户界面的扩展如何知道类似于“选择”这样的基本事件？

工作台“选择”更改时会告知所提供的操作（象我们提供的菜单下拉选项）。这在 selectionChanged 方法前面的 Javadoc 注释中得到了确认。让我们修改这个方法以告知有关“选择”的更多信息。首先，假如您还没有关闭工作台的运行时实例，那么现在就关闭。然后对 selectionChanged 方法添加清单 3 中的代码。

清单 3. selectionChanged 方法，首次修改

public void selectionChanged(IAction action, ISelection selection) {

System.out.println("========== selectionChanged");

System.out.println(selection);

}

有了这个调试代码，我们将看到选择了什么，并了解到有关什么使 Eclipse 工作的更多信息。保存该方法，然后重新启动运行时工作台。

重要：Eclipse 有一个延迟装入的策略，以在用户执行需要插件代码的操作时才装入插件。所以您必须先选择 Sample Action 菜单选项，以在调用 selectionChanged 方法之前装入您的插件。

现在选择其它东西，如编辑器中的文本、Navigator 中的文件，当然还有 Outline 视图中的成员（回忆一下：您必须创建一个 Java 项目和示例 Java 类来做到这一点，因为运行时实例使用不同的工作空间）。清单 4 显示了您将在 Eclipse 的开发实例的控制台中看到的某个示例输出。

清单 4. selectionChanged 输出，首次修改

========== selectionChanged

[package com.ibm.lab.soln.jdt.excerpt [in [Working copy] ChangeIMemberFlagAction.java

[in com.ibm.lab.soln.jdt.excerpt [in src [in com.ibm.lab.soln.jdt.excerpt]]]]]