ヘルプ・システムへのアクセス

ウィザードでは、インタフェースの使用方法を説明するドキュメントへのアクセスを提供する必要があります。通常、ユーザーは、ウィザードまたはウィザードのパネルの「ヘルプ」ボタンをクリックするか、[F1]キーを押してヘルプにアクセスします。

ウィザードからヘルプ・システムにアクセスするには、次のようにします。

  1. ウィザードのドキュメントを含むヘルプセット(.jarアーカイブ)を作成します。
    1. ウィザードの各パネルについて、パネルを説明するHTMLトピック・ファイルを作成します。
    2. ヘルプセットのマップ制御ファイルを作成します。
    3. 目次にドキュメントを表示する場合、目次索引の制御ファイルを作成します。
    4. ヘルプセット.hs)制御ファイルを作成します。
    5. 索引ファイルの作成には、必要に応じてOHJ Authoring Wizardを使用します。(OHJ Authoring Wizardは、Oracle Help for Java Developer's Kitのコンポーネントです。)
    6. トピック・ファイルと制御ファイルを、JARアーカイブにアセンブルします。アーカイブのルート名は、Hsファイルと同じ名前とし、Hsファイルでアーカイブのルート・ディレクトリを置き換える必要があります。
  2. ウィザードをBaliウィザードとして実装します。
    1. ウィザードのパネルを、JPanel(またはJComponentの他のサブクラス)を拡張するBaliWizardPanelインスタンスとして実装します。
    2. 各パネルについて、トピックIDを登録するためのregisterTopicのコールを指定します。たとえば、ウィザードのパネルの名前がpanelで、そのドキュメントのトピックIDがtopicの場合、コールは次のようになります。
      Ide.getHelpSystem().registerTopic((JComponent)panel(), topic);
  3. ウィザードを自動ロードの .jarファイルとしてデプロイすると、ヘルプセットのJarアーカイブがデプロイメントに含まれます。

続いてウィザードをJDeveloperにインストールし、JDeveloperを起動すると、ウィザードとそのドキュメントが表示されます。


「新規」ギャラリのウィザードの開発
ヘルプ・システムについて
Wizardインタフェースの実装
拡張機能アーカイブのインストール
Oracle Help for Javaの概要

oracle.ide.help.HelpSystem
oracle.ide.wizard.BaliWizardPanel
javax.swing.JPanel
javax.swing.JComponent