ti.chimera.service
Class Help
java.lang.Object
ti.chimera.Service
ti.chimera.service.Help
- public abstract class Help
- extends Service
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"
.
- Version:
- 0.1
- Author:
- Rob Clark
Constructor Summary |
Help()
Class Constructor. |
Method Summary |
abstract void |
displayHelp(java.lang.String path)
Programmatically display the specified help. |
abstract void |
registerHelp(java.lang.String path,
java.lang.String url,
java.lang.String desc)
Register help. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Help
public Help()
- Class Constructor.
registerHelp
public abstract void registerHelp(java.lang.String path,
java.lang.String url,
java.lang.String desc)
- Register help. You can programmatically open help by calling
displayHelp(java.lang.String)
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 helpurl
- the string URL to open to view this helpdesc
- description of the help- See Also:
to programmatically display help
displayHelp
public abstract void displayHelp(java.lang.String path)
- 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:
to register help