public interface UITextBox extends UIAtomicWidget
The JavaScript type for this widget is String
.
If the box is empty, the value will be an empty String
, that is, ""
.
If an afterValueChanged action
has been set on this widget,
the JavaScript type of the value will be the same.
Modifier and Type | Method and Description |
---|---|
String |
getBackgroundColor()
Returns the previously set background color.
|
String |
getForegroundColor()
Returns the previously set foreground color.
|
Size |
getHeight() |
Size |
getWidth() |
boolean |
isMultiLine() |
void |
setBackgroundColor(String anHtmlBackgroundColor)
Sets the background color of the component input.
|
void |
setForegroundColor(String anHtmlForegroundColor)
Sets the foreground color of the component input.
|
void |
setHeight(Size height)
Sets the height of the text box.
|
void |
setMultiLine(boolean isMultiLine)
Enables the multi-line feature of the text box.
|
void |
setWidth(Size width)
Sets the width of the text box.
|
getActionOnAfterValueChanged, isAjaxPrevalidationEnabled, isAjaxValueSynchEnabled, setActionOnAfterValueChanged, setAjaxPrevalidationEnabled, setAjaxValueSynchEnabled
isEditorDisabled, setEditorDisabled
Size getHeight()
null
if it has not been defined.setHeight(Size)
Size getWidth()
null
if it has not been defined.setWidth(Size)
boolean isMultiLine()
true
if the multi-line has been enabled,
false
otherwise.setMultiLine(boolean)
void setHeight(Size height)
The height feature only works when multi-line is enabled.
If the height is null
,
it will use the standard height of text areas
defined in the Administration section,
topic Ergonomics and layout.
Default value is null
.
height
- the height to set the text box to,
or null
to reset to default.setMultiLine(boolean)
void setMultiLine(boolean isMultiLine)
When the multi-line is enabled, the height feature is available.
Default value is false
.
isMultiLine
- true
to enable the multi-line feature,
or false
to reset to default.setHeight(Size)
void setWidth(Size width)
If the width is null
,
it will use the standard width of inputs
defined in the Administration section,
topic Ergonomics and layout.
Default value is null
.
width
- the width to set the text box to,
or null
to reset to default.String getBackgroundColor()
void setBackgroundColor(String anHtmlBackgroundColor)
Color must be a valid hexadecimal HTML color, and respect one of the following formats: "ABC", "#ABC", "ABCDEF" or "#ABCDEF".
String getForegroundColor()
void setForegroundColor(String anHtmlForegroundColor)
Color must be a valid hexadecimal HTML color, and respect one of the following formats: "ABC", "#ABC", "ABCDEF" or "#ABCDEF".