|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectthings.common.help.Helper
public class Helper
A rich helper.
Version History
EPG - Initial - 10 SEP 08
Constructor Summary | |
---|---|
Helper()
Default constructor. |
|
Helper(java.lang.String user,
java.lang.String title,
java.lang.String information)
Constructor. |
Method Summary | |
---|---|
void |
add(boolean required,
java.lang.String name,
java.lang.String helpText)
Add a property. |
void |
add(boolean required,
java.lang.String name,
java.lang.String helpText,
java.lang.String... values)
Add a property with value suggestions. |
java.util.List<HelpItem> |
getHelp()
Get the help list. |
static Helper |
getHelper(java.lang.String className)
Get a helper from a class name. |
java.util.List<Helper> |
getReferences()
Get the reference list. |
java.lang.String |
getUser()
Get the user. |
java.lang.String |
information()
Provide detailed information. |
void |
inherit(java.lang.Class<?> helpful)
Inherit help from another class' helper. |
void |
inherit(Helper helper)
Inherit help from another class' helper, including references. |
void |
reference(java.lang.Class<?> helpful)
Reference help from another class' helper. |
void |
reference(Helper helper)
Reference help from another class' helper. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Helper()
public Helper(java.lang.String user, java.lang.String title, java.lang.String information)
user
- the user of this help. All added items will be tagged with this user.title
- the title for this area.information
- helpful text about the user.Method Detail |
---|
public java.util.List<HelpItem> getHelp()
ThingsMarkup
public java.util.List<Helper> getReferences()
ThingsMarkup
public java.lang.String information()
ThingsMarkup
public java.lang.String getUser()
public void add(boolean required, java.lang.String name, java.lang.String helpText)
required
- name
- helpText
- public void add(boolean required, java.lang.String name, java.lang.String helpText, java.lang.String... values)
required
- name
- values
- values as name/description pairs. This really should be an even number. An odd number leave drop the final name string.helpText
- public void inherit(Helper helper)
helper
- the helper.public void inherit(java.lang.Class<?> helpful)
helpful
- the helpful class from which we can get a helper. Sucks I have to instantiate one of these.public void reference(Helper helper)
helper
- the helper.public void reference(java.lang.Class<?> helpful)
helpful
- the helpful class from which we can get a helper. Sucks I have to instantiate one of these.public static Helper getHelper(java.lang.String className)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |