org.opa.help
Class OPADefaultHelpManager

java.lang.Object
  org.opa.help.OPADefaultHelpManager

All Implemented Interfaces:

OPAHelpManager, OPAManager

public class OPADefaultHelpManager

extends java.lang.Object

implements OPAHelpManager

Constructor Summary

OPADefaultHelpManager()
Creates a new instance of OPADefaultHelpManager

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	load() Loads the OPAManager.
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.
void	start() Starts the OPAXXXManager service.
void	stop() Stops the OPAXXXManager service.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OPADefaultHelpManager

public OPADefaultHelpManager()

Creates a new instance of OPADefaultHelpManager

Method Detail

addHelpSet

public void addHelpSet(javax.help.HelpSet helpSet)

Description copied from interface: OPAHelpManager

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.

Specified by:

addHelpSet in interface OPAHelpManager

enableContextHelpButton

public void enableContextHelpButton(java.awt.Component button)

Description copied from interface: OPAHelpManager

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.

Specified by:

enableContextHelpButton in interface OPAHelpManager

enableContextHelpButton

public void enableContextHelpButton(javax.swing.JMenuItem button)

Description copied from interface: OPAHelpManager

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.

Specified by:

enableContextHelpButton in interface OPAHelpManager

enableHelpButton

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

Description copied from interface: OPAHelpManager

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.

Specified by:

enableHelpButton in interface OPAHelpManager

enableHelpButton

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

Description copied from interface: OPAHelpManager

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.

Specified by:

enableHelpButton in interface OPAHelpManager

load

public void load()

Description copied from interface: OPAManager

Loads the OPAManager. This should be used to set-up and install any OPA services needed. For example, OPAOption panels needed by this OPAManager should be added to OPA here. This method is called before start().

Specified by:

load in interface OPAManager

setHelpID

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

Description copied from interface: OPAHelpManager

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

Specified by:

setHelpID in interface OPAHelpManager

setWindowHelp

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

Description copied from interface: OPAHelpManager

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".

Specified by:

setWindowHelp in interface OPAHelpManager

showHelp

public void showHelp(java.lang.String id)

Description copied from interface: OPAHelpManager

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

Specified by:

showHelp in interface OPAHelpManager

start

public void start()

Description copied from interface: OPAManager

Starts the OPAXXXManager service. This should be used to restore any state (if necessary).

Specified by:

start in interface OPAManager

stop

public void stop()

Description copied from interface: OPAManager

Stops the OPAXXXManager service. This should be used to save any state (if necessary).

Specified by:

stop in interface OPAManager