15-2 Oracle Fusion Middleware Developers Guide for Oracle Help
class. This help manager provides a way to associate help topics with user interface components and to enable F1 and right-click context-sensitive help.
15.3 Using CSHManager to Implement Context-Sensitive Help
OHJs CSHManager class provides a generic way to associate help topics with user interface controls and to launch context-sensitive help when the end user presses the
F1 key or selects Help from a right-click context menu. OHJ also provides an API for explicitly displaying the help topic associated with a component.
The following sections provide an introduction to using CSHManager:
■
Section 15.3.1, CSHManager Constructors
■
Section 15.3.2, Setting the Default Book
■
Section 15.3.3, Associating Topic IDs with User Interface Components
■
Section 15.3.4, Explicitly Showing Help for Components
15.3.1 CSHManager Constructors
You should create an instance of the CSHManager class before creating user interface components. The CSHManager constructor is summarized in
Table 15–1 .
15.3.2 Setting the Default Book
If you only have one Book of help content, you may want to use the setDefaultBook method to define it as the default book for context-sensitive
help. This allows you to call the addComponent method without entering the book parameter.
If you have more than one Book, the default Book will only be used for those components for which you have not assigned a specific Book. In a multiple Book help
system, you should, in general, assign specific Books to your components.
Table 15–1 CSHManager Constructors
Constructor Description
CSHManagerHelp help Creates a new instance of the CSHManager class. All subsequent calls to this manager object will use the specified Help object.
Parameters:
■
help – The Help object to be used for displaying help.
Table 15–2 setDefaultBook Constructors
Constructor Description
setDefaultBookBook book
Sets the specified Book as the default Book. This will be as used the default Book for components registered without a specified
Book. Parameters:
■
book – The Book to be set.
Enabling Context-Sensitive Help in Your Application 15-3
15.3.3 Associating Topic IDs with User Interface Components
Use the addComponent method to associate topic IDs, as defined in the map file, with Java user interface components. You can call one of the versions of this method
for each component that requires context-sensitive help.
Table 15–3 addComponent Constructors
Constructor Description
addComponentComponen t component, String
topicId Registers a component with the help manager.
The default Book is used for looking up the topicId. If no default Book is registered at the time of calling this method, then the
component is not registered with the help manager, and help will not be shown if showHelpForComponent is later called
for this component.
For components registered using this method, CSHManager will not display help in response to an F1 key press or a right
mouse-click event. Parameters:
■
component – The component to be added.
■
topicId – The topic ID to associate with this component. addComponentComponen
t component, Book book, String topicId
Registers a component with the help manager. The provided book is used for looking up the topicId.
For components registered using this method, CSHManager will not display help in response to an F1 key press or right
mouse-click event. Parameters:
■
component – The component to be added.
■
book – The Book containing the help topic.
■
topicId – The topic ID to associate with this component. addComponentComponen
t component, String topicId, boolean
needF1Help, boolean needPopupHelp
The default Book is used for looking up the topicId. If no default Book is registered at the time of calling this method, the
component is not registered with the help manager, and help will not be shown if showHelpForComponent is later called
for this component.
Parameters:
■
component – The component to be added.
■
topicId – The topic ID to associate with this component.
■
needF1Help – If true, displays help for this component in response to F1 key press events.
■
needPopupHelp – If true, displays a Help pop-up menu upon right mouse click and launches context-sensitive help
if the Help menu item is selected.
