org.opa.core
Interface OPAHelpManager

All Superinterfaces:

OPAManager

All Known Implementing Classes:

OPADefaultHelpManager

public interface OPAHelpManager

extends OPAManager

Method Summary

void	addHelpSet(javax.help.HelpSet helpSet) Adds a HelpSet to the application master HelpSet.
void	enableContextHelpButton(java.awt.Component button) Registers a Component as a context-sensitive help agent.
void	enableContextHelpButton(javax.swing.JMenuItem button) Registers a JMenuItem as a context-sensitive help agent.
void	enableHelpButton(java.awt.Component button, java.lang.String id) Registers a Component with a Map ID.
void	enableHelpButton(javax.swing.JMenuItem button, java.lang.String id) Registers a JMenuItem with a Map ID.
void	setHelpID(java.awt.Component component, java.lang.String id) Registers this Component with a help ID.
void	setWindowHelp(java.awt.Component component, java.lang.String id) Registers default help for this Component.
void	showHelp(java.lang.String id) Causes help information referenced by "id", to be shown.

Methods inherited from interface org.opa.core.OPAManager

load, start, stop

Method Detail

addHelpSet

public void addHelpSet(javax.help.HelpSet helpSet)

Adds a HelpSet to the application master HelpSet. This will become visible from the applications help system. Also, help information included in (the HTML files referenced by) the HelpSet can be used in other context-sensitive OPAHelp functions.

enableHelpButton

public void enableHelpButton(javax.swing.JMenuItem button,
                             java.lang.String id)

Registers a JMenuItem with a Map ID. This is used by OPAHelpManager implementations to find the appropriate help in response to some user actions. This should be used to display general help, not for explaining this JButton.

enableHelpButton

public void enableHelpButton(java.awt.Component button,
                             java.lang.String id)

Registers a Component with a Map ID. This is used by OPAHelpManager implementations to find the appropriate help in response to some user actions. This should be used to display general help, not for explaining this Component.

enableContextHelpButton

public void enableContextHelpButton(javax.swing.JMenuItem button)

Registers a JMenuItem as a context-sensitive help agent. When a user chooses this item, she can select help on any visible GUI component (help must be supplied for it). This is used by OPAHelpManager implementations to find the appropriate help in response to some user actions.

enableContextHelpButton

public void enableContextHelpButton(java.awt.Component button)

Registers a Component as a context-sensitive help agent. When a user presses this item, she can select help on any visible GUI component (help must be supplied for it). This is used by OPAHelpManager implementations to find the appropriate help in response to some user actions.

setHelpID

public void setHelpID(java.awt.Component component,
                      java.lang.String id)

Registers this Component with a help ID. This ID is used when displying help.

setWindowHelp

public void setWindowHelp(java.awt.Component component,
                          java.lang.String id)

Registers default help for this Component. THis should be the root pane of a JFrame or JDialog. Typically, this would be OPAPanel classes that are used to create OPADialog objects. OPAHelpManager instances catch F1 presses (provided the focuessed Component and other components between it and the OPAPanel in the hierachy dont catch the KeyEvent first) and then display the help information specified in "id".

showHelp

public void showHelp(java.lang.String id)

Causes help information referenced by "id", to be shown.