Constructor and Description |
---|
PanelHelpImpl() |
Modifier and Type | Method and Description |
---|---|
void |
addEditUsage(Locale lang,
String usage) |
void |
addId(String id) |
void |
addMessage(String messageName,
Locale lang,
String description) |
void |
addParamDescription(String parameterName,
Locale lang,
String description) |
void |
addUsage(Locale lang,
String usage) |
PanelAbout |
getAbout()
Get the about information
|
String |
getEditModeUsage(Locale lang)
Edit mode panel usage in given lang.
|
String[] |
getIds()
Panel provider ids for which the help is valid
|
String |
getMessage(String messageName,
Locale lang)
Get the message associated with a message key
|
String[] |
getMessages()
Determine the extra message keys
|
String[] |
getParameterNames()
Determine the parameter id's that have related description.
|
String |
getParameterUsage(String parameterName,
Locale lang)
Determine the parameter help string for a given parameter
in a given lang.
|
String |
getUsage(Locale lang)
General panel usage in given lang.
|
void |
setAbout(PanelAbout about) |
String |
toString() |
public String[] getIds()
public String getEditModeUsage(Locale lang)
getEditModeUsage
in interface PanelHelp
lang
- Desired language for the description.public String[] getParameterNames()
getParameterNames
in interface PanelHelp
public String getParameterUsage(String parameterName, Locale lang)
getParameterUsage
in interface PanelHelp
parameterName
- Parameter namelang
- Desired language for the description.public String[] getMessages()
getMessages
in interface PanelHelp
public String getMessage(String messageName, Locale lang)
getMessage
in interface PanelHelp
messageName
- message keylang
- Desired language for the description.public PanelAbout getAbout()
public void setAbout(PanelAbout about)
public void addId(String id)
public void addParamDescription(String parameterName, Locale lang, String description)
Copyright © 2012-2015 JBoss by Red Hat. All Rights Reserved.