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

状況依存ヘルプを実装するためのCSHManagerの使用方法

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

次の各項では、CSHManagerの使用方法の概要について説明します。詳細は、APIのドキュメントoracle.help.CSHManagerを参照してください。

CSHManagerの構築

ユーザー・インタフェースのコンポーネントを作成する前に、CSHManagerクラスのインスタンスを構築する必要があります。CSHManagerコンストラクタについて、次にまとめます。

CSHManager()コンストラクタ
CSHManager(Help help)

CSHManagerクラスの新規インスタンスを構築します。このマネージャ・オブジェクトに対する後続のすべてのコールでは、指定したHelpオブジェクトを使用します。

パラメータ:

help - ヘルプの表示に使用されるHelpオブジェクト。

デフォルトのBookの定義

ヘルプのコンテンツのBookが1つのみの場合、setDefaultBook()メソッドを使用して、それを状況依存ヘルプのデフォルトのBookとして定義することができます。これによって、bookパラメータを入力せずに、addComponent()メソッド(後述)がコールできます。

setDefaultBook()メソッド
setDefaultBook(Book book)

指定したBookを、デフォルトのBookとして定義します。これは、Bookを指定せずに登録されたコンポーネントのデフォルトのBookとして使用されます。

パラメータ:

book - 設定するBook

複数のBookがある場合は、特定のBookを割り当てていないコンポーネントに対してのみ、デフォルトのBookが使用されます。複数のBookがあるヘルプ・システムでは、通常、特定のBookをコンポーネントに割り当ててください。

トピックIDとユーザー・インタフェース・コンポーネントの関連付け

addComponent()メソッドは、トピックID(マップ・ファイルで定義)をJavaユーザー・インタフェースのコンポーネントに関連付けるために使用します。状況依存ヘルプが必要な各コンポーネントに対して、次のいずれかのメソッドをコールします。

addComponent()メソッド
addComponent(Component component, String topicId)

ヘルプ・マネージャにコンポーネントを登録します。

topicIdの検索には、デフォルトのBookが使用されます。このメソッドをコールした時点でデフォルトのBookが登録されていない場合には、コンポーネントがヘルプ・マネージャに登録されないため、このコンポーネントに対して後でshowHelpForComponent()をコールしてもヘルプは表示されません。

このメソッドを使用して登録されたコンポーネントに対して、[F1]キーまたは右クリックによるイベントが発生しても、CSHManagerはヘルプを表示しません。

パラメータ:

component - 追加するコンポーネント。

topicId - このコンポーネントに関連付けるトピックID。

addComponent(Component component, Book book, String topicId)

ヘルプ・マネージャにコンポーネントを登録します。topicIdの検索には、指定したbookが使用されます。

このメソッドを使用して登録されたコンポーネントに対して、[F1]キーまたは右クリックによるイベントが発生しても、CSHManagerはヘルプを表示しません。

パラメータ:

component - 追加するコンポーネント。

book - ヘルプ・トピックを含むBook

topicId - このコンポーネントに関連付けるトピックID。

addComponent(Component component, String topicId, boolean needF1Help, boolean needPopupHelp)

topicIdの検索には、デフォルトのBookが使用されます。このメソッドをコールした時点でデフォルトのBookが登録されていない場合には、コンポーネントがヘルプ・マネージャに登録されないため、このコンポーネントに対して後でshowHelpForComponent()をコールしてもヘルプは表示されません。

パラメータ:

component - 追加するコンポーネント。

topicId - このコンポーネントに関連付ける、作成者定義のトピックID。

needF1Help - trueの場合、[F1]キーを押すと、このコンポーネントに対するヘルプが表示されます。

needPopupHelp - trueの場合、右クリックで「ヘルプ」のポップアップ・メニューが表示され、「ヘルプ」を選択すると状況依存ヘルプが起動します。

addComponent(Component component, Book book, String topicId, boolean needF1Help, boolean needPopupHelp)

ヘルプ・マネージャにコンポーネントを登録します。topicIdの検索には、指定したbookが使用されます。

パラメータ:

component - 追加するコンポーネント。

book - ヘルプ・トピックを含むBook

topicId - このコンポーネントに関連付けられるトピックID。

needF1Help - trueの場合、[F1]キーを押すと、このコンポーネントに対するヘルプが表示されます。

needPopupHelp - trueの場合、右クリックで「ヘルプ」のポップアップ・メニューが表示され、「ヘルプ」を選択すると状況依存ヘルプが起動します。

コンポーネントに対するヘルプの明示的な表示

コンポーネントに関連付けられたヘルプ・トピックを明示的に表示する場合は、CSHManagershowHelpForComponent()メソッドをコールします。たとえば、ユーザーがダイアログ・ボックスの「ヘルプ」ボタンを押したときに状況依存ヘルプを起動する場合、そのボタンのイベント・ハンドラでこのメソッドをコールします。

showHelpForComponent()メソッド
showHelpForComponent(Component component)

指定したcomponentに対するヘルプを表示します。指定したcomponentが、addComponent()を介して登録されていない場合、ヘルプは表示されません。