パースペクティブおよびビュー

パースペクティブは、Eclipse ワークベンチ・ウィンドウにおけるビューの初期レイアウトを定義します。それぞれのパースペクティブは、特定タイプのタスクを実行する一連の機能を提供し、その特定タイプのリソースを処理します。例えば、Java™ パースペクティブは、Java ソース・ファイルを編集中に一般的に使用されるビューを結合し、デバッグ・パースペクティブは、Java プログラムをデバッグするためのビューを含んでいます。

パースペクティブは、特定のメニューおよびツールバーの表示項目を制御します。パースペクティブは、可視のアクション・セットも定義します。このアクション・セットを使用して変更することにより、パースペクティブをカスタマイズすることができます。この方法で作成したパースペクティブを保管することによって、後に再びカスタム・パースペクティブを開くことができるようにします。

Host Access パースペクティブ

デフォルトのパースペクティブ・クラス (hostaccess.perspectives.MainPerspective) は、com.ibm.hats.rcp.runtime.extension プラグイン・プロジェクトで提供されています。このクラスは、Eclipse パースペクティブ・インターフェース (org.eclipse.ui.IPerspectiveFactory) の拡張であり、間接的に実装されます。 このパースペクティブのデフォルト・タイトルは、Host Access です。ただし、com.ibm.hats.rcp.runtime.extension プラグイン・プロジェクト内の plugin_en.properties ファイルを変更することによって、このタイトルを変更できます。

注:
ユーザーがサポートする言語ごとに、plugin_xx.properties ファイルをそれぞれ変更する必要があります。

表 5 に、このパースペクティブ・クラスでオーバーライド可能なメソッドの一覧を示します。

表 5. パースペクティブ・クラスに対してオーバーライド可能なメソッド
メソッド 説明
addApplicationsView(IPageLayout) HATS アプリケーション・ビューをパースペクティブに追加します。
createTransformationViewsPlaceholder(IPageLayout) HATS 変形ビューのプレースホルダーを作成します。
createPrintJobViewsPlaceholder(IPageLayout)</code> 3270 および 5250 用の印刷ジョブ・ビューのプレースホルダー領域を作成します。
addPrintActionsSet(IPageLayout)</code> com.ibm.hats.rcp.rntime.extension プラグインの plugin.xml で定義された印刷アクションのセットをパースペクティブに追加します。

Host Access ランタイム・アプリケーションによって最初に開かれたデフォルト・パースペクティブを変更するには、com.ibm.hats.rcp.runtime.extension プラグイン・プロジェクト内の HostAccessWorkbenchAdvisor ソース・ファイルを編集し、PERSPECTIVE_ID をユーザーのカスタム・パースペクティブ ID に変更します。ホスト・アクセス・パースペクティブについて詳しくは、HostAccessWorkbenchAdvisorを参照してください。

以下の例は、com.ibm.hats.rcp.runtime.extension 用に Host Access パースペクティブがプラグイン記述子に どのように登録されているかを示しています。

<extension 
     point="org.eclipse.ui.perspectives">
     <perspective
            name="%PERSPECTIVE_TITLE"
            icon="images/applications_view.gif"
            class="hostaccess.perspectives.MainPerspective"
            id="hostaccess.perspectives.main">
      </perspective>
</extension>     

Host Access パースペクティブの使用は必須ではありません。このパースペクティブは、提供した HATS アプリケーションへのエンド・ユーザーによるアクセスを容易にするためのものです。Host Access パースペクティブを取り掛かりとして使用するか、あるいは最初から開始してユーザーの要件にさらに適合するパースペクティブを開発します。

デフォルトで、Host Access パースペクティブには、「アプリケーション」ビューが含まれています。このビューについて詳しくは、「アプリケーション」ビュー を参照してください。

com.ibm.hats.rcp.ui.Perspective クラスについて詳しくは、Javadoc API を参照してください。

注:
Lotus® Expeditor Client および Lotus Notes® の開発者へ: パースペクティブは Lotus Expeditor Client または Lotus Notes ウィンドウの「オープン」メニューでは表示されません。このメニューでは、com.ibm.eswe.workbench.WctApplication 拡張ポイントを使用して登録したアプリケーションを表示します。この拡張ポイントについて詳しくは、HATS ランタイム拡張プラグインを参照してください。

「アプリケーション」ビュー

