リッチ・クライアント変換と同様に、リッチ・クライアント・テンプレートは Java™ クラスです。 これは、org.eclipse.swt.widgets.Composite から 拡張する com.ibm.hats.rcp.ui.templates.RcpTemplate クラスから 拡張します。テンプレートは、SWT ウィジェット、 マクロ・コントロール、ホスト・キー、および アプリケーション・キーを含むことができます。テンプレートは SWT コンポジットであるため、 テンプレートには非 HATS ウィジェットも追加できます。
テンプレートにホスト・コンポーネント (ComponentRendering コンポジット)、 デフォルト・レンダリング・コンポジット、グローバル変数コントロールを 含めることはできませんが、変換にはこれらを含めることができます。
テンプレートは、HATS が提供するいずれかの定義済みテンプレートを拡張することで作成できます。テンプレートは、以下のような アプリケーションの基本的レイアウトおよびスタイルを定義します。
表 9 に、RcpTemplate クラスによってオーバーライド可能なメソッドをリストします。
| メソッド | 説明 |
|---|---|
| getDefaultFont() | ウィジェットが使用するデフォルトのフォントを戻します。 |
| getDefaultMonospacedFont() | テンプレート・レベルでデフォルトのモノスペース・フォントをオーバーライドできるようにします。 |
| getDefaultBackgroundColor() | テンプレートのデフォルト背景色を戻します。 |
| getDefaultForegroundColor() | テンプレートのデフォルト前景色を戻します。 |
| getColorMapper() | ホスト色がビュー上の色にマップされる方法を制御する IColorMapper オブジェクトを戻します。 |
| getTableColorProvider() | テーブル制御でどの色を使用するかを制御する ITableColorProvider オブジェクトを戻します。 |
| getContentContainer() | テンプレートに表示される変換やコンポジットの親になる コンポジットを戻します。 |
これらのメソッドについて詳しくは、「HATS Rich Client Platform API reference」を参照してください。
HATS ランタイムは、テンプレートの構成と廃棄を実行します。HATS ランタイムは、以下のステップを実行します。
テンプレートは、「リッチ・クライアント・コンテンツ」>「テンプレート」の下の「HATS プロジェクト」ビュー内にあります。
Java クライアント・アプリケーション・エディター (VE) 機能 (別名 Visual Editor) が Rational® SDP とともにインストールされている場合、これを使用して変換を編集できます。このセクションの情報に加えて、「HATS ユーザーと管理者のガイド」の『リッチ・クライアント・プロジェクトのテンプレートの編集』を参照してください。
デフォルトで、HATS で出荷されているテンプレートは、RcpTemplate のメソッドに対するテンプレート・クラスの背景色、前景色、およびフォントを戻します。IRcpTemplate インターフェースをインプリメントする場合は、Visual Editor の「プロパティー」ビューを使用してテンプレートの背景色、前景色、およびフォントを更新することをお勧めします。
Visual Editor には Image、Color、および Font オブジェクトをクリーンアップするときの問題があることが分かっています。Visual Editor によって提供される Properties Editor を使用してこれらをテンプレートまたは変換に追加する場合は、Java エディターを使用して手動でクリーンアップ・ロジックを追加する必要があります。例えば、Visual Editor を使用して新しい Color オブジェクトを追加すると、以下のコードが生成されます。
sideBarArea.setBackground(new Color(Display.getCurrent(), 221, 228, 255));
次に、ウィジェットを破棄するときに Color オブジェクトをクリーンアップするための 以下のコード行を追加してください。
sideBarArea.addDisposeListener(new DisposeListener(){
public void widgetDisposed(DisposeEvent e){
Color background = sideBarArea.getBackground();
if (background != null && !background.isDisposed()) {
background.dispose();
}
}
});
Image オブジェクトおよび Font オブジェクトの場合にも、 クリーンアップのための同様のロジックが必要です。以下のコード行は、Image オブジェクトを クリーンアップする場合の例です。
label = new Label(bannerArea, SWT.RIGHT);
gridData = new GridData(SWT.END, SWT.CENTER, true, true);
label.setImage(new Image(Display.getCurrent(), getClass().
getResourceAsStream("/images/sportsmast.gif")));
label.setLayoutData(gridData);
label.addDisposeListener(new DisposeListener() {
public void widgetDisposed(DisposeEvent e){
Image image = label.getImage();
if (image != null && !image.isDisposed()) {
image.dispose();
}
}
});
前記のように、HATS が提供する ColorManager クラスまたは FontManager クラスを使用する場合は、Color オブジェクト および Font オブジェクトをクリーンアップする必要はありません。 クリーンアップ・コードを記述するときには、Visual Editor が提供する Properties Editor ではなく、必ず Java エディターを使用してください。以下のコードは、ColorManager の使用方法の例です。
sideBarArea.setBackground(com.ibm.hats.rcp.ui.misc.ColorManager.
getInstance(Display.getCurrent()).getColor(221, 228, 255));
ホスト色のビュー上の色へのマッピングは、テンプレート・クラスの getColorMapper() メソッドによって戻される IColorMapper オブジェクトによって制御されます。このメソッドのデフォルト・インプリメンテーションでは、DefaultColorMapper タイプのオブジェクトを戻します。以下の色マッパー・クラスは、HATS によって提供されています。
DefaultColorMapper は、非ホワイト背景色を持つテンプレートで使用する必要があります。これは、ホワイト・ホスト・フィールドの色をホワイトにマッピングしているためです。WhiteBackgroundColorMapper は、ホワイトまたは明るい背景色を持つテンプレートで使用する必要があります。これは、このマッパーが、ホワイト・ホスト・フィールドの色を黒にマッピングし、より暗い色 (デフォルト色マッパーと比較して) を使用しているためです。
IColorMapper オブジェクトの mapColor() メソッドは、ホスト色の SWT RGB 値へのマッピングを行います。このメソッドは、「前景色を使用可能にする」設定が有効になっている場合、通常 HATS フィールド・ウィジェットから呼び出されます。表 10 は、このメソッドに提供可能なホスト色値をリストします。
| ホストの色 | 説明 |
|---|---|
| 0 | ブランク |
| 1 | 青 |
| 2 | 緑 |
| 3 | シアン |
| 4 | 赤 |
| 5 | マジェンタ |
| 6 | 茶 (3270)、黄色 (5250) |
| 7 | 白 (通常輝度) |
| 8 | グレー |
| 9 | ライト・ブルー |
| 10 | ライト・グリーン |
| 11 | ライト・シアン |
| 12 | ライト・レッド |
| 13 | ライト・マジェンタ |
| 14 | 黄色 |
| 15 | 白 (高輝度) |
色がテンプレートによってマッピングされる方法を変更するには、2 つの方法があります。
HATS によって提供されているクラスの 1 つを拡張することにした場合は、mapColor() メソッドを指定変更します。以下のコード・サンプルでは、青 (ホスト色 1) およびマジェンタ (ホスト色 5) ホスト・フィールドの色を変更する方法を示しています。
public class MyCustomColorMapper extends DefaultColorMapper {
public RGB mapColor(int hostColor) {
RGB rgb = null;
if (hostColor == 1) {
rgb = new RGB(100, 100, 100);
} else if (hostColor == 5) {
rgb = new RGB(255, 0, 0);
} else {
rgb = super.mapColor(hostColor);
}
return rgb;
}
}
以下のコード・サンプルでは、カスタム色マッパーを戻すように、テンプレート・クラスの getColorMapper() メソッドをインプリメントする方法を示しています。
public IColorMapper getColorMapper() {
return new MyCustomColorMapper();
}HATS ウィジェットによってレンダリングされる入力フィールドの枠を削除するには、使用しているテンプレートの getControlStyleClass(Class) メソッドをオーバーライドし、ある特定のクラスが SWT テキスト・ウィジェット・クラス (org.eclipse.swt.widgets.Text) である場合のみに「0」を戻すように設定することが可能です。
getControlClassStyle() メソッドのオーバーライドを実行するには、以下の手順に従ってください。
「getControlClassStyle()」メソッドに、以下のコードを追加してください。
if (controlClass.equals(org.eclipse.swt.widgets.Text.class)) {
return 0;
} else {
return super.getControlClassStyle(controlClass);
}