“模式定义”页

关于此页

此表单页允许您编辑组成所编辑模式语法的模式对象的结构和属性。

请在扩展点元素部分中编辑模式对象的结构。此部分占据编辑器区域的左上角。

请在<模式对象>详细信息部分中编辑模式对象的属性。根据扩展点元素部分中所选模式元素的类型的不同,将在编辑器区域右上角激活这些部分。

此页的组成部分

此页包含下列各部分:

“扩展点元素”部分

此部分允许您执行下列操作:

可以通过模式定义表单页直接访问此部分。

“扩展点元素”部分中的字段

使用扩展点元素查看器字段来执行下列操作:

此查看器包含下列节点:

元素:

编写器:

属性:

示例:扩展元素指定允许将一个或多个快捷方式元素的序列作为其合法子代。元素引用用来表示快捷方式元素。序列编写器用来表示元素序列。

“扩展点元素”部分 2

示例:快捷方式元素指定允许描述或类别元素作为其合法子代。元素引用用来表示描述和类别元素。选项编写器用来表示元素选项。

“扩展点元素”部分 1

“扩展点元素”部分的操作

单击添加元素按钮将新的全局元素声明添加到扩展点模式语法。在选择了任何节点后,此操作可用。注意:元素声明顺序并不重要。

单击添加属性按钮将新的局部属性声明添加到扩展点模式语法中的所选元素。此操作适用于除扩展元素节点以外的所有所选元素节点。扩展元素节点始终具有相同的属性:标识、名称和点。注意:属性声明顺序并不重要。

要从扩展点模式语法中删除模式对象,请右键单击所选节点,然后选择删除。此操作适用于除扩展元素节点外的所有所选节点。对于非共享模式,扩展元素节点是一个特殊的根元素,它用来定义所编辑模式语法的入口点。插件清单编辑器中定义的任何扩展都必须使用扩展父元素来指定其 XML 相关标记。

要指定元素的子代由扩展点模式语法中其他元素的序列或选项组成,请执行下列操作:

  1. 选择并右键单击要指定为父元素的元素节点。
  2. 选择新建 > 编写器 > 序列以定义元素序列。选择新建 > 编写器 > 选项以定义元素选项。
  3. 选择并右键单击新的编写器节点。
  4. 从新建 > 引用子菜单中选择要指定为父元素的子代的元素。引用子菜单包含扩展点模式语法中以全局方式声明的所有元素。
  5. 重复步骤 3 和 4 以指定其他子元素。如果已指定序列编写器,那么这等同于指定序列中的其他元素。如果已指定选项编写器,那么这等同于指定其他元素选项。

注意:要指定某个元素是另一元素的子代,那么父元素必须始终使用中间序列或选项编写器。编写器节点是连接器节点;但是,元素引用节点是叶节点。因此,编写器节点应该始终至少指定一个子代元素引用节点。

注意:序列和选项编写器可以嵌套任意次,以创建更复杂的语法。

注意:语法不能包含自引用循环。所禁止的循环的最基本形式是,元素 A 要求元素 B 作为它的子代,而元素 B 又要求元素 A 作为它的子代。

要指定某个元素没有子代并允许在其开始和结束 XML 标记中指定文本(字符内容),请不要对该元素添加属性、编写器和元素引用(元素内容),以保持它的结构不变。注意:元素不能指定混合内容(同时包含字符内容和元素内容)。

“描述”部分

此部分允许您提供所编辑模式语法中任何元素、属性或编写器的简要描述。

可以通过模式定义表单页直接访问此部分。

“描述”部分

“描述”部分中的字段

请编辑描述文本字段,以便提供扩展点元素部分中当前所选元素、属性或编写器节点的简要描述。根据需要,可以在此字段中使用有效的 HTML 标记。

注意:更新元素引用描述时,还将更新它所引用的全局元素声明的描述,反之亦然。

“元素详细信息”部分

此部分允许您编辑元素的属性。元素分为两类,即扩展元素和非扩展元素。扩展元素是特殊根元素声明,用于定义所编辑模式语法的入口点。非扩展元素是全局元素声明,它用作所编辑模式语法中的基本结构构建块。

要激活此部分,请在扩展点元素部分中选择扩展元素节点或非扩展元素节点。

扩展元素的元素详细信息部分。

“元素详细信息”部分 1

非扩展元素的元素详细信息部分。

“元素详细信息”部分 2

“元素详细信息”部分中的字段

编辑名称字段以指定元素名。

单击内部字段中的 true 按钮或 false 按钮,以指定该元素是否为内部元素。缺省情况下,对于任何内部的扩展 XML 标记,插件清单编辑器将标记警告。此字段相当于导出的包的 x-internal 属性。

单击已弃用字段中的 true 按钮或 false 按钮,以指定是否已弃用该元素。缺省情况下,对于任何已弃用的扩展 XML 标记,插件清单编辑器将标记警告。此字段类似于 Java 的 Javadoc @deprecated 标记。

