状況依存ヘルプを実装するためのCSHManager
の使用方法
OHJのCSHManager
クラスでは、ヘルプ・トピックをユーザー・インタフェースのコントロールに関連付け、エンド・ユーザーが[F1]キーを押すか、またはポップアップ・メニューの「ヘルプ」を選択したときに、状況依存ヘルプを起動する一般的な方法が提供されています。また、あるコンポーネントに関連付けられたヘルプ・トピックを明示的に表示するためのAPIも用意されています。
次の各項では、CSHManager
の使用方法の概要について説明します。詳細は、APIのドキュメントのoracle.help.CSHManager
を参照してください。
CSHManager
の構築
ユーザー・インタフェースのコンポーネントを作成する前に、CSHManager
クラスのインスタンスを構築する必要があります。CSHManager
コンストラクタについて、次にまとめます。
-
CSHManager(Help help)
-
CSHManager クラスの新規インスタンスを構築します。このマネージャ・オブジェクトに対する後続のすべてのコールでは、指定したHelp オブジェクトを使用します。
パラメータ:
help - ヘルプの表示に使用されるHelp オブジェクト。
|
デフォルトのBook
の定義
ヘルプのコンテンツのBook
が1つのみの場合、setDefaultBook()
メソッドを使用して、それを状況依存ヘルプのデフォルトのBookとして定義することができます。これによって、book
パラメータを入力せずに、addComponent()
メソッド(後述)がコールできます。
-
setDefaultBook(Book book )
-
指定したBook を、デフォルトのBook として定義します。これは、Book を指定せずに登録されたコンポーネントのデフォルトのBook として使用されます。
パラメータ:
book - 設定するBook 。
|
複数のBook
がある場合は、特定のBook
を割り当てていないコンポーネントに対してのみ、デフォルトのBook
が使用されます。複数のBook
があるヘルプ・システムでは、通常、特定のBook
をコンポーネントに割り当ててください。
トピックIDとユーザー・インタフェース・コンポーネントの関連付け
addComponent()
メソッドは、トピックID(マップ・ファイルで定義)をJavaユーザー・インタフェースのコンポーネントに関連付けるために使用します。状況依存ヘルプが必要な各コンポーネントに対して、次のいずれかのメソッドをコールします。
-
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 の場合、右クリックで「ヘルプ」のポップアップ・メニューが表示され、「ヘルプ」を選択すると状況依存ヘルプが起動します。
|
コンポーネントに対するヘルプの明示的な表示
コンポーネントに関連付けられたヘルプ・トピックを明示的に表示する場合は、CSHManager
でshowHelpForComponent()
メソッドをコールします。たとえば、ユーザーがダイアログ・ボックスの「ヘルプ」ボタンを押したときに状況依存ヘルプを起動する場合、そのボタンのイベント・ハンドラでこのメソッドをコールします。
-
showHelpForComponent(Component component)
-
指定したcomponent に対するヘルプを表示します。指定したcomponent が、addComponent() を介して登録されていない場合、ヘルプは表示されません。
|
Copyright © 1996, 2004, Oracle. All rights reserved.