public interface UIFormRow
To obtain a simple form row with not icon or label set, invoke the method
UIComponentWriter.newFormRow()
.
To obtain a default fully model-driven form row, invoke the method
UIFormWriter.newFormRow(Path)
.
UIComponentWriter.startFormRow(UIFormRow)
,
UIFormWriter.addFormRow(UIFormRow)
Modifier and Type | Method and Description |
---|---|
UIFormRowIcon |
getIcon() |
String |
getIconURL() |
UIFormLabelSpec |
getLabel() |
Size |
getLabelWidth() |
String |
getRowId() |
Size |
getWidgetWidth() |
boolean |
isIconDisplayed() |
boolean |
isLabelDisplayed() |
Boolean |
isMandatoryIndicatorDisplayed() |
void |
setIcon(UIFormRowIcon anIcon)
Sets a built-in icon for this form row.
|
void |
setIconDisplayed(boolean isDisplayed)
Sets whether or not the icon will be displayed in the form row.
|
void |
setIconURL(String anIconUrl)
Sets a URL of an icon of this form row.
|
void |
setLabel(UIFormLabelSpec aLabelSpec)
Sets the label of the form row.
|
void |
setLabelDisplayed(boolean isDisplayed)
Sets whether or not the label will be displayed for the form row.
|
void |
setLabelWidth(Size aSize)
Sets a fixed width for the label area of the form row.
|
void |
setMandatoryIndicatorDisplayed(Boolean isDisplayed)
Sets whether or not the mandatory indicator
(usually a red star near the label)
will be displayed for the form row.
|
void |
setRowId(String aRowId)
Sets the specified HTML id on the row.
|
void |
setWidgetWidth(Size aSize)
Sets a minimum width for the user input/display area of the form row.
|
String getRowId()
setRowId(String)
void setRowId(String aRowId)
This method is useful for accessing an entire form row (both label and content)
using JavaScript functions, for example, hiding and showing the UIFormRow
.
The id attribute must respect the W3C Recommendations (in particular, uniqueness within the page). See https://www.w3.org/TR/REC-html40/struct/global.html#adef-id for more information.
aRowId
- the HTML id to set to this form row.UIFormRowIcon getIcon()
setIcon(UIFormRowIcon)
void setIcon(UIFormRowIcon anIcon)
anIcon
- the UIFormRowIcon
to set to this form row.setIconURL(String)
String getIconURL()
setIconURL(String)
void setIconURL(String anIconUrl)
It also sets the icon to displayed and clears the form row icon.
anIconUrl
- the URL of the icon to set to this form row.boolean isIconDisplayed()
setIconDisplayed(boolean)
void setIconDisplayed(boolean isDisplayed)
If false
, it will clear the form row icon
and the icon URL.
Default value is true
.
isDisplayed
- false
to set the icon as not displayed,
true
to display the icon and set the default value.UIFormLabelSpec getLabel()
setLabel(UIFormLabelSpec)
void setLabel(UIFormLabelSpec aLabelSpec)
In the context of a UIFormPaneWriter
, this label will override
the label determined from the path.
It also sets the label to displayed.
aLabelSpec
- the label to set for this form row.boolean isLabelDisplayed()
setLabelDisplayed(boolean)
void setLabelDisplayed(boolean isDisplayed)
If false
, it will clear the label.
Default value is true
.
isDisplayed
- false
to set the label to not displayed,
true
to display the label and set its default value.Size getLabelWidth()
setLabelWidth(Size)
void setLabelWidth(Size aSize)
If the width of the label is null
,
the label will use the default width defined by the
corresponding parameter in the Administration area.
If the fixed width of the label is not null
but the label state
is set to "not displayed",
the label state will be changed to displayed.
Default value is null
.
aSize
- the Size
of the label area in the form row,
or null
to reset to the default, which is automatic width.Boolean isMandatoryIndicatorDisplayed()
setMandatoryIndicatorDisplayed(Boolean)
void setMandatoryIndicatorDisplayed(Boolean isDisplayed)
Default value is null
.
isDisplayed
- false
to force the mandatory indicator to not be displayed,true
to force the mandatory indicator to be displayed,null
to let the model driven
or the
defined label
proceed.Size getWidgetWidth()
setWidgetWidth(Size)