如果将某个扩展元素标记为已弃用,请编辑替换字段在其位置指定用户应使用的未弃用扩展点,以实现相同的功能。

从标签属性字段中选择元素的其中一个已定义属性,以指定在插件清单编辑器中将该属性值用作元素标签。例如,如果选择了一个值,那么插件清单编辑器中扩展页的所有扩展部分中的元素节点标签将具有如下格式:所选属性值(元素名)。否则,如果未选择值,那么元素的节点标签如下所示:(元素名)。

从图标字段中选择元素的其中一个已定义资源类型属性,以指定插件清单编辑器中用来代表元素节点的图标资源。为了在插件清单编辑器中扩展页的所有扩展部分中正确显示该元素的节点图标,必须符合下列条件:

在可翻译字段中单击 true 按钮或 false 按钮,以指示该元素的字符内容是否可翻译。此字段仅适用于那些没有所指定子代(元素内容)或属性并且允许在其开始和结束 XML 标记中指定文本(字符内容)的元素。如果将某个元素的字符内容标记为可翻译,那么可以对所添加的扩展 XML 标记使用 PDE 工具以将内容外部化到属性文件中,从而支持多种语言。

使用只读的 DTD 近似值字段来查看从元素模式语法到等效元素 DTD 语法的近似一对一映射。您可以使用 DTD(文档类型定义)来代替 XML 模式指定 XML 文档的正式语法,它虽然功能不如 XML 模式强大,但易于阅读。下列注释用来指定 DTD 近似值:

“编写器详细信息”部分

此部分允许您编辑编写器的属性。编写器分为两类,即序列编写器和选项编写器。序列编写器允许您指定元素的子代由所编辑模式语法中其他元素的序列组成。选项编写器允许您指定元素的子代由所编辑模式语法中某个其他元素组成。

要激活此部分,请在扩展点元素部分中选择序列或选项节点。

“编写器详细信息”部分

“编写器详细信息”部分中的字段

编辑最小出现次数字段,以指定允许其他元素和/或编写器的此编写器在所添加扩展 XML 标记中的最小出现次数。PDE 将使用此字段的值来验证插件清单编辑器中的多重性约束。如果元素 A 刚好需要一个元素 B 或元素 C 作为其子代,并且使用指定了最小出现次数为 2 的选项编写器,那么必须在所添加的扩展 XML 标记中定义任意 2 个元素 B 和 元素 C 的实例,这样才有效。

编辑最大出现次数字段,以指定允许其他元素和/或编写器的此编写器在所添加扩展 XML 标记中的最大出现次数。PDE 将使用此字段的值来验证插件清单编辑器中的多重性约束。如果元素 A 刚好需要一个元素 B 或元素 C 作为其子代,并且使用指定了最大出现次数为 2 的选项编写器,那么在所添加的扩展 XML 标记中定义的连结元素 B 和元素 C 的实例总共不能超过两个,这样才能保持有效。

选中不限制字段以指定不对此编写器在所添加扩展 XML 标记中的最大出现次数进行约束。

从类型字段中选择一个值,以指定此编写器是序列编写器还是选项编写器。

使用只读的 DTD 近似值字段来查看从编写器模式语法到等效编写器 DTD 语法的近似一对一映射。注释用来指定在此文档标题中的“元素详细信息”部分中的字段中描述的 DTD 近似值。

“元素引用详细信息”部分

此部分允许您编辑元素引用的属性。元素引用是对所编辑模式语法中全局元素声明的引用。编写器使用元素引用作为原子构建块,以定义全局元素声明的语法。

要激活此部分,请从扩展点元素部分中选择元素引用节点。

“元素引用详细信息”部分

“元素引用详细信息”部分中的字段

编辑最小出现次数字段,以指定允许此元素在所添加扩展 XML 标记中的最小出现次数。PDE 将使用此字段的值来验证插件清单编辑器中的多重性约束。如果元素 A 指定最小出现次数为 2,那么必须在所添加扩展 XML 标记中定义 2 个元素 A 的实例,这样才有效。

编辑最大出现次数字段,以指定允许此元素在所添加扩展 XML 标记中的最大出现次数。PDE 将使用此字段的值来验证插件清单编辑器中的多重性约束。如果元素 A 指定最大出现次数为 2,那么不能在所添加扩展 XML 标记中定义 2 个以上元素 A 的实例,这样才能保持有效。

选中不限制字段以指定不对此元素在所添加扩展 XML 标记中的最大出现次数进行约束。

使用只读的 DTD 近似值字段来查看从元素模式语法到等效元素 DTD 语法的近似一对一映射。注释用来指定在此文档标题中的“元素详细信息”部分中的字段中描述的 DTD 近似值。

“元素引用详细信息”部分的操作

