ヘルプ・システムについて

ユーザー・インタフェース・パネルを使用するウィザードおよびその他の拡張機能では、インタフェースの使用方法について説明するドキュメントにアクセスできる必要があります。通常、ユーザーは、ウィザードまたはダイアログのパネルの「ヘルプ」ボタンをクリックするか、[F1]キーを押してヘルプにアクセスします。

ヘルプ・システムはHelpSystemクラスのシングルトン・インスタンスで、getHelpSystemメソッドにより取得されます。 ヘルプ・システムのメソッドにより、プログラムでヘルプ・ビューアが開き、指定されたヘルプ・トピックを表示します。 ヘルプ・トピックは、JDeveloperのdoc/ohjフォルダ内のアーカイブ・ファイル(.jarおよび.zip)にあります。アーカイブは、Oracle Help for Java(OHJ)標準に準拠しています。アーカイブには、少なくとも次のものが含まれている必要があります。

HelpSystemクラスは、ヘルプ・トピックを起動するための様々な方法を提供します。 最も直接的な方法は、次のようにgoToメソッドをコールすることです。

HelpSystem.getHelpSystem().goTo( "topic_id" );         

topic_idはヘルプ・システムのアーカイブで指定されたトピックIDです。 このコールによりヘルプ・ビューアが開き、topic_idに関連付けられたファイルが表示されます。 ただし、goToを起動するUIイベントを処理するコードを指定する必要があります。 BaliWizardPanelを実装するウィザードのUIコンポーネントでは、UIイベントを内部的に処理するより簡単なメカニズムを使用できます。 HelpSystem registerTopicメソッドは、パネルをマップIDに関連付けます。次に例を示します。


protected BaliWizardPanel buildPanel( Context context, BaliWizardState state )
{
  ImplementIfacePanel panel = new ImplementIfacePanel();
  HelpSystem.getHelpSystem().registerTopic( panel, "f1_idedimplementinterface_html" );
  return panel;
}
        

Baliウィザード・パネルには「ヘルプ」ボタンがあり、[F1]キーストロークに依存しています。ユーザーがこれらのUI要素のいずれかを起動すると、関連付けられたヘルプ・トピックが表示されます。


JDeveloperの拡張機能について
ヘルプ・システムへのアクセス
Oracle Helpの概要

oracle.ide.Ide
oracle.ide.help.HelpSystem
oracle.ide.wizard.BaliWizardPanel

 

Copyright © 1997, 2004, Oracle. All rights reserved.