虎の巻項目拡張

org.eclipse.ui.cheatsheets.cheatSheetItemExtension

3.0

この拡張ポイントは、虎の巻内のステップにさらにボタンを追加する必要がある場合に使用します。 新規の属性を虎の巻コンテンツ・ファイルの「item」タグに記述できます。虎の巻フレームワークでこの値が読み取られると、 この属性を処理する拡張ポイントを使用して登録したクラスが存在するかどうかがチェックされます。 虎の巻コンテンツ・ファイルにある属性名は、すべての登録済み cheatsheetItemExtension ポイント実装の「itemAttribute」 属性内のすべての値と突き合わせられます。 値が一致すると、この項目属性を処理するように指定したクラスが虎の巻フレームワークによってロードされ、 虎の巻コンテンツ・ファイルで指定した属性を処理するために呼び出されます。 この項目属性の値を構文解析した後でも、クラスは虎の巻フレームワークで使用できます。 この項目が虎の巻ビューに表示されると、クラスは、コンポジットへのコンポーネントの追加を処理するために再度呼び出されます。 このコンポジットに追加された項目は、虎の巻ステップ (ヘルプ・アイコンの横) に表示されます。 虎の巻コンテンツ・ファイルへの属性の表示は、「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 をロードし、この gif を新規ボタンのアイコンとして使用します。

API の詳細 については、org.eclipse.ui.cheatsheets.AbstractItemExtensionElement の Javadoc 情報を参照してください。

現時点で提供される実装はありません。