Oracle Help for Java APIリファレンス
リリース4.2.6.0.0

oracle.help
クラスHelp

java.lang.Object
  |
  +--oracle.help.Help
実装されているすべてのインタフェース
java.util.EventListener、oracle.ewt.help.HelpProvider、oracle.bali.ewt.help.HelpProvider、oracle.help.navigator.NavigatorListener

publicクラスのHelp
java.lang.Objectを拡張します。
oracle.bali.ewt.help.HelpProvider、oracle.ewt.help.HelpProvider、oracle.help.navigator.NavigatorListenerを実装します。

Helpのクラスでは、Oracle Help for Javaコンポーネントを使用したヘルプ・システムがデフォルトで実装されます。 このクラスは、ヘルプ・システムをプログラムによって制御するためのAPIを提供します。 このクラスによってサポートされるAPIは、次のカテゴリに分類できます。

Bookオブジェクト

アプリケーションは、Bookオブジェクトを介してHelpオブジェクトにヘルプのコンテンツを移入します。 Bookオブジェクトには、ヘルプ・システムでアプリケーションのドキュメントの表示に必要な情報が含まれています。 Bookオブジェクトは、作成後いつでもaddBook()メソッドを使用してヘルプ・システムに追加したり、removeBook()メソッドを使用してヘルプ・システムから削除できます。 Booksでサポートされているファイル形式の詳細は、OHJのファイル形式のドキュメントを参照してください。

状況依存ヘルプ

アプリケーションでは、showTopic()メソッドを使用して特定のトピックを表示できます。 アプリケーションのプログラマは、表示するヘルプのコンテンツ・ページのtopicIDを指定します。 このtopicIDは、ヘルプ・システムに追加されたBookから作成されたマージ済マップ・ファイルを介してHTMLページに表示されます。

また、showTopic()メソッドについては、ヘルプ・システムはOracle EWTのHelpProviderインタフェースをサポートしています。 showHelp()メソッドを参照してください。

Helpのユーザー・インタフェース

デフォルトのヘルプ・システムの実装は、次のユーザー・インタフェース要素で構成されます。

このクラスは、これらの各要素の表示状態を操作するAPIを提供します。 また、オプションとしてNavigator引数をshowNavigatorWindowメソッドに渡し、NavigatorWindowに最初に表示するナビゲータを選択します。

交換可能なHTMLブラウザ

Oracle Help for Javaは、交換可能なHTMLブラウザのインタフェースをサポートしています。 アプリケーションは、ヘルプ・トピックの表示用として独自のHTMLBrowserサブクラスを指定できます。 このインタフェースの詳細は、oracle.help.htmlBrowserパッケージを参照してください。 トピックの表示に使用されるデフォルトのHTMLBrowserコンポーネントは、オラクル社が変更したバージョンのICESoftのICEブラウザです。

関連資料:
BookHTMLBrowser

コンストラクタのサマリー
Help()
トピックを表示するHTMLBrowserコンポーネントとしてICEBrowserを使用する、Helpオブジェクトのインスタンスを作成します。
Help(java.applet.AppletContext appletContext, java.lang.String targetFrame)
特定のアプレットのコンテキストを介してトピックを表示するためにネイティブ・ブラウザを使用する、Helpオブジェクトのインスタンスを作成します。
Help(java.applet.AppletContext appletContext, java.lang.String targetFrame, boolean combineBooks, boolean useLabelInfo)
特定のアプレットのコンテキストを介してトピックを表示するためにネイティブ・ブラウザを使用する、Helpオブジェクトのインスタンスを作成します。
Help(boolean combineBooks, boolean useLabelInfo)
トピックを表示するHTMLBrowserコンポーネントとしてICEBrowserを使用する、Helpオブジェクトのインスタンスを作成します。
Help(boolean combineBooks, boolean useLabelInfo, boolean dockedByDefault)
トピックを表示するHTMLBrowserコンポーネントとしてICEBrowserを使用する、Helpオブジェクトのインスタンスを作成します。
Help(java.lang.Class htmlBrowserClass)
トピックを表示するHTMLBrowserコンポーネントとして指定されたブラウザを使用する、Helpオブジェクトのインスタンスを作成します。
Help(java.lang.Class htmlBrowserClass, boolean combineBooks, boolean useLabelInfo)
トピックを表示するHTMLBrowserコンポーネントとして指定されたHTMLBrowserを使用する、Helpオブジェクトのインスタンスを作成します。
Help(java.lang.Class htmlBrowserClass, boolean combineBooks, boolean useLabelInfo, boolean standAloneMode)
トピックを表示するHTMLBrowserコンポーネントとして指定されたHTMLBrowserを使用する、Helpオブジェクトのインスタンスを作成します。
Help(java.lang.Class htmlBrowserClass, boolean combineBooks, boolean useLabelInfo, boolean standAloneMode, boolean dockedByDefault)
トピックを表示するHTMLBrowserコンポーネントとして指定されたHTMLBrowserを使用する、Helpオブジェクトのインスタンスを作成します。

