ナビゲーション・ヘッダーをスキップ
Oracle Help for Java開発者ガイド Table of Contents
目次
Previous topic
前へ
Next topic
次へ

アプリケーションでの状況依存ヘルプの有効化

状況依存ヘルプ・トピックは、製品のユーザー・インタフェースに関連付けられ、その操作状況に応じて起動されます。たとえば、状況依存ヘルプ・システムには、製品のメニューやダイアログ・ボックスについて記述されたトピックが含まれます。ユーザーが、ユーザー・インタフェースのコントロールの1つに関するヘルプを要求すると、そのコントロールに関する適切なトピックが表示されます。

Oracle Help for Javaでは、ヘルプ・トピックをユーザー・インタフェースのコントロールに関連付け、ユーザーが[F1]キーを押すか、またはポップアップ・メニューの「ヘルプ」を選択したときに状況依存ヘルプを起動するメカニズムが提供されています。また、あるコンポーネントに関連付けられたヘルプ・トピックを明示的に表示するためのAPIも用意されています。

状況依存ヘルプをアプリケーションに実装するには、ヘルプ・システムのソースに1つ以上のマップ・ファイルがあり、適切なヘルプ・コードをアプリケーションのコードに追加する必要があります。この手順については、次の各項で説明します。

ヘルプ・トピックへのトピックIDのマッピング

状況依存ヘルプ・システムには、トピックIDをヘルプ・トピックにマップするマップ・ファイルが1つ以上含まれている必要があります。(プロジェクトによりますが、マップ・ファイルは多くの場合、プログラマではなくヘルプの作成者によって作成されます。)OHJでは、次の2種類のマップ・ファイルがサポートされています。

HelpSetsおよびHelpBooksの詳細は「アプリケーションへのOHJの追加」を参照してください。

アプリケーション・コード内で、マップ・ファイルのトピックIDに対応する一連のJava定数を定義する場合があります。トピックIDが要求されるOHJメソッド(Help.showTopic()など)を使用する場合、マップ・ファイルからトピックIDを明示的に指定するかわりに、定数の変数名を指定できます。これにより、後でマップ・ファイルのトピックIDが変更されても、コードを変更する必要はなくなります。これは、ヘルプの作成者がマップ・ファイルのメンテナンスを担当している場合、特に有益です。

状況依存ヘルプをサポートするためのアプリケーションのプログラム

Javaの標準ツールキット(AWTおよびSwing)には、ヘルプ・トピックとコンポーネントを関連付ける組込みのメカニズムは含まれていません。しかしOHJでは、CSHManager(Context-Sensitive Help Manager)クラスを使用してJavaアプリケーションに状況依存ヘルプを実装する一般的な方法が用意されています。CSHManagerは、ヘルプ・トピックをユーザー・インタフェース・コンポーネントに関連付け、[F1]キーおよび右クリックによる状況依存ヘルプを有効にする方法を提供します。

CSHManagerの使用方法は「状況依存ヘルプを実装するためのCSHManagerの使用方法」を参照してください。