things.common.help
Interface Helpful

All Known Implementing Classes:
ConfigureByProps

public interface Helpful

Helpful interface. It's a way to let a subcomponent be helpful.

Anything that implements should have a default constructor, since when the helpers are getting built, one may be instantiated. For this process, it doesn't matter if the constructor does nothing. This is just another sucky java thing. However, if you can't tolerate a default constructor, at least have a PUBLIC static instance of Helper. the system will try to grab that without creating and instance object.

Version:
1.0

Version History

EPG - Initial - 10 SEP 08
 
Author:
Erich P. Gatejen

Method Summary
 java.lang.String help()
          Provide basic help as a string.
 Helper helper()
          Provide a helper for the help.
 java.lang.String information()
          Provide detailed information.
 

Method Detail

help

java.lang.String help()
Provide basic help as a string. It should use ThingsMarkup for gimmicks.

Returns:
The text of the help or null if there is none.
See Also:
ThingsMarkup

information

java.lang.String information()
Provide detailed information. It should use ThingsMarkup for gimmicks.

Returns:
The text of the information or null if there is none.
See Also:
ThingsMarkup

helper

Helper helper()
Provide a helper for the help. This allows you to create a richer set of property help. It may return null if there is no more help.

Returns:
the helper


Things.