プラグインは、OSGi マニフェスト (MANIFEST.MF) ファイルおよびプラグイン・マニフェスト (plugin.xml) ファイルを使用して Eclipse プラットフォーム にその構造を記述する、構造化コンポーネントです。HATS リッチ・クライアント・プロジェクトは、Lotus Notes®、Lotus® Expeditor Client など、Eclipse 環境で実行するプラグインを生成するために必要な成果物を含む、Eclipse プラグイン・プロジェクトです。 プラグイン・プロジェクトは、Eclipse Software Development Kit (SDK) のコンポーネントである、Eclipse プラグイン開発環境 (PDE) を使用して開発します。Rational® Software Delivery Platform (SDP) は Eclipse SDK を拡張したもので、HATS は Rational SDP の拡張をさらに進めたものです。Eclipse PDE について詳しくは、http://www.eclipse.org/pde/ を参照してください。
Eclipse PDE で提供されたツールの 1 つに、プラグインのマニフェスト・エディターがあります。このエディターは、プラグインが実行中の Eclipse 環境に対するプラグインを説明したファイルを修正するために使用されます。プラグインには通常、plugin.xml および MANIFEST.MF の 2 つのマニフェスト・ファイルがあります (プラグインが別のプラグインを拡張しない場合 plugin.xml はオプション)。ワークベンチでどちらかのファイルを開いている場合、同一のエディターが開かれます。ただし、エディターのフィールドは別のファイルと結合されています。plugin.xml は、プラグインがプラットフォームを拡張する方法、プラグインがプラグイン自体を公開する拡張、およびプラグインが機能をインプリメントする方法について記述します。MANIFEST.MF ファイルは、このプラグインが必要な ID、バージョン、ベンダー、および他のプラグインを指定します。
HATS リッチ・クライアント・プロジェクトのプラグイン・マニフェストを編集するには、プロジェクトのプロジェクト設定エディターの「概要」ページにある「プラグイン・マニフェストをオープンしてください」リンクをクリックしてください。エディターには、以下のタブが付いています。
プラグインが、他のプラグインによる機能部分の拡張またはカスタマイズを許可する場合、拡張ポイントを宣言します。拡張ポイントは、通常は XML マークアップと Java インターフェースの組み合わせの、拡張が準拠する規約を宣言します。この拡張ポイントに接続するプラグインは、その拡張にこの規約をインプリメントする必要があります。拡張されるプラグインが、その拡張ポイント規約のスコープを超えて接続しているプラグインに関してはなにも認識しない、ということがキー属性になっています。これによって、異なる個人または企業によって作成されるプラグインは、お互いをよく認識しなくても、シームレスに対話することができます。
com.ibm.hats.rcp.runtime.rcpApplications 拡張機能は、使用する HATS リッチ・クライアント・プラグインを HATS ランタイムに登録します。こうすることにより、HATS ランタイムは、どのプラグインが HATS アプリケーション・プラグインなのかを認識します。「アプリケーション」ビューは、この拡張ポイントをインプリメントするプラグインに基づいて移植されます。この拡張ポイントも、アプリケーションのインスタンスが起動されたときに、どのビュー (デフォルトでユーザーの変換ビュー) が開くのかを示しています。
HATS RCP プロジェクトは Eclipse org.eclipse.ui.views 拡張を使用して、このプラグインの変換ビュー・クラスを Eclipse プラットフォームに登録します。
デフォルトでは、ユーザーはアプリケーションの変換ビューの複数インスタンスを開くことで、HATS リッチ・クライアント・アプリケーションの複数インスタンスを一度に処理できます。ユーザーがアプリケーションの複数インスタンスを始動することを制限するために、プラグイン・プロジェクトのプラグイン・マニフェスト・ファイル (plugin.xml) にフラグを設定することができます。このフラグによって、Eclipse はアプリケーションのビューのインスタンスを 1 つのみ許可するよう通知します。このフラグを設定するには、以下を行います。
ランタイム時にユーザーがアプリケーションの 2 番目のインスタンスを開こうとすると、最初のアプリケーション・インスタンスに対応するビューがフォーカスされます。
HATS リッチ・クライアント・プラグイン・プロジェクトを作成するときに、ワークスペースに HATS リッチ・クライアント・ランタイム拡張プラグイン・プロジェクトがまだ存在していない場合には、このプロジェクトも作成されます。このプラグインには、環境で実行中のすべての HATS リッチ・クライアント・プラグインに共通するファイルおよび設定が含まれています。 たとえば以下のものがあります (これらに制限されません)。
このプラグインのデフォルト名および ID は com.ibm.hats.rcp.runtime.extension で、その初期バージョンは 1.0.0 です。
このプラグインは、複数の HATS アプリケーションに共通のファイルを含んでいるという点で、HATS EAR プロジェクトと似ています。HATS EAR プロジェクトと異なる点は、Eclipse 環境で一度に実行できるのが、これらのプラグインの 1 つのみということです。つまり、トレース設定やキーボード・マッピングなどはリッチ・クライアント環境全体に適用され、プラグイン・プロジェクト・レベルでは構成できません。
表 1 では、このプラグインに含まれているファイルがリスト表示され、説明されています。
表 2 では、このプラグインに含まれている HATS 固有ではないファイルがリスト表示され、説明されています。
| ファイルまたはフォルダー | 説明 |
|---|---|
| build.properties | 開発環境からのエクスポート時に、どのファイルをプラグインにパッケージする必要があるかを示しています。 |
| MANIFEST.MF | プラグイン記述子。プラグインの ID、名前、バージョン、およびプラグイン依存関係が示されています。 |
| plugin.xml | プラグイン記述子。このプラグインによって提供される拡張を示しています。 |
| plugin_xx.properties | plugin.xml および MANIFEST.MF によって使用される変換済み文字列が含まれています。 |
表 3 は、HATS RCP ランタイム拡張プラグインによって提供されている拡張をリスト表示します。
| 拡張ポイント ID | 説明 |
|---|---|
| org.eclipse.core.runtime.applications | HATS RCP ランタイム拡張プラグインで提供されているアプリケーション・クラスを Eclipse プラットフォームに登録します。詳細については、Application クラスを参照してください。 |
| org.eclipse.core.runtime.products | org.eclipse.core.runtime.applications 拡張ポイントに登録されているアプリケーションを参照する製品を定義します。詳細については、Application クラスを参照してください。 |
| org.eclipse.ui.perspectives | Eclipse プラットフォームに、HATS RCP ランタイム拡張プラグインで提供されている ホスト・アクセス・パースペクティブ・クラスを登録します。 パースペクティブおよびビューを参照してください。 |
| org.eclipse.ui.views | 「アプリケーションおよび印刷ジョブ」ビューを Eclipse プラットフォームに登録します。 |
| org.eclipse.ui.propertyPages | アプリケーションのプロパティー・ページを Eclipse プラットフォームに登録します。 これらのページは、ユーザーが「アプリケーション」ビューでアプリケーションを右クリックし、「プロパティー」を選択したときに表示されます。この宣言を除去またはコメント化することによって、ユーザーがこのページを使用できないようにすることが可能です。
注:
「接続パラメーターのオーバーライド」ページは、接続パラメーターの指定変更がプロジェクトで使用可能になっている場合のみ表示されます。「変数オーバーライド」ページは、グローバル変数の指定変更がプロジェクトで使用可能になっている場合のみ表示されます。 |
| org.eclipse.ui.actionSets | 変換ビューに表示されている項目を印刷するために使用する印刷アクションを登録します。 |
| org.eclipse.ui.preferencePages | HATS によって提供されている設定ページを登録します。プリファレンスは、(Eclipse の環境に応じて) 通常「ファイル」>「設定」または「ウィンドウ」>「設定」を選択することによって使用可能になります。この宣言を除去またはコメント化することによって、ユーザーがこのページを使用できないようにすることが可能です。例えば、ユーザーがトレースまたはサービス設定を変更できなくするには、「トラブルシューティング」ページに宣言されている拡張を除去します。 |
| org.eclipse.ui.contexts | Host Access キーボード・コンテキストを登録します。コンテキストは、関連するコマンドのグループを定義します。 |
| org.eclipse.ui.commands | 使用可能なアクションごとに、コマンドを登録します。コマンドは、アクションによって処理可能な、エンド・ユーザーからの要求を表しています。 |
| org.eclipse.ui.bindings | 特定のコマンドに対するデフォルト・キーボード・ショートカットを登録します。宣言の sequence 属性を変更することによって、コマンドのデフォルト・ショートカットを変更できます。ユーザーは、「キー」設定ページを使用して、コマンドのショートカットを指定変更できます。
キー・マッピングは、目的のランタイム・クライアントに基づき、スキーム ID ごとに定義します。Eclipse RCP と Lotus Expeditor Client の両方に関する schemeId を以下に示します。 org.eclipse.ui.defaultAcceleratorConfiguration. Lotus Notes の schemeId を以下に示します。 com.ibm.workplace.notes.hannoverConfiguration. 注:
例については、「HATS ユーザーと管理者のガイド」のセクション『HATS リッチ・クライアント・アプリケーションのキーの再マップ』を参照してください。 |
| com.ibm.eswe.workbench.WctApplication | Host Access パースペクティブを Lotus Expeditor Client および Lotus Notes に登録します。この拡張ポイントは、「開く」メニューに表示されるアプリケーションのリストにデータを取り込むために、Lotus Expeditor Client および Lotus Notes によって使用されます。詳細は、Lotus Expeditor 資料の『アプリケーション』を参照してください。
注:
この宣言は、Lotus Expeditor Client または Lotus Notes へのデプロイメントをターゲットとするプロジェクトがワークスペースにない場合、表示されません。 |
このセクションで説明されているクラスは、Eclipse リッチ・クライアント・プラットフォーム環境の始動および構成を行います。これらのクラスの機能およびデフォルトのインプリメンテーションの詳細については、http://www.eclipse.org/documentation/ にある Eclipse 資料を参照し、ご使用の Eclipse のバージョンを選択し、『Building a Rich Client Platform application』という名前のセクションを検索してください。
Eclipse アプリケーション・クラスは、Eclipse 環境のメイン・エントリー・ポイントです。Eclipse プラットフォームが始動すると、指定したアプリケーションを検出してロードします。
デフォルト・アプリケーション・クラス (HostAccessApplication) は、HATS RCP ランタイム拡張プラグイン・プロジェクトに提供されています。このクラスは、提供された HostAccessWorkbenchWindowAdvisor クラスにより構成される新規ワークベンチ・ウィンドウを作成します。
提供されているアプリケーションを Eclipse 環境インスタンスのメイン・エントリー・ポイントとして使用するには、以下のように、アプリケーション引数にアプリケーションの ID を指定します。
Eclipse 製品は、Eclipse 環境をブランド化します。ブランド化には、「製品情報」ダイアログの定義、ウィンドウ・アイコンの設定、デフォルト・プリファレンスの定義、プラットフォーム始動時に表示されるスプラッシュ画面の指定などがあります。ブランド化の詳細については、http://www.eclipse.org/documentation/ にある Eclipse 資料を参照し、ご使用の Eclipse のバージョンを選択し、『Customizing a product』という名前のセクションを検索してください。 デフォルトの製品は、HATS ランタイム拡張プラグイン (com.ibm.hats.rcp.runtime.extension.product) に定義されています。この製品を使用して Eclipse プラットフォームを始動するには、以下のように製品の引数の製品 ID を指定します。
製品の拡張ポイントが、使用するアプリケーションを示すため、製品の指定時にアプリケーションを指定する必要はありません。HATS ランタイム拡張プラグイン製品の場合、HATS ランタイム拡張プラグイン・アプリケーションがデフォルトで使用されます。
Eclipse WorkbenchAdvisor クラスは、デフォルトのパースペクティブを指定して、WorkbenchWindowAdvisor オブジェクトを構築します。このオブジェクトはワークベンチ・ウィンドウを構成します。このクラスのインプリメンテーションは、HATS RCP ランタイム拡張プラグインに提供されています。このクラス HostAccessWorkbenchAdvisor は、HostAccessWorkbenchWindowAdvisor オブジェクトの新規インスタンスを戻し、デフォルトのパースペクティブとして hostaccess.perspectives.main を指定します。これが、新規ワークベンチ・ウィンドウが開くときに、Host Access パースペクティブがデフォルトで表示される理由です。カスタム・パースペクティブを作成している場合、getInitialWindowPerspectiveId() メソッドを更新して、このパースペクティブの ID を戻すことができます。代わりに、-perspective 引数を使用して Eclipse が起動されるときに、以下のようにパースペクティブを指定することもできます。
Eclipse WorkbenchWindowAdvisor クラスは、サイズ、位置、およびスタイルを含む、Eclipse ワークベンチ・ウィンドウの構成を行います。このクラスのインプリメンテーションは、HATS RCP ランタイム拡張プラグインに提供されています。このクラス (HostAccessWorkbenchWindowAdvisor) は、ワークベンチ・ウィンドウの初期サイズを指定し、クールバーおよび状況表示行域を非表示にします。これは、HATS はデフォルトではこれらの領域に寄与しないためです。
このクラスは、アクション・バー・アドバイザーを作成することもできます。アクション・バー・アドバイザーは、主に、ワークベンチ・ウィンドウのメニュー・バーを構成します。ワークベンチ・ウィンドウのメニュー・バーおよびツールバーのカスタマイズについて詳しくは、HostAccessActionBarAdvisorを参照してください。
ワークベンチ・ウィンドウのデフォルト・サイズを変更するには、以下の手順に従います。
public void preWindowOpen() {
IWorkbenchWindowConfigurer configurer = getWindowConfigurer();
configurer.setInitialSize(new Point(800, 600));
...
}ワークベンチ・ウィンドウを開くときに、デフォルトで自動的に最大化するには、HostAccessWorkbenchWindowAdvisor クラスの postWindowCreate() メソッドを以下のようにインプリメントします。
public void postWindowCreate() {
PlatformUI.getWorkbench().getActiveWorkbenchWindow().
getShell().setMaximized(true);
}
パースペクティブ・バーはワークベンチ・ウィンドウの上部付近にあり、既に開いた状態のパースペクティブに素早くアクセスできるほか、エンド・ユーザーは新規パースペクティブを開くこともできます。パースペクティブ・バーを表示すれば、エンド・ユーザーは他のパースペクティブを素早く簡単に処理できるようになります。パースペクティブ・バーを表示するには、以下を行います。
public void preWindowOpen() {
IWorkbenchWindowConfigurer configurer = getWindowConfigurer();
configurer.setShowPerspectiveBar(true);
...
}Eclipse ActionBarAdvisor クラスは、ワークベンチ・ウィンドウのアクション・バー (ツールバー、クールバー、メニュー・バー、状況表示行) を構成します。このクラスのインプリメンテーションは、HATS RCP ランタイム拡張プラグインに提供されています。このクラス HostAccessActionBarAdvisor は、「ファイル」メニューの項目を含むメニュー・バーのアクションを作成します。
表 4 では、HostAccessActionBarAdvisor クラスによってインプリメント、または拡張可能なメソッドをリスト表示します。
HostAccessActionBarAdvisor クラスを拡張する方法を例示するために、以下の手順では、ツールバー項目をワークベンチ・ウィンドウのメイン・クールバー領域に追加する方法を示します。クリックすると、指定した HATS リッチ・クライアント・アプリケーションの新規インスタンスが開きます。
public void preWindowOpen() {
...
configurer.setShowCoolBar(true);
...
}private LaunchApplicationAction launchAppAction;
protected void makeActions(final IWorkbenchWindow window) {
...
launchAppAction = new LaunchApplicationAction("myPlugin", window);
}protected void fillCoolBar(ICoolBarManager coolBar) {
// Create toolbar manager
IToolBarManager mainToolbar = new ToolBarManager(SWT.FLAT | SWT.RIGHT);
// Add the launch action to the toolbar manager
mainToolbar.add(launchAppAction);
// Add the main toolbar to the window coolbar
coolBar.add(new ToolBarContributionItem(mainToolbar, "main"));
}