public static final class UIFormLabelSpec.DocumentationPane extends Object
Constructor and Description |
---|
DocumentationPane()
Class constructor for specific documentation.
|
DocumentationPane(Path aPrefixedPath,
boolean isAdvancedInfo)
Class constructor for standard node documentation.
|
DocumentationPane(String aTitle)
Class constructor for specific documentation.
|
DocumentationPane(UserMessage aTitle)
Class constructor for specific documentation.
|
Modifier and Type | Method and Description |
---|---|
void |
addBlock(String aText)
Specifies an additional paragraph in an open section.
|
void |
addBlock(String aTitle,
String aText)
Specifies an additional paragraph in an open section, consisting
of a title and text.
|
void |
addBlock(String aTitle,
UserMessage aText)
Specifies an additional paragraph in an open section, consisting
of a title and a text.
|
void |
addBlock(UserMessage aText)
Specifies an additional paragraph in an open section.
|
void |
addBlock(UserMessage aTitle,
String aText)
Specifies an additional paragraph in an open section, consisting
of a title and text.
|
void |
addBlock(UserMessage aTitle,
UserMessage aText)
Specifies an additional paragraph in an open section, consisting
of a title and a text.
|
void |
setDescription(String description)
Specifies the description for the documentation pane.
|
void |
setDescription(UserMessage description)
Specifies the description of the documentation pane.
|
void |
setError(String error)
Optional, specifies an error message associated with the current node.
|
void |
setError(UserMessage error)
Optional, specifies an error message associated with the current node.
|
void |
setTitle(String aTitle)
Specifies the title of the documentation pane.
|
void |
setTitle(UserMessage aTitle)
Specifies the title of the documentation pane.
|
void |
setValidationMessage(UserMessage aValidationMessage)
Optional, specifies a validation message associated with the current node.
|
public DocumentationPane(Path aPrefixedPath, boolean isAdvancedInfo)
Note 1: In addition to being standard, one benefit of this mode is that the pane is built using an Ajax request. Thus, it is lightweight in terms of page container.
Note 2: For UI forms only, an absolute path in the data model may be used instead of a prefixed path. Prefixed paths are mandatory for user services and recommended for UI forms.
aPrefixedPath
- The prefixed path of the node whose documentation
is to be displayed.isAdvancedInfo
- true
to display the advanced information,
false
otherwise. The advanced information
provides technical information, such as the type
and the path.UIFormWriter.getPrefixedPath(Path)
public DocumentationPane()
public DocumentationPane(String aTitle)
aTitle
- The title of the documentation pane.public DocumentationPane(UserMessage aTitle)
aTitle
- The title of the documentation pane.public void setTitle(String aTitle)
osd:label
) of the current node.IllegalStateException
- If this pane was built in standard node documentation mode.public void setTitle(UserMessage aTitle)
osd:label
) of the current node.IllegalStateException
- If this pane was built in standard node documentation mode.public void setDescription(String description)
osd:description
of the current node.IllegalStateException
- If this pane was built in standard node documentation mode.public void setDescription(UserMessage description)
osd:description
of the current node.IllegalStateException
- If this pane was built in standard node documentation mode.public void setError(String error)
IllegalStateException
- If this pane was built in standard node documentation mode.public void setValidationMessage(UserMessage aValidationMessage)
IllegalStateException
- If this pane was built in standard node documentation mode.public void setError(UserMessage error)
IllegalStateException
- If this pane was built in standard node documentation mode.public void addBlock(String aText)
This method is equivalent to:
DocumentationPane.addBlock(null, value)
IllegalStateException
- If this pane was built in standard node documentation mode.public void addBlock(UserMessage aText)
This method is equivalent to:
DocumentationPane.addBlock(null, value)
IllegalStateException
- If this pane was built in standard node documentation mode.public void addBlock(String aTitle, String aText)
aText
- can be pure text or HTML not too heavy and well formedIllegalStateException
- If this pane was built in standard node documentation mode.public void addBlock(UserMessage aTitle, String aText)
aText
- can be pure text or HTML not too heavy and well formedIllegalStateException
- If this pane was built in standard node documentation mode.public void addBlock(String aTitle, UserMessage aText)
IllegalStateException
- If this pane was built in standard node documentation mode.public void addBlock(UserMessage aTitle, UserMessage aText)
IllegalStateException
- If this pane was built in standard node documentation mode.