单击引用字段中的元素名超链接,以编辑这个局部元素引用所引用的全局元素声明的属性。此操作完成后,在扩展点元素部分中将选中所引用的元素节点,并且将激活相应的元素详细信息部分。

“属性详细信息”部分

此部分允许您编辑属性的属性。属性用于提供关于元素的其他信息。

要激活此部分,请从扩展点元素部分中选择必需属性、可选属性、类属性或资源属性节点。

字符串类型的必需属性的属性详细信息部分,此部分指定了枚举限制。

“属性详细信息”部分 1

布尔类型的可选属性的属性详细信息部分,此部分指定了缺省值。

“属性详细信息”部分 2

类属性的属性详细信息部分,此部分指定属性值所代表的类必须扩展指定的类并且/或者实现指定的接口。

“属性详细信息”部分 3

资源属性的属性详细信息部分。

“属性详细信息”部分 4

使用模式标识属性

扩展点作用可定义引用其他属性的属性。这是通过将扩展点属性设置为类型标识并选择它引用的属性实现的。此项的示例为 org.eclipse.ui.handlers 扩展点。commandId 属性引用 org.eclipse.ui.commands 扩展点中定义的命令。

模式标识用法

提供处理程序的扩展开发者可从 commandId 属性的所有有效标识中进行选择。系统会针对不存在的标识发出警告,以避免标识拼写错误这类常见错误。

“属性详细信息”部分中的字段

编辑名称字段以指定属性名。

单击已弃用字段中的 true 按钮或 false 按钮,以指定是否已弃用该属性。缺省情况下,对于任何已弃用的扩展 XML 标记,插件清单编辑器将标记警告。此字段类似于 Java 的 Javadoc @deprecated 标记。

从使用字段中选择值,以指定是否必须在所添加扩展 XML 标记的定义元素中指定该属性。可用的选项如下所示:

编辑缺省值字段,以指定在所添加扩展 XML 标记的定义元素中未指定该属性时使用的缺省值。仅当在使用字段中选择了缺省值时,此字段才适用。

从类型字段中选择一个值,以指定属性的值类型。可用的选项如下所示:

在可翻译字段中单击 true 按钮或 false 按钮,以指示该属性的值是否可翻译。仅当在类型字段中选择了字符串值时,此字段才适用。如果将某个属性的值标记为可翻译,那么可以对所添加的扩展 XML 标记使用 PDE 工具以将这些值外部化到属性文件中,从而支持多种语言。

使用限制字段来查看一组字符串值,该属性只能使用这些字符串值作为它自己的值。如果此字段未包含任何值,那么表示对属性值没有限制。仅当在类型字段中选择了字符串值时,此字段才适用。注意:在所编辑模式的语法中,将使用字符串基本类型的枚举限制来实现此功能。

编辑扩展字段以指定目标平台类路径中的标准类名,例如 org.eclipse.ui.part.EditorPart,作为属性值指定的类必须是这个类的子类。PDE 将验证所添加扩展 XML 标记中的类属性值,以确保它扩展这个超类。仅当在类型字段中选择了 Java 值时,此字段才适用。

编辑实现字段以指定目标平台类路径中的标准接口名,例如 org.eclipse.ui.IEditorPart,作为属性值指定的类必须实现此接口。PDE 将验证所添加扩展 XML 标记中的类属性值,以确保它实现此接口。仅当在类型字段中选择了 Java 值时,此字段才适用。

“属性详细信息”部分的操作

在限制字段中单击添加...按钮以打开新建限制对话框,以便对属性值添加新限制。完成此对话框后,在该属性只能使用的字符串值列表中将添加新限制。仅当在类型字段中选择了字符串值时,此操作才可用。

从限制字段中选择字符串值,然后单击除去按钮,以从该属性只能使用的字符串值列表中除去限制。仅当在类型字段中选择了字符串值时,此操作才可用。

如果扩展字段中指定的值引用目标平台类路径中的标准类名,那么单击扩展超链接时,将在新的 Java 源代码编辑器中打开该类。否则,单击扩展超链接时,将打开新建 Java 类向导,以允许您创建新类。仅当在类型字段中选择了 Java 值时,此操作才可用。

如果实现字段中指定的值引用目标平台类路径中的标准接口名,那么单击实现超链接时,将在新的 Java 源代码编辑器中打开该接口。否则,单击实现超链接时,将打开新建 Java 类向导,以允许您创建新接口。仅当在类型字段中选择了 Java 值时,此操作才可用。

单击浏览...按钮以打开选择类型对话框,以便选择目标平台类路径中的现有类用作扩展字段值。仅当在类型字段中选择了 Java 值时,此操作才可用。

单击浏览...按钮以打开选择类型对话框,以便选择目标平台类路径中的现有接口用作实现字段值。仅当在类型字段中选择了 Java 值时,此操作才可用。

相关链接