com.tplan.robot
Interface HelpDispatcher

All Known Implementing Classes:

CustomHelpBroker, DefaultHelpBroker, HelpManager

public interface HelpDispatcher

Interface declaring methods of a dispatcher able to map help keys onto help topics and display them in an appropriate GUI component (such as the JavaHelp window or a web/HTML browser).

T-Plan Robot Enterprise, (C) 2009-2012 T-Plan Limited. All rights reserved.

Method Summary

void	contextShow(ActionEvent e) Show contextual help of a component.
void	init(Component owner) Initialize the help dispatcher for the given GUI component.
void	initComponentHelpIds() Initialize the default set of contextual help IDs.
boolean	isContextualHelpSupported() Define whether the contextual help is supported by the dispatcher or not.
boolean	isHelpAvailable() Indicates whether the dispatcher has succeeded to find any help topics or not.
void	setHelpId(JComponent component, String helpId) Set help ID of a GUI component to enable contextual help.
void	show(String helpID, Component owner, Boolean modal) Show the help topic associated with the specified ID (help key).

Method Detail

init

void init(Component owner)

Initialize the help dispatcher for the given GUI component. This method will be called once when the main GUI is created.

Parameters:

owner - default owner for the help window (this makes sense only when the help window is a Java one).

setHelpId

void setHelpId(JComponent component,
               String helpId)

Set help ID of a GUI component to enable contextual help. This method should be implemented only if contextual help is enabled (the isContextualHelpSupported() method returns true). The contextual help is a feature allowing to set on the "Contextual Help" tool bar button and then click onto a GUI component to display its help topic.

Parameters:

component - a GUI component.

helpId - help ID to be associated with the GUI component.

show

void show(String helpID,
          Component owner,
          Boolean modal)

Show the help topic associated with the specified ID (help key).

Parameters:

helpID - topic ID (help key).

owner - optional window owner.

modal - modality mode (makes sense only when the help window is a Java one).

isContextualHelpSupported

boolean isContextualHelpSupported()

Define whether the contextual help is supported by the dispatcher or not. The contextual help is a feature allowing to set on the "Contextual Help" tool bar button and then click onto a GUI component to display its help topic.

Returns:

true if contextual help is supported, false if not.

isHelpAvailable

boolean isHelpAvailable()

Indicates whether the dispatcher has succeeded to find any help topics or not. GUI components should call this method and disable their Help buttons if it returns false.

Returns:

true if help is available, false if not.

initComponentHelpIds

void initComponentHelpIds()

Initialize the default set of contextual help IDs. This method should be implemented only if contextual help is enabled (the isContextualHelpSupported() method returns true).

contextShow

void contextShow(ActionEvent e)

Show contextual help of a component. This method should be implemented only if contextual help is enabled (the isContextualHelpSupported() method returns true).

Parameters:

e - action event originating from the "Contextual Help" tool bar button.