メソッドのサマリー
void addBook(Book book)
bookをヘルプ・システムのライブラリに追加します。
void dispose()
ヘルプ・システムを破棄します。
Navigator[] getAllNavigators()
ナビゲータ・ウィンドウに表示されるナビゲータ・オブジェクトを取得します。
int getBookCount()
現在ヘルプ・システムのライブラリにあるBookオブジェクトの数を返します。
Book[] getBooks()
現在ヘルプ・システムのライブラリにあるすべてのBookオブジェクトを取得します。
static java.lang.String getHelpEncoding()
クライアントのヘルプ・ファイルでの読取り用としてOracle Help for Javaクラスによって使用される、キャラクタ・セットのエンコーディングを取得します。
static java.util.Locale getHelpLocale()
ロケール依存の操作およびリソースのロード用としてOracle Help for Javaクラスによって現在使用されているロケールを取得します。
static void registerClientWindow(java.awt.Window aWindow)
クライアントは、WindowインスタンスをHelpオブジェクトに登録する必要があります。
void registerCustomProtocolHandler(java.lang.String customProtocol, CustomProtocolHandler handler)
CustomProtocolHandlerをカスタム・プロトコルに登録します。HTML <a href="custom:protocolName:protocolValue"/>を考えてみます。OHJはそのリンクをたどるときに、識別子protocolNameとして登録されているCustomProtocolHandlersがあるかどうかをチェックします。 CustomProtocolHandlerが見つかると、protocolValueを値として渡すことにより、handleValueメソッドがコールされます。
void removeAllBooks()
ヘルプ・システムのライブラリからすべてのbookを削除します。
void removeBook(Book book)
ヘルプ・システムからbookを1つ削除します。
void setDefaultBook(Book book)
showHelpメソッドで使用するデフォルトのbookを設定します。
void setDefaultTopicID(java.lang.String topicID)
showHelpメソッドで使用するデフォルトのtopicIDを設定します。
static void setHelpEncoding(java.lang.String helpEncoding)
クライアントのヘルプ・ファイルを読み取るためにOracle Help for Javaクラスによって使用される、キャラクタ・セットのエンコーディングを設定します。
static void setHelpLocale(java.util.Locale helpLocale)
ロケール依存の操作およびリソースのロード用としてOracle Help for Javaクラスによって使用される、ロケールを設定します。
void setHelpOnHelp(Book book, java.lang.String topicID)
有効なbookおよびtopicIDパラメータを使用してこのメソッドをコールすると、ヘルプ・ナビゲータで「ヘルプに関するヘルプ」メニュー・オプションが使用可能になります。
void setHelpOnHelp(java.net.URL helpOnHelpURL)
有効なURLパラメータを使用してこのメソッドをコールすると、ヘルプ・ナビゲータで「ヘルプに関するヘルプ」メニュー・オプションが使用可能になります。
void setIconImage(java.awt.Image iconImage)
このメソッドをコールして、Oracle Help for Javaウィンドウのウィンドウ・アイコンのカスタム・イメージを設定します。
void setVisible(boolean visible)
ヘルプ・システムの可視性を設定します。
void showHelp(java.awt.Component component)
OracleのJEWTツールキットからHelpProviderインタフェースを実装します。
void showHelp(java.lang.Object book, java.lang.String topicID, java.awt.Component object)
OracleのEWTツールキットからHelpProviderインタフェースを実装します。
void showNavigatorWindow()
ナビゲータ・ウィンドウを表示します。
void showNavigatorWindow(Book activeBook)
ナビゲータ・ウィンドウで、最初に表示された特定のBookのNavigatorTabPanelを表示します。
void showNavigatorWindow(Navigator activeNavigator)
特定のナビゲータが最初に表示された状態で、ナビゲータ・ウィンドウを表示します。
void showTopic(Book book, java.lang.String topicID)
現在のトピック・ウィンドウに、指定したbookの指定したトピックを表示します。
void showTopic(Book book, java.lang.String topicID, boolean alwaysCreate)
指定したbookから、指定したトピックを表示します。
void showTopic(Book book, java.lang.String topicID, boolean alwaysCreate, java.awt.Point location, java.awt.Dimension size)
指定したbookから、指定したトピックを表示します。
void topicActivated(oracle.help.navigator.NavigatorEvent e)
NavigatorListenerインタフェースの結果としてのpublicメソッド
void topicSelected(oracle.help.navigator.NavigatorEvent e)
NavigatorListenerインタフェースの結果としてのpublicメソッド
static void unregisterClientWindow(java.awt.Window aWindow)
ウィンドウがアクティブでなくなった場合、クライアントは、registerClientWindow()メソッドを使用して登録された各Windowインスタンスを登録解除する必要があります。

