com.novell.application.console.snapin
Interface Help

All Known Subinterfaces:

PageSnapin, ResultModifierSnapin

public interface Help

Provides a common help interface for snapins which need to provide a help system

Method Summary

boolean	hasHelp() Determines the state of the Help button.
void	showHelp() Displays Help information when the hasHelp() method has returned true.

Method Detail

hasHelp

public boolean hasHelp()

Determines the state of the Help button.

You should override this method and return true if you wish to provide Help for your snap-in, and have the Help button enabled.

Returns:

Boolean set to true if you want the Help] button to be enabled, otherwise return false to disable the Help button.

See Also:

showHelp()

showHelp

public void showHelp()

Displays Help information when the hasHelp() method has returned true.

The showHelp() method is called when the user presses the Help button. To provide help for your snap-in, you must return true, then implement the showHelp() method.

See Also:

hasHelp()