备忘单项扩展

org.eclipse.ui.cheatsheets.cheatSheetItemExtension

3.0

当需要将一个额外的按钮添加到备忘单的步骤中时,就应该使用此扩展点。可以将新属性放置在备忘单内容文件中的“item”标记中,当备忘单框架读取该值时,它就会检查是否通过此扩展点注册了一个类将用来处理此属性。在备忘单内容文件中找到的属性名将与在所有已注册的 cheatsheetItemExtension 扩展点实现的“itemAttribute”属性中找到的所有值进行匹配。如果具有匹配项,则备忘单框架将装入指定的用来处理此 item 属性的类,并调用该类来处理在备忘单内容文件中指定的属性。在对 item 属性的值进行解析之后,备忘单框架仍然可以使用该类。当为备忘单视图呈示该项时,将再次调用该类来处理将组件添加至“组合体”的操作。添加至此组合体的项显示在备忘单步骤中(当前,备忘单步骤位于帮助图标旁边)。仅对于属性出现在备忘单内容文件中的“item”标记描述的步骤才会显示这些项。 此扩展点的建议用法是添加一个具有图形的小按钮(16x16),按该按钮时就会打开一个对话框。

<!ELEMENT extension (itemExtension)*>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT itemExtension EMPTY>

<!ATTLIST itemExtension

itemAttribute CDATA #REQUIRED

class         CDATA #REQUIRED>

使用此项扩展来将元素添加至备忘单步骤。可以使用此扩展点来为备忘单中的步骤添加图标和按钮(当前,在帮助图标的旁边)。指定将放置到备忘单 item 标记中的属性的名称。还指定在装入备忘单时将处理备忘单内容文件中的属性值的解析的类。属性值必须是字符串。指定的类必须成为 org.eclipse.ui.cheatsheets.AbstractItemExtensionElement 的子类。在对备忘单内容文件进行解析并且装入它之后,就会通过接口再次调用在扩展点中指定的类,以便向备忘单中的步骤添加图形或按钮(当前,在帮助按钮旁边)。



以下是此扩展点的示例实现:

<extension point=

"org.eclipse.ui.cheatsheets.cheatSheetItemExtension"

>

<itemExtension itemAttribute=

"xyzButton"

class=

"com.example.HandleParsingAndAddButton"

>

</itemExtension>

</extension>

以下是该扩展的 item 属性:

<item title=

"XYZ Title"

xyzButton=

"/icon/button.gif"

/>

注意,item 标记中的属性的值可以是“任何内容”。它可以是任何内容,这是因为 对该属性进行解析的类是 HandleParsingAndAddButton 类,在此示例中该类将对属性中的字符串 /icon/button.gif 进行解析。稍后它将使用该信息来装入 gif 文件并将它用作新按钮的图标。

有关 API 详细信息,请参阅 org.eclipse.ui.cheatsheets.AbstractItemExtensionElement 的 Javadoc 信息。

此时没有提供的实现。