クラスjava.lang.Objectから継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

Help

public Help()
トピックを表示するHTMLBrowserコンポーネントとしてICEBrowserを使用する、Helpオブジェクトのインスタンスを作成します。 Helpの各インスタンスは個別に表示および管理されます。 アプリケーションは、このメソッドを1回だけコールし、後続のコールで使用するHelpリファレンスをキャッシュする必要があります。 このコンストラクタでは、追加されたbookのすべての表示を1つのタブ・パネルに表示し、作成者定義の表示用ラベルを無視して標準のタブ・ラベルを優先するようヘルプ・システムに指示します。
関連資料:
ICEBrowser

Help

public Help(java.lang.Class htmlBrowserClass)
トピックを表示するHTMLBrowserコンポーネントとして指定されたブラウザを使用する、Helpオブジェクトのインスタンスを作成します。 Helpの各インスタンスは個別に表示および管理されます。 アプリケーションは、このメソッドを1回だけコールし、後続のコールで使用するHelpリファレンスをキャッシュする必要があります。 このコンストラクタでは、追加されたbookのすべての表示を1つのタブ・パネルに表示し、作成者定義の表示用ラベルを無視して標準のタブ・ラベルを優先するようヘルプ・システムに指示します。
パラメータ:
htmlBrowserClass: トピック表示コンポーネントとして使用するHTMLBrowserサブクラス。
関連資料:
HTMLBrowser

Help

public Help(java.applet.AppletContext appletContext,
            java.lang.String targetFrame)
特定のアプレットのコンテキストを介してトピックを表示するためにネイティブ・ブラウザを使用する、Helpオブジェクトのインスタンスを作成します。 Helpの各インスタンスは個別に表示および管理されます。 アプリケーションは、このメソッドを1回だけコールし、後続のコールで使用するHelpリファレンスをキャッシュする必要があります。

このコンストラクタでは、追加されたbookのすべての表示を1つのタブ・パネルに表示し、作成者定義の表示用ラベルを無視して標準のタブ・ラベルを優先するようヘルプ・システムに指示します。

アプレットのコンテキストを介してトピックを表示するためにネイティブ・ブラウザを使用すると、多くのOHJのICEブラウザ固有のトピック表示機能(toc同期、ポップアップ、ウィンドウ・タイプ、a-linkなど)が失われることになります。

パラメータ:
appletContext: トピックをネイティブ・ブラウザに表示するためのAppletContext。
targetFrame: トピックを表示するときに使用するネイティブ・ブラウザのターゲット・フレーム名。
関連資料:
AppletContext

Help

public Help(boolean combineBooks,
            boolean useLabelInfo)
