示例 — 自述文件工具

简介

“自述文件”编辑器显示如何定义您自己的扩展点以供其它插件使用。它还显示如何就扩展名(.readme)、定制视图和属性页面为资源弹出菜单条目、新资源向导和文件编辑器创建扩展。

运行示例

要开始使用此示例,使用文件创建向导创建扩展名为 .readme 的文件,或使用示例创建向导创建该文件。可通过选择“窗口 > 显示视图 > 其它”并展开“自述文件”部分来查看此示例提供的附加视图。可通过单击“导航器视图”上的自述文件图标来查看视图操作。

创建新的自述文件

创建一个新的扩展名为 .readme 的文件。从“文件”菜单中,选择“新建”,然后从子菜单中选择“其它...”。单击向导中的“简单”,然后选择左边列表中的“文件”。单击“下一步”以提供文件名(确保扩展名为 .readme)及应包含该文件的文件夹。

示例创建向导

从“文件”菜单中,选择“新建”,然后从子菜单中选择“示例...”。现在选择“示例创建向导”。选择“自述文件”。单击“下一步”。选择要在其中创建该文件的文件夹。输入该文件的名称(扩展名为 .readme)。单击完成。

自述文件视图扩展操作

在“导航器视图”中,选择扩展名为 .readme 的某个文件。如果没有这样文件存在,则创建一个扩展名为 .readme 的文件。在“导航器视图”的本地工具栏上,将看到一个按钮,其悬浮式帮助显示有“运行自述文件视图扩展”。单击此按钮。将会弹出一个显示有“已执行视图操作”的对话框。

弹出菜单

在“导航器视图”中,选择一个扩展名为 .readme 的文件。如果没有这样的文件存在,则创建一个 扩展名为 .readme 文件。选择该文件以显示弹出菜单。注意,弹出菜单中有一个显示有“显示自述文件操作”的菜单项。选择此菜单项以打开显示有“已执行弹出菜单操作”的对话框。

首选项页面

从“窗口”菜单中,选择“首选项”。单击称为“自述文件示例”的页面。这将显示一个首选项页面示例。

属性页面

在“导航器视图”中,选择一个扩展名为 .readme 的文件。如果没有这样的文件,则创建一个扩展名为 .readme 的文件。选择该文件以显示弹出菜单,然后选择“属性”菜单项。单击称为“自述文件工具”的页面以查看属性页面的示例。

自述文件编辑器

“自述文件编辑器”是类型为 *.readme 的文件的缺省编辑器。创建一个扩展名为 .readme 的文件并通过双击该文件来打开它,或者通过显示弹出菜单,再选择“打开方式”,然后从子菜单中选择“自述文件编辑器”来打开该文件。注意,编辑器具有一个带有铅笔图案的图标。这就是在缺省情况下自述文件工具用于类型为 *.readme 的文件的编辑器。

自述文件编辑器操作

此项演示仅适用于特定编辑器的操作的示例。当某个自述文件编辑器具有焦点时,注意以下四个附加工具栏按钮 — 运行自述文件编辑器扩展、自述文件编辑器操作 1、自述文件编辑器操作 2 和自述文件编辑器操作 3。

当某个自述文件具有焦点时,出现一个名为“自述文件”的下拉菜单。它包含前面所述的操作:自述文件编辑器操作 1、自述文件编辑器操作 2 和自述文件编辑器操作 3。

“自述文件部分”视图

要查看此“自述文件部分”视图,从“窗口”菜单中选择“显示视图”,然后从子菜单中选择“其它...”。展开“自述文件”项而后选择“自述文件部分”。这将在“导航器视图”中选择了 .readme 文件时显示当前 *.readme 文件中各部分的列表。还可在“大纲”视图中看到 *.readme 文件的结构。

可将扩展名为 .readme 的文件分成若干部分(若每个部分都以数字开头的话)。例如,如果将下列文本输入 到自述文件编辑器中,则自述文件工具将检测到两个部分。要查看各个部分在自述文件工具中是如何检测到的,在自述文件编辑器中输入一些文本,并通过按 CTRL-S 或选择“文件 -> 保存”来保存该文件。打开“自述文件部分”视图并在“导航器视图”中选择 .readme 文件。

示例文本:

99.1 This is my first section
This is some text in my first section.

99.1.1 This is a sub section
This is some text in my sub-section.

拖放

可通过在“大纲视图”中选择一个部分并将该所选部分拖过文本文件的顶部来查看“拖放”功能。该所选部分的内容将被追加到文件中。

帮助添加项

自述文件工具示例还演示如何使用和实现有关它所提供的所有扩展 (视图、各种操作和向导页面)的上下文帮助。要获取有关某个操作的上下文帮助,可将光标悬浮在该菜单项上(但不要选择该菜单项),然后按 F1 键。还可获取有关“自述文件部分”视图和“示例创建向导”页面(在“新向导”中)的上下文相关(F1)帮助。
 

详细信息

“自述文件工具”示例声明一个扩展点并提供许多扩展。所提供的扩展足以理解“工作台”如何运作,因其利用许多由工作台声明的更有意思的扩展点。包括在此示例中的所提供扩展是视图和视图操作、首选项页面、属性页面、向导、编辑器和编辑操作、弹出菜单、操作集、帮助添加项、帮助上下文以及放下操作。

此示例还提供在插件中声明的扩展点。使用本示例定义的 org.eclipse.ui.examples.readmetool.sectionParser 扩展的任何插件都需要 IReadmeFileParser 类。DefaultSectionParser 类是实现 IReadmeFileParser 的一个示例。

ReadmeEditor 类实现 IEditorPart,并在 plugin.xml 中使用 org.eclipse.ui.editors 扩展点将该类定义为扩展名为 .readme 的文件的编辑器。ReadmeSectionsView 类实现 IViewPart,并使用 org.eclipse.ui.views 扩展点将该类定义为视图。此扩展点还定义视图的类别以在视图选择中使用。

此示例中定义了两种首选项设置类型,工作台首选项和资源属性。工作台首选项是在 ReadmePreferencePage 类(该类实现 IWorkbenchPreferencePage)中定义的,因此该首选项将被添加到“窗口 -> 首选项”对话框中。该类是在 plugin.xml 中的 org.eclipse.ui.preferencePages 扩展点中定义的。两个资源属性页面是 ReadmeFilePropertyPage 和 ReadmeFilePropertyPage2,两个页面都实现 IWorkbenchPropertyPage。它们都被定义为通过 plugin.xml 中的 org.eclipse.ui.propertyPages 扩展点中的 objectClass 标记针对 IFile 类型来调用。

ReadmeCreationWizard 类实现 INewWizard,并在 plugin.xml 中的 org.eclipse.ui.newWizards 扩展点中定义该类。此扩展点还定义当用户选择“文件 -> 新建 -> 示例...”时显示的向导的类别。

将几个操作存根添加到此示例中。操作集声明一个标有自述文件编辑器的菜单(将使用 org.eclipse.ui.actionSets 扩展点把该菜单包括在工作台窗口菜单中)。它还使用标记 toolbarPath 和 menubarPath 定义用于工作台工具栏和菜单栏的操作。它使用 实现 IWorkbenchWindowActionDelegate 的 WindowActionDelegate 类来实现该操作。通过 org.eclipse.ui.popupMenus 扩展点中的 PopupMenuActionDelegate 类将用于弹出菜单的操作定义为 objectContribution。PopupMenuActionDelegate 实现 IObjectActionDelegate 并使用所提供的 IWorkbenchPart 来打开消息对话框。视图操作 ViewActionDelegate 是在 org.eclipse.ui.viewActions 扩展点中定义的且实现 IViewActionDelegate。它所在的“视图”由 targetID 标记定义,在本示例中,该标记就是 org.eclipse.ui.views.ResourceNavigator。编辑器操作是由实现 IEditorActionDelegate 的 EditorActionDelegate 类定义的,并使用 org.eclipse.ui.editorActions 扩展点来添加该操作。应用它的编辑器由 targetID 标记定义,在本示例中,该标记是在 org.eclipse.ui.examples.readmetool.ReadmeEditor 上定义的。

ReadmeDropActionDelegate 类实现 IDropDelegate。每当在工作台中执行放下操作时,就会通知 IDropDelegate。此操作的扩展点是 org.eclipse.ui.dropActions。

Copyright IBM Corp. 2000, 2003.  All Rights Reserved.