Installing OHJDK Contents of an OHJDK Release

14-2 Oracle Fusion Middleware Developers Guide for Oracle Help same label, OHJ displays one keyword index navigator tab with a merged, sorted list of keywords. If the combineBooks parameter is set to false, the views from each book are displayed separately, and the end user can select which book to display using a drop-down list in the OHJ navigator window. The versions of the Help object constructor are summarized below. For more information on API documentation of oracle.help.Help , see Section 13.2.2, Contents of an OHJDK Release . Table 14–1 Help Constructors Constructor Description Help Creates an instance of the Help object with the ICEBrowser as the HTMLBrowser component used for topic display. This constructor will instruct the help system to show all of the views from the added books in one tab panel, and to ignore author defined tab labels in favor of standard tab labels. Helpboolean combineBooks, boolean useLabelInfo Creates an instance of the Help object with the ICEBrowser as the HTMLBrowser component used for topic display. Parameters: ■ combineBooks – If true, the help system shows all of the views from the books added to the help system in one tab panel. If false, the help system creates a different tab panel for each book and allows the end user to choose which book is displayed. ■ useLabelInfo – If true, the help system uses the author-defined label information for display and view merging. If false, the help system uses default labels. HelpClass htmlBrowserClass, boolean combineBooks, boolean useLabelInfo Creates an instance of the Help object using the specified HTMLBrowser component for topic display. The ICEBrowser is the only HTMLBrowser subclass currently distributed with OHJ. Parameters: ■ htmlBrowserClass – The HTMLBrowser subclass to use as the topic display component ■ combineBooks – If true, the help system shows all of the views from the books added to the help system in one tab panel. If false, the help system creates a different tab panel for each book and allows the end user to choose which book is displayed. ■ useLabelInfo – If true, the help system uses the author-defined label information for display and view merging. If false, the help system uses default labels. Adding OHJ to Your Application 14-3

14.3 Adding the Help Data

After creating a Help object, you must add one or more Book objects to it. A Book object encapsulates a collection, or book, of help content. The HelpSet book implementation handles the preferred Oracle Help file formats, as documented in Oracle Help File Formats. These files include the helpset file, which defines the characteristics of the help system. The following sections describe how to add the help sets, and other optional features: ■ Section 14.3.1, Constructing a HelpSet ■ Section 14.3.2, Adding Books to Help

14.3.1 Constructing a HelpSet

The Table 14–2 lists HelpSet constructors: HelpClass htmlBrowserClass, boolean combineBooks, boolean useLabelInfo, boolean standAloneMode Creates an instance of the Help object using the specified HTMLBrowser component for topic display. The ICEBrowser is the only HTMLBrowser subclass currently distributed with OHJ. This constructor contains an extra parameter enabling a stand-alone mode for running OHJ, where the Help object will exit the JVM via System.exit once all help windows have been closed. The standAloneMode parameter should be set to false if you are launching OHJ from a Java application otherwise closing help would exit your application. Parameters: ■ htmlBrowserClass – The HTMLBrowser subclass to use as the topic display component ■ combineBooks – If true, the help system shows all of the views from the books added to the help system in one tab panel. If false, the help system creates a different tab panel for each book and allows the end user to choose which book is displayed. ■ useLabelInfo – If true, the help system uses the author-defined label information for display and view merging. If false, the help system uses standard default labels. ■ standAloneMode – If true, the help system exits the JVM when all help windows have been closed. Set this to false if you are launching OHJ from your Java application. Table 14–2 HelpSet Constructors Constructor Description HelpSetURL fileURL Constructs a HelpSet object using the helpset file at the specified URL location. Use this constructor when you know the exact location of the helpset file. Parameters: ■ fileURL – A URL specifying the exact location of the helpset file. Table 14–1 Cont. Help Constructors Constructor Description