トピックを表示するHTMLBrowserコンポーネントとしてICEBrowserを使用する、Helpオブジェクトのインスタンスを作成します。 Helpの各インスタンスは個別に表示および管理されます。 アプリケーションは、このメソッドを1回だけコールし、後続のコールで使用するHelpリファレンスをキャッシュする必要があります。
パラメータ:
combineBooks: trueの場合、ヘルプ・システムに追加されたBookのすべての表示を1つのタブ・パネルに表示します。falseの場合、Bookごとに異なるタブ・パネルが作成されます。
useLabelInfo: trueの場合、表示およびマージの際に作成者定義のラベル情報を使用します。falseの場合、標準のナビゲータ・ラベルを使用します。
関連資料:
HTMLBrowser

Help

public Help(boolean combineBooks,
            boolean useLabelInfo,
            boolean dockedByDefault)
トピックを表示するHTMLBrowserコンポーネントとしてICEBrowserを使用する、Helpオブジェクトのインスタンスを作成します。 Helpの各インスタンスは個別に表示および管理されます。 アプリケーションは、このメソッドを1回だけコールし、後続のコールで使用するHelpリファレンスをキャッシュする必要があります。
パラメータ:
combineBooks: trueの場合、ヘルプ・システムに追加されたBookのすべての表示を1つのタブ・パネルに表示します。falseの場合、Bookごとに異なるタブ・パネルが作成されます。
useLabelInfo: trueの場合、表示およびマージの際に作成者定義のラベル情報を使用します。falseの場合、標準のナビゲータ・ラベルを使用します。
dockedByDefault: trueの場合、ヘルプ・システムは、最初にドッキングされたナビゲータ・ウィンドウおよびトピック・ウィンドウとともに表示されます。
関連資料:
HTMLBrowser

Help

public Help(java.lang.Class htmlBrowserClass,
            boolean combineBooks,
            boolean useLabelInfo)
トピックを表示するHTMLBrowserコンポーネントとして指定されたHTMLBrowserを使用する、Helpオブジェクトのインスタンスを作成します。 Helpの各インスタンスは個別に表示および管理されます。 アプリケーションは、このメソッドを1回だけコールし、後続のコールで使用するHelpリファレンスをキャッシュする必要があります。
パラメータ:
htmlBrowserClass: トピック表示コンポーネントとして使用するHTMLBrowserサブクラス。
combineBooks: trueの場合、ヘルプ・システムに追加されたBookのすべての表示を1つのタブ・パネルに表示します。falseの場合、Bookごとに異なるタブ・パネルが作成されます。
useLabelInfo: trueの場合、表示およびマージの際に作成者定義のラベル情報を使用します。falseの場合、標準のナビゲータ・ラベルを使用します。
関連資料:
HTMLBrowser

Help

public Help(java.lang.Class htmlBrowserClass,
            boolean combineBooks,
            boolean useLabelInfo,
            boolean standAloneMode)
トピックを表示するHTMLBrowserコンポーネントとして指定されたHTMLBrowserを使用する、Helpオブジェクトのインスタンスを作成します。 Helpの各インスタンスは個別に表示および管理されます。 アプリケーションは、このメソッドを1回だけコールし、後続のコールで使用するHelpリファレンスをキャッシュする必要があります。 このコンストラクタには、OHJのスタンドアロン・モードでの実行を有効にする追加のパラメータがあります。このモードでは、すべてのヘルプ・ウィンドウを閉じた時点で、HelpオブジェクトはSystem.exitを介してJVMを終了します。 OHJをJavaアプリケーションから起動する場合は、スタンドアロン・モードをfalseに設定する必要があります(trueに設定した場合、ヘルプを閉じるとアプリケーションが終了します)。
パラメータ:
htmlBrowserClass: トピック表示コンポーネントとして使用するHTMLBrowserサブクラス。
combineBooks: trueの場合、ヘルプ・システムに追加されたBookのすべての表示を1つのタブ・パネルに表示します。falseの場合、Bookごとに異なるタブ・パネルが作成されます。
useLabelInfo: trueの場合、表示およびマージの際に作成者定義のラベル情報を使用します。falseの場合、標準のナビゲータ・ラベルを使用します。
standAloneMode: trueの場合、すべてのヘルプ・ウィンドウを閉じた時点で、ヘルプ・システムはJVMを終了します。 OHJをJavaアプリケーションから起動する場合には、このパラメータをfalseに設定してください。
関連資料:
HTMLBrowser

