jas.util
Interface HelpInterface

public interface HelpInterface

HelpInterface is the interface which users of the help system deal with.

Author:

Peter Armstrong

Method Summary

void	modalDialogClosing(Dialog dlg)
void	modalDialogOpening(Dialog dlg)
void	showHelpTopic(String helpTopicTarget, String navigatorView, Window owner) Shows the specified JavaHelp topic according to the display parameters provided.
void	showHelpTopic(String helpTopicTarget, Window owner) Shows the specified JavaHelp topic with the TOC visible

Method Detail

showHelpTopic

void showHelpTopic(String helpTopicTarget,
                   Window owner)

Shows the specified JavaHelp topic with the TOC visible

Parameters:

helpTopicTarget - the JavaHelp XML target name which maps to the .html page in the map file

showHelpTopic

void showHelpTopic(String helpTopicTarget,
                   String navigatorView,
                   Window owner)

Shows the specified JavaHelp topic according to the display parameters provided.

Parameters:

helpTopicTarget - the JavaHelp XML target name which maps to the .html page in the map file

navigatorView - the string specifying which of the three views to have visible

modalDialogOpening

void modalDialogOpening(Dialog dlg)

modalDialogClosing

void modalDialogClosing(Dialog dlg)