public interface UIFormGroup
This indentation is stackable. The maximum depth is 5.
To obtain a simple form group with label set, invoke the method
UIComponentWriter.newFormGroup(UIFormLabelSpec)
.
To obtain a default fully model-driven form group, invoke the method
UIFormWriter.newFormGroup(Path)
or UIResponseContext.newFormGroup(Path)
depending on the context.
UIComponentWriter.startFormGroup(UIFormGroup)
,
UIComponentWriter.endFormGroup()
Modifier and Type | Interface and Description |
---|---|
static class |
UIFormGroup.DisplayMode
A form group can have several display modes.
|
Modifier and Type | Method and Description |
---|---|
UIFormGroup.DisplayMode |
getDisplayMode() |
String |
getId()
Returns the id of the group,
null if not set. |
UIFormLabelSpec |
getLabel() |
void |
setDisplayMode(UIFormGroup.DisplayMode displayMode)
Sets the display mode to the form group.
|
void |
setId(String id)
Sets an id for the group.
|
void |
setLabel(UIFormLabelSpec aLabel)
Sets the label of the form group.
|
UIFormLabelSpec getLabel()
label
of the form group,
or null
if the form group is fully model-drivenvoid setLabel(UIFormLabelSpec aLabel)
If the group is model-driven, it will override its label.
aLabel
- the new labelvoid setDisplayMode(UIFormGroup.DisplayMode displayMode)
UIFormGroup.DisplayMode
UIFormGroup.DisplayMode getDisplayMode()
UIFormGroup.DisplayMode
,
or null
if not set and thus automaticvoid setId(String id)
The id attribute must respect the W3C Recommendation (especially by being unique in the page). See https://www.w3.org/TR/REC-html40/struct/global.html#adef-id for more information.
If no id is specified, an id will be randomly generated.
id
- the id to set for the group.String getId()
null
if not set.