「アプリケーション」ビュー (com.ibm.hats.rcp.ui.views.ApplicationsView) は、com.ibm.hats.rcp.runtime.extension プラグインに登録されています。このビューは、クライアント環境にインストール済みの HATS リッチ・クライアント・アプリケーションへのアクセスをユーザーに提供します。ユーザーはこのビューから「プロパティー」ダイアログを起動して、アプリケーションのプロパティーを構成することもできます。

このビューの使用方法について詳しくは、「ユーザーと管理者のガイド」のアプリケーション・ビューを参照してください。

アプリケーション・インスタンスのプログラマチックな開始

「アプリケーション」ビューは、Host Access パースペクティブにデフォルトで提供されています。これにより、エンド・ユーザーは、HATS リッチ・クライアント・アプリケーションの新規インスタンスを開始できます。提供されている API によって、ユーザーは、HATS リッチ・クライアント・アプリケーションの新規インスタンスをプログラマチックに起動できます。これはパースペクティブで「アプリケーション」ビューを表示しないよう選択した場合に役立ちます。しかし、アプリケーションをパースペクティブから起動する方法を用意したり、アプリケーション・インスタンスを別のビューからプログラマチックに起動することが必要な場合もあります。例えば、HATS アプリケーションが 1 つのホスト・システムからデータを収集して、別の HATS アプリケーションの新規インスタンスを起動し、データを新規インスタンスに渡すことがあります。

新規のアプリケーション・インスタンスにパラメーターを渡すために、ユーザーは API によって接続パラメーターを指定変更し、グローバル変数値を初期化できます。ボタンをクリックして HATS リッチ・クライアント・アプリケーション・インスタンスを起動するには、以下を行います。

  1. Visual Editor がインストールされている場合は、SWT ボタンをパレットから親コンポジットまたは変換に追加します。Visual Editor がインストールされていない場合は、標準の SWT プログラミングを使用してボタンと widgetSelected() コードを追加します。詳しくは、変換の編集を参照してください。
  2. ボタンを右クリックして、「イベント」>「widgetSelected」を選択します。
  3. widgetSelected(SelectionEvent) メソッドのサンプル・プレースホルダー・コードを以下のコードと置き換えます。

String applicationId = "myApplication";

Properties initParams = new Properties();
initParams.setProperty(com.ibm.eNetwork.beans.HOD.Session.HOST, "129.12.11.2");
initParams.setProperty(com.ibm.eNetwork.beans.HOD.Session.PORT, "623");
initParams.setProperty("hatsgv_userName", "some user");
initParams.setProperty("hatsgv_password", "xxxxx");
initParams.setProperty("hatssharedgv_someVariable", "zzzzz");

ViewInitInfo viewInitInfo = new ViewInitInfo(true, initParams);
RcpUiUtils.launchView(PlatformUI.getWorkbench().getActiveWorkbenchWindow().
                                  getActivePage(), applicationId, viewInitInfo);
注:
接続パラメーターを指定変更するには、プロジェクトの「プロジェクト設定」にある接続パラメーターの指定変更を使用可能にする必要があります。(また、グローバル変数の指定変更を許可するため、グローバル変数の指定変更を使用可能にする必要があります。) この機能を使用可能にすると、「接続パラメーター」ページが、アプリケーションのプロパティー・ダイアログに表示されます。プロパティー・ダイアログを使用して「接続パラメーター」ページを非表示にすることについては、表 3 の org.eclipse.ui.propertyPages 拡張ポイントの説明を参照してください。

変換ビュー

ビューは、情報をユーザーに対して表示する Eclipse パースペクティブの可視コンポーネントです。パースペクティブについて詳しくは、Host Access パースペクティブを参照してください。それぞれの HATS リッチ・クライアント・アプリケーションは、実行中の Eclipse 環境にビュー (基本の com.ibm.hats.rcp.ui.views.TransformationView クラスから拡張したもの) を提供します。変換ビューは、ユーザーが HATS リッチ・クライアント・アプリケーションと対話するために使用します。

表 6 は、指定変更可能なアプリケーションの変換ビュー・クラスのメソッドをリスト表示します。

表 6. 変換ビュー・メソッド
メソッド 説明
createViewActions() ビューのメニューのアクションを作成します。
注:
アクションは、作成後に登録する必要があります。詳細については、変換ビューのメニューの拡張を参照してください。
createKeyboardActions() com.ibm.hats.rcp.runtime.extension プラグイン・プロジェクトの plugin.xml に登録された、すべての既知の HATS キーボード機能のためのキーボード・アクション・クラスを作成します。キーボード・アクションが作成されると、それぞれが registerKeyboardActions() メソッドによってワークベンチ・ウィンドウの IKeyBindingService に登録されます。
注:
createKeyboardActions() メソッドと、他のキーにキーボード・サポートを追加する方法については、「ユーザーと管理者のガイド」を参照してください。
getApplicationKeypadDisplayInfo() ビューのツールバーのアプリケーション・キーパッド領域に表示するボタンのコントロール。デフォルトでは、アプリケーションの設定値を読み取って、表示するキーを識別します。表示対象を計算する必要がある場合、変換ビュー・クラス内でこのメソッドを指定変更できます。ビューのツールバーが非表示の場合、このメソッドに影響はありません。
getHostKeypadDisplayInfo() ビューのホスト・キーパッド領域で表示するキーを制御し、キーの表示方法を示します。デフォルトでは、アプリケーションの設定値を読み取って、表示するキーを識別します。表示対象を計算する必要がある場合、変換ビュー・クラス内でこのメソッドを指定変更できます。
getOiaDisplayInfo() 変換ビューの OIA に表示する情報を示します。デフォルトでは、アプリケーションの設定値を読み取って、表示対象を識別します。表示対象を計算する必要がある場合、変換ビュー・クラス内でこのメソッドを指定変更できます。
getToolbarDisplayInfo() ビューのツールバーを表示するかどうかを示します。表示する場合、ツールバー上でのボタンのレンダリング方法も示します。デフォルトでは、アプリケーションの設定値を読み取って、ツールバーの表示方法を識別します。変換ビュー・クラス内でこのメソッドを指定変更できます。
shouldAutoStart() このビューのオープン時に、アプリケーションが自動的に接続するかどうかを示しています。
注:
特定の変換について、アプリケーション・キーパッド、ホスト・キーパッド、OIA、またはツールバーの表示方法を指定変更する必要がある場合、変換ビュー・クラスではなく変換クラスで適切なメソッドを変更します。領域の表示方法をプログラマチックに変更する必要がある場合のみ、これらのメソッドを変換ビュー・クラスで指定変更します。特定の変換に対してホスト・キーパッドを表示する方法を指定変更する例については、ホスト・キーパッドのカスタマイズを参照してください。

これらのメソッドについて詳しくは、「HATS Rich Client API Reference」を参照してください。

変換ビューのメニューの拡張

以下のコード・サンプルでは、変換ビューのメニューを拡張する方法を示しています。サンプルでは切断メニュー項目が追加され、これをクリックするとホスト接続が切断されて、アプリケーションの切断および停止イベントが実行されます。必要なのは、ビューのライフ・サイクル全体の間で適用されるビューのメニューにアクションを追加することだけです。

変換ビュー・クラスのメニューを拡張するには、以下の手順に従います (このクラスの Java ソース・ファイルは、プロジェクトの <プロジェクト名>.views パッケージにあります):

  1. アクションは少なくとも変換ビュー・クラスの 2 つのメソッドでアクセスする必要があるため、変換ビュー・クラスの private メンバーとして宣言します。
    private com.ibm.hats.rcp.ui.actions.DisconnectAction disconnectAction;
  2. 変換ビュー・クラスの createViewActions() メソッドを指定変更して、HATS で提供されたデフォルト・アクションをビューのメニューで使用可能にしたい場合は、super.createViewActions() を呼び出すようにします。
    protected void createViewActions() {		 		 
    		 		 super.createViewActions();
           	 		 
    		 		 //create an action and append the action to the view's menu.
    		 		 disconnectAction = new DisconnectAction("Disconnect",getSessionService());		 		 
    		 		 getViewSite().getActionBars().getMenuManager().add(new Separator());
    		 		 getViewSite().getActionBars().getMenuManager().add(disconnectAction);
    		 }
  3. updateViewActions() メソッドを指定変更して、メニューを更新したときに新規アクションが使用可能または使用不可になるようにします。
    protected void updateViewActions() {		 		 
    		 		 super.updateViewActions();
           	 		 
    		 		 //enable the action based on the session state.
    		 		 disconnectAction.setEnabled(getSessionService().getSessionServiceState().
                                                         isOperational());
    		 }

「切断」アクションの追加後、変換ビュー内のメニュー・ボタンをクリックすると、メニューに「切断」が表示されます。

図 2. 変換ビュー・メニュー上の「切断」
変換ビュー・メニュー上の「切断」