| java.lang.Object
 ti.chimera.Service
ti.chimera.service.Help
| Help | | abstract public class Help extends ti.chimera.Service (Code) | | The help service provides a mechanism for registering help pages provided
by a component, as well as a way to programatically display that help. The
help service has the well defined name "help".
author:
Rob Clark
version:
0.1 |
| Constructor Summary | |
| public | Help()
Class Constructor. |
| Help | | public Help()(Code) | | Class Constructor.
|
| displayHelp | | abstract public void displayHelp(String path)(Code) | | Programmatically display the specified help. If the path is
null, then display the main help index, which is
automatically generated from all the registered help pages.
Parameters:
path - the "/" seperated path name of the help
See Also: Help.registerHelp
See Also: to register help |
| registerHelp | | abstract public void registerHelp(String path, String url, String desc)(Code) | | Register help. You can programmatically open help by calling
Help.displayHelp and passing in the same path. The path is a
"/" seperated path, which allows for multiple sub-headings.
Parameters:
path - the "/" seperated path name of the help
Parameters:
url - the string URL to open to view this help
Parameters:
desc - description of the help
See Also: Help.displayHelp
See Also: to programmatically display help |
|
|