コンポーネントまたはウィジェットの登録
カスタム・コンポーネントおよびウィジェットを ComponentWidget.xml ファイルに登録すると、「ホスト・コンポーネントを挿入」ウィザードなどの ZIETrans Toolkit で使用可能になります。
ホスト・コンポーネントを、特定のウィジェットにマップする必要があります。カスタム・ホスト・コンポーネントは、既存のウィジェット (widget)またはカスタム・ウィジェット (widget)のいずれにもマップすることができます。カスタム・コンポーネントやウィジェットの「作成」ウィザードは、ユーザーのカスタム・コンポーネントとウィジェットを ComponentWidget.xml ファイルに登録し、コンポーネントとウィジェットを関連付けます。カスタム・コンポーネントとウィジェットを関連付けずにウィザードを使用した場合、ComponentWidget.xml ファイルを編集し、関連を追加する必要があります。ComponentWidget.xmlファイルを編集するには、ZIETrans Toolkit の「ナビゲーター」タブをクリックします。ComponentWidget.xml ファイルは、プロジェクトの「ナビゲーター」ビューの下部に表示されます。
注: 登録後にカスタム・コンポーネントまたはウィジェットを削除する場合、コンポーネントやウィジェットのソース・コードをプロジェクトのソース・フォルダーから削除するだけでは完全に除去することはできません。レジストリー内ではなお参照されており、プログラマチックに除去する方法はありません。ComponentWidget.xml ファイルを編集してレジストリーから除去し、そのコンポーネントまたはウィジェットへの参照を削除する必要があります。
次に、ZIETrans が提供するフィールド・テーブル・コンポーネントおよび関連ウィジェットの 1 つ、垂直バー・グラフ・ウィジェットを表示する ComponentWidget.xml ファイルの例を示します。
<ComponentWidgetList>
<components>
<component className="com.ibm.hats.transform.components.FieldTableComponent"
displayName="Field table" image="table.gif">
<associatedWidgets>
<widget className="com.ibm.hats.rcp.transform.widgets.SwtVerticalBarGraphWidget"/>
</associatedWidgets>
</component>
</components>
<widgets>
<widget className="com.ibm.hats.rcp.transform.widgets.SwtVerticalBarGraphWidget"
displayName="Vertical graph" image="verticalBarGraph.gif" />
</widgets>
</ComponentWidgetList>
ご覧のとおり、このファイルには 2 つのセクションがあります。コンポーネントおよびウィジェットです。
コンポーネント・セクションには、登録されたコンポーネントの全リストが含まれています。カスタム・コンポーネントを登録し、ZIETrans Toolkit で使用可能にするには、<component> タグと関連の <widget> タグを ComponentWidget.xml ファイルに追加します。className、displayName、および関連ウィジェットを指定する必要があります。
- className
- ホスト画面のエレメントを認識するコードを含む Java™ クラスを示します。通常、クラス名の形式は com.myCompany.myOrg.ClassName です。
- displayName
- カスタム・コンポーネントの既知名と、ZIETrans Toolkit でそれがどのようにコンポーネントのリストに表示されるかを示します。この名前は、登録済みのコンポーネント間で固有である必要があります。カスタム・コンポーネントの displayName の形式は、単純なストリングです。スペースは、displayName に使用できます。
- image
- image 属性は、ZIETrans Toolkit での表示用に使用するコンポーネントのイメージを示します。
- ウィジェット (widget)
- このコンポーネントに関連付けられたウィジェットを識別します。関連付けられた各ウィジェットには、個別の <widget> タグが必要です。コンポーネントの <widget> タグはすべて、<associatedWidgets> タグおよび、その </associatedWidgets> 終了タグの中で定義される必要があります。<associatedWidgets> タグ内の <widget> タグには、className 属性のみがあり、これはウィジェットをコンポーネントにリンクするコードを含む Java クラスを識別します。通常、クラス名の形式は com.myCompany.myOrg.ClassName です。
ウィジェット・セクションには、登録されたウィジェットの全リストが含まれています。ウィジェットを登録し、コンポーネントにリンクし、ZIETrans Toolkit で使用可能にするには、<widget> タグを ComponentWidget.xml ファイルに追加します。className および displayName を指定する必要があります。
- className
- ウィジェットをレンダリングするコードを含む Java クラスを識別します。通常、クラス名の形式は com.myCompany.myOrg.ClassName です。
- displayName
- カスタム・ウィジェットの既知名と、ZIETrans Toolkit でウィジェットのリストに表示される方法を識別します。この名前は、登録済みウィジェットの中で一意である必要があります。カスタム・ウィジェットの displayName の形式は、単純なストリングです。スペースは、displayName に使用できません。ただし、スペースの代わりに下線 ( _ ) を使用することができます。