com.sssw.rt.form
Interface AgiHelpProcessor

public interface AgiHelpProcessor

Interface for containers that wish to process help requests made via the F1 key using their own custom help mechanism.

AgiHelpProcessor allows containers (typically forms) to handle context-sensitive help requests in a custom manner. While walking up the control hierarchy, the help manager looks for help information and for a help processor (any control or container that implements this AgiHelpProcessor interface). If it finds a custom implementation of AgiHelpProcessor, it calls it with the help information it has found using getHelpInfo(). If it doesn't find a help processor, it uses the default mechanism, which is to display the help information in a browser.

Different levels of the container hierarchy can have different help processing by implementing their own versions of AgiHelpProcessor.

For more information, see Providing context-sensitive help for forms.

Method Summary

boolean

processHelp(Object requester, String helpInfo) Called by the help manager to process a help request.

Method Detail

processHelp

public boolean processHelp(Object requester,
                           String helpInfo)

Called by the help manager to process a help request.

Parameters:

requestor - the control that has focus when the user presses F1.

helpinfo - help information obtained when the help manager calls getHelpInfo() as it traverses the container hierarchy of the requesting component. The processHelp() method can interpret helpinfo as appropriate for the application.

Returns:

true if the help request has been processed; false if the help system should continue looking for a container to process it.

Usage:

The help manager calls the processHelp() method, passing the component with keyboard focus (the requestor) and whatever help information it has found so far. The processHelp() can handle this help request in any way and can interpret the help information however is appropriate to the application. If it processes the help request, it should return true. If it does not process the help request, it should return false and the help manager continues looking for a container to handle the help request.

For example, a particular form might implement the AgiHelpProcessor interface to handle context-sensitive help requests by displaying the help information in a dialog box. The help information associated with each control could be the text to display in the dialog box, rather than an URL.

See Also:

AgiHelpInfo.getHelpInfo(), AgiHelpInfo.setHelpInfo(String helpInfo)