Help

public Help(java.lang.Class htmlBrowserClass,
            boolean combineBooks,
            boolean useLabelInfo,
            boolean standAloneMode,
            boolean dockedByDefault)
トピックを表示するHTMLBrowserコンポーネントとして指定されたHTMLBrowserを使用する、Helpオブジェクトのインスタンスを作成します。 Helpの各インスタンスは個別に表示および管理されます。 アプリケーションは、このメソッドを1回だけコールし、後続のコールで使用するHelpリファレンスをキャッシュする必要があります。 このコンストラクタには、OHJのスタンドアロン・モードでの実行を有効にする追加のパラメータがあります。このモードでは、すべてのヘルプ・ウィンドウを閉じた時点で、HelpオブジェクトはSystem.exitを介してJVMを終了します。 OHJをJavaアプリケーションから起動する場合は、スタンドアロン・モードをfalseに設定する必要があります(trueに設定した場合、ヘルプを閉じるとアプリケーションが終了します)。
パラメータ:
htmlBrowserClass: トピック表示コンポーネントとして使用するHTMLBrowserサブクラス。
combineBooks: trueの場合、ヘルプ・システムに追加されたBookのすべての表示を1つのタブ・パネルに表示します。falseの場合、Bookごとに異なるタブ・パネルが作成されます。
useLabelInfo: trueの場合、表示およびマージの際に作成者定義のラベル情報を使用します。falseの場合、標準のナビゲータ・ラベルを使用します。
standAloneMode: trueの場合、すべてのヘルプ・ウィンドウを閉じた時点で、ヘルプ・システムはJVMを終了します。 OHJをJavaアプリケーションから起動する場合には、このパラメータをfalseに設定してください。
dockedByDefault: trueの場合、ヘルプ・システムは、最初にドッキングされたナビゲータ・ウィンドウおよびトピック・ウィンドウとともに表示されます。
関連資料:
HTMLBrowser

Help

public Help(java.applet.AppletContext appletContext,
            java.lang.String targetFrame,
            boolean combineBooks,
            boolean useLabelInfo)
特定のアプレットのコンテキストを介してトピックを表示するためにネイティブ・ブラウザを使用する、Helpオブジェクトのインスタンスを作成します。 Helpの各インスタンスは個別に表示および管理されます。 アプリケーションは、このメソッドを1回だけコールし、後続のコールで使用するHelpリファレンスをキャッシュする必要があります。

アプレットのコンテキストを介してトピックを表示するためにネイティブ・ブラウザを使用すると、多くのOHJのICEブラウザ固有のトピック表示機能(toc同期、ポップアップ、ウィンドウ・タイプ、a-linkなど)が失われることになります。

パラメータ:
appletContext: トピックをネイティブ・ブラウザに表示するためのAppletContext。
targetFrame: トピックを表示するときに使用するネイティブ・ブラウザのターゲット・フレーム名。
combineBooks: trueの場合、ヘルプ・システムに追加されたBookのすべての表示を1つのタブ・パネルに表示します。falseの場合、Bookごとに異なるタブ・パネルが作成されます。
useLabelInfo: trueの場合、表示およびマージの際に作成者定義のラベル情報を使用します。falseの場合、標準のナビゲータ・ラベルを使用します。
関連資料:
AppletContext

メソッドの詳細

setHelpLocale

public static void setHelpLocale(java.util.Locale helpLocale)
ロケール依存の操作およびリソースのロード用としてOracle Help for Javaクラスによって使用される、ロケールを設定します。 重要な点は、このメソッドは、Helpオブジェクトまたは任意のBookオブジェクトが作成される前にコールする必要があることです。ロケールが設定されていない、またはnullに設定されている場合、Oracle Help for Javaではシステムのデフォルトのロケールが使用されます。

ほとんどのクライアントでは、システムのデフォルトのロケール(エンド・ユーザーのオペレーティング・システムで選択されているロケール)が使用されます。この場合、このメソッドをコールする必要はありません。

パラメータ:
helpLocale: ロケールがnullに設定されている場合、システムのデフォルトのロケールが使用されます。

getHelpLocale

public static java.util.Locale getHelpLocale()
ロケール依存の操作およびリソースのロード用としてOracle Help for Javaクラスによって現在使用されているロケールを取得します。

oracle.help.common.util.StaticLocaleContext.getLocale()用の有用なラッパーです。


setHelpEncoding

public static void setHelpEncoding(java.lang.String helpEncoding)
クライアントのヘルプ・ファイルを読み取るためにOracle Help for Javaクラスによって使用される、キャラクタ・セットのエンコーディングを設定します。 重要な点は、このメソッドは、任意のBookオブジェクトが作成される前にコールする必要があることです。キャラクタ・セットのエンコーディングが設定されていない、またはnullに設定されている場合、Oracle Help for Javaではデフォルト・ロケールのデフォルト・エンコーディングが使用されます。

ほとんどのクライアントでは、デフォルト・ロケールのデフォルト・エンコーディング(エンド・ユーザーのオペレーティング・システムで選択されているロケール)が使用されます。この場合、このメソッドをコールする必要はありません。

パラメータ:
helpEncoding: Javaでサポートされているキャラクタ・セットのエンコーディング名。

getHelpEncoding

public static java.lang.String getHelpEncoding()
クライアントのヘルプ・ファイルでの読取り用としてOracle Help for Javaクラスによって使用される、キャラクタ・セットのエンコーディングを取得します。 nullが返された場合、システムのデフォルト・ロケールのデフォルト・エンコーディングが使用されていることを示します。

setIconImage

public void setIconImage(java.awt.Image iconImage)
このメソッドをコールして、Oracle Help for Javaウィンドウのウィンドウ・アイコンのカスタム・イメージを設定します。
パラメータ:
iconImage: Oracle Help for Javaのウィンドウのアイコンとして使用するイメージ。

setVisible

public void setVisible(boolean visible)
ヘルプ・システムの可視性を設定します。
パラメータ:
visible: trueの場合、ナビゲータ・ウィンドウが表示されます。falseの場合、ヘルプ・システムでは、ナビゲータ・ウィンドウとすべてのトピック・ウィンドウが非表示になります。

addBook

public void addBook(Book book)
bookをヘルプ・システムのライブラリに追加します。
パラメータ:
book: ヘルプ・システムのライブラリに追加するbook。

removeBook

public void removeBook(Book book)
ヘルプ・システムからbookを1つ削除します。
パラメータ:
book: ヘルプ・システムのライブラリから削除するbook。

removeAllBooks

public void removeAllBooks()
ヘルプ・システムのライブラリからすべてのbookを削除します。

getBooks

public Book[] getBooks()
現在ヘルプ・システムのライブラリにあるすべてのBookオブジェクトを取得します。
戻り値:
Book[] the books

getBookCount

public int getBookCount()
現在ヘルプ・システムのライブラリにあるBookオブジェクトの数を返します。
戻り値:
int the book count

registerClientWindow

public static void registerClientWindow(java.awt.Window aWindow)
クライアントは、WindowインスタンスをHelpオブジェクトに登録する必要があります。 これにより、Helpオブジェクトは、登録されているウィンドウのうちアクティブなウィンドウ(存在する場合)を追跡できるようになります。 アクティブ・ウィンドウがモーダル・ダイアログであり、そこからHelpを要求した場合、Helpオブジェクトは、ヘルプ・ウィンドウがアクティブなモーダル・ダイアログにブロックされないように特別な動作をします。 Oracleのルック・アンド・フィール/JEWTツールキットのユーザーは、このメソッドを明示的にコールする必要はありません。
パラメータ:
aWindow: 登録するWindowインスタンス。

unregisterClientWindow

public static void unregisterClientWindow(java.awt.Window aWindow)
ウィンドウがアクティブでなくなった場合、クライアントは、registerClientWindow()メソッドを使用して登録された各Windowインスタンスを登録解除する必要があります。 ウィンドウを登録解除しないと、そのウィンドウはガベージ・コレクションの対象になりません。
パラメータ:
aWindow: 登録解除するWindow。

registerCustomProtocolHandler

public void registerCustomProtocolHandler(java.lang.String customProtocol,
                                          CustomProtocolHandler handler)
CustomProtocolHandlerをカスタム・プロトコルに登録します。HTML <a href="custom:protocolName:protocolValue"/>を考えてみます。OHJはそのリンクをたどるとき、識別子protocolNameとして登録されているCustomProtocolHandlersがあるかどうかをチェックします。 CustomProtocolHandlerが見つかると、protocolValueを値として渡すことにより、handleValueメソッドがコールされます。

showNavigatorWindow

public void showNavigatorWindow()
ナビゲータ・ウィンドウを表示します。

showNavigatorWindow

public void showNavigatorWindow(Navigator activeNavigator)
特定のナビゲータが最初に表示された状態で、ナビゲータ・ウィンドウを表示します。
パラメータ:
activeNavigator: 最初に表示するナビゲータ。パラメータがnullである場合、前に選択したナビゲータが表示された状態でナビゲータ・ウィンドウが表示されます。

showNavigatorWindow

public void showNavigatorWindow(Book activeBook)
ナビゲータ・ウィンドウで、最初に表示された特定のBookのNavigatorTabPanelを表示します。 combineBooksフラグがfalseに設定された状態でHelpオブジェクトが作成された場合、Helpオブジェクトに追加されたbookごとに異なるNavigatorTabPanelが作成されています。 showNavigatorWindowメソッドのこのバージョンを使用すると、最初に表示するBookのタブ・パネルを選択できます。

combineBooksフラグがtrueに設定された状態でHelpオブジェクトが作成された場合、パラメータとして渡されるbookとは関係なく唯一のタブ・パネルが表示されます。

パラメータ:
activeBook: ナビゲータ・ウィンドウの表示で、関連付けられたNavigatorTabPanelが最初に表示されるBookオブジェクト。 Bookはヘルプ・システムにすでに追加されている必要があります。追加されていないか、パラメータがnullである場合、前に選択したNavigatorTabPanelが最初に表示されます。

getAllNavigators

public Navigator[] getAllNavigators()
ナビゲータ・ウィンドウに表示されるナビゲータ・オブジェクトを取得します。

showTopic

public void showTopic(Book book,
                      java.lang.String topicID)
               throws oracle.help.topicDisplay.TopicDisplayException
現在のトピック・ウィンドウに、指定したbookの指定トピックを表示します。 現在トピック・ウィンドウが開かれていない場合は、デフォルトのサイズを持つ新規のウィンドウが作成されます。
パラメータ:
book: 表示するトピックを含むbook。
topicID: 表示するトピックのtopicID。
スロー:
oracle.help.topicDisplay.TopicDisplayException: 指定したトピックを表示できない場合。

showTopic

public void showTopic(Book book,
                      java.lang.String topicID,
                      boolean alwaysCreate)
               throws oracle.help.topicDisplay.TopicDisplayException
指定したbookから、指定したトピックを表示します。 alwaysCreateがtrueの場合、常に新規のウィンドウが作成されます。falseの場合、現在ウィンドウが存在しない場合にのみ新規のウィンドウが作成されます。
パラメータ:
book: 表示するトピックを含むbook。
topicID: 表示するトピックのtopicID。
alwaysCreate: trueの場合、常に新規のウィンドウが作成されます。falseの場合、可能であればウィンドウを再利用します。
スロー:
oracle.help.topicDisplay.TopicDisplayException: 指定したトピックを表示できない場合。

showTopic

public void showTopic(Book book,
                      java.lang.String topicID,
                      boolean alwaysCreate,
                      java.awt.Point location,
                      java.awt.Dimension size)
               throws oracle.help.topicDisplay.TopicDisplayException
指定したbookから、指定したトピックを表示します。 alwaysCreateがtrueの場合、常に新規のウィンドウが作成されます。falseの場合、現在ウィンドウが存在しない場合にのみ新規のウィンドウが作成されます。
パラメータ:
book: 表示するトピックを含むbook。
topicID: 表示するトピックのtopicID。
alwaysCreate: trueの場合、常に新規のウィンドウが作成されます。falseの場合、可能であればウィンドウを再利用します。
location: トピック・ウィンドウの位置。
size: トピック・ウィンドウのサイズ。
スロー:
oracle.help.topicDisplay.TopicDisplayException: 指定したトピックを表示できない場合。

showHelp

public void showHelp(java.lang.Object book,
                     java.lang.String topicID,
                     java.awt.Component object)
OracleのEWTツールキットからHelpProviderインタフェースを実装します。 次の例外を除いて、これはshowTopicと同じように動作します。
指定条件:
oracle.ewt.help.HelpProviderインタフェースのshowHelp
パラメータ:
book: 表示するトピックを含むbook。
topic: 表示するトピックのtopicID。
object: ヘルプが表示されているコンポーネント。 コンポーネントが関係していない場合、nullを渡します。

showHelp

public void showHelp(java.awt.Component component)
OracleのJEWTツールキットからHelpProviderインタフェースを実装します。 Oracle OHJのユーザー以外は、このメソッドを使用しないでください。 JEWTのHelpUtilsクラスを使用して、コンポーネントのBookおよびtopicIDを識別します。 コンポーネントにtopicIDが関連付けられていない場合、ナビゲータ・ウィンドウが表示されます。
指定条件:
oracle.bali.ewt.help.HelpProviderインタフェースのshowHelp
パラメータ:
component: ヘルプが表示されているコンポーネント。

setHelpOnHelp

public void setHelpOnHelp(java.net.URL helpOnHelpURL)
有効なURLパラメータを使用してこのメソッドをコールすると、ヘルプ・ナビゲータで「ヘルプに関するヘルプ」メニュー・オプションが使用可能になります。 メニュー・オプションを選択すると、指定したURLのHTMLページがトピック・ウィンドウに表示されます。
パラメータ:
helpOnHelpURL: 「ヘルプに関するヘルプ」を表示するためのHTMLページのURL。

setHelpOnHelp

public void setHelpOnHelp(Book book,
                          java.lang.String topicID)
有効なbookおよびtopicIDパラメータを使用してこのメソッドをコールすると、ヘルプ・ナビゲータで「ヘルプに関するヘルプ」メニュー・オプションが使用可能になります。 メニュー・オプションを選択すると、このtopicIDにマップされているヘルプ・トピックがトピック・ウィンドウに表示されます。
パラメータ:
book: ヘルプに関するヘルプ・トピックが含まれるBook(このBookはヘルプ・システムに追加されている必要があります)。
topicID: 「ヘルプに関するヘルプ」を表示するヘルプ・トピックのトピックID。

setDefaultBook

public void setDefaultBook(Book book)
showHelpメソッドで使用するデフォルトのbookを設定します。 このbookは、nullのbookがshowHelpに渡されるときに使用されます。
パラメータ:
book: デフォルトとして使用するbook。

setDefaultTopicID

public void setDefaultTopicID(java.lang.String topicID)
showHelpメソッドで使用するデフォルトのtopicIDを設定します。 このトピックは、nullのtopicIDがshowHelpに渡されるときに使用されます。
パラメータ:
topicID: デフォルトとして使用するtopicID。

dispose

public void dispose()
ヘルプ・システムを破棄します。このメソッドにより、ヘルプ・システムで使用されていたすべてのリソースが解放されます。アプリケーションでは、ヘルプが不要になった時点でこのメソッドをコールする必要があります。 dispose()をコールした後には、Helpオブジェクトでメソッドをコールしないでください。

topicSelected

public void topicSelected(oracle.help.navigator.NavigatorEvent e)
NavigatorListenerインタフェースの結果としてのpublicメソッド。 ナビゲータ・ウィンドウでトピックが選択されている場合、内部フックがコールされます。
指定条件:
oracle.help.navigator.NavigatorListenerインタフェースのtopicSelected

topicActivated

public void topicActivated(oracle.help.navigator.NavigatorEvent e)
NavigatorListenerインタフェースの結果としてのpublicメソッド。 ナビゲータ・ウィンドウでトピックがアクティブである場合、内部フックがコールされます。
指定条件:
oracle.help.navigator.NavigatorListenerインタフェースのtopicActivated

HELP ${project.version}

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