The Text widget is used to enable users to enter and submit a string of text, or a number, or a date, or a currency. You can bind a Text widget with typed data elements.
The Text widget is a Dojo-based widget.
Property | Description |
---|---|
id | The id is the identifier for the widget. |
dataName | The dataName property is the name of the data element to which the widget is bound. This property is mandatory. |
isMandatory | The isMandatory property specifies whether a user is required to enter a value in the text box. |
visibility | The visibility property
defines how a widget is displayed on a GUI. The following values can
be specified for this property:
|
disabled | Disabled elements cannot have focus, do not receive or fire mouse events, cannot receive user input. If you select a value of true for the disabled property, the widget is displayed on a GUI but a user cannot interact with it. Data contained in a disabled widget is not processed when the form is submitted. The default value for the disabled property is false. |
readOnly | The readOnly property can be set to keep a user from changing the value. The default value for the readOnly property is false. |
shortcut | The shortcut property specifies a keyboard shortcut for the widget. If a user enters the keyboard shortcut on a client, the widget receives focus on the GUI of the client. You can specify either a single character as the value of the shortcut property, or you can specify Ctrl and a character as the value of the shortcut property. |
hint | The hint is a description of the widget that is displayed as a tooltip for a user. The hint property has multilingual support. |
password | If the password property is set to true, the string of text that is entered by a user in the Text widget is considered as a password and the actual value of the content is not displayed to ensure the security of the password. |
styleClass | The styleClass property specifies the name of the CSS style ( also known as CSS style class) associated with the widget. This property is set by selecting a style from the CSS styles table in the Style tab of the Properties view. If you do not configure the styleClass property, the default style is used instead. For more detailed information, refer to Setting CSS style to widgets |
width | The width property specifies the width of the widget. This property is set in the Appearance tab of the Properties view. |
height | The height property specifies the height of the widget. This property is set in the Appearance tab of the Properties view. |
Text that is entered by a user into a Text widget is submitted as a value of a data field in a context. Note also that client-side and server-side validation and formatting is applied according to the data type to which the Text widget is bound.
Event | Description |
---|---|
onClick | Is fired when the left mouse button is clicked. |
onFocus | Is fired when the widget receives focus because the user moves the mouse pointer over the widget. |
onBlur | Is fired when the widget does not receive focus, or when the user clicks outside the widget, or when the widget is hidden. |
onKeyDown | Is fired when a keyboard key is pressed. |
onKeyUp | Is fired when a keyboard key is released. |
onKeyPress | Is fired when a keyboard key is pressed or held down. |
onMouseDown | Is fired when a mouse button is clicked. |
onMouseUp | Is fired when a mouse button is released |
onMouseEnter | Is fired when the mouse pointer moves over the widget. |
onMouseLeave | Is fired when the mouse pointer moves out of the widget. |
onMouseMove | Is fired when the mouse pointer moves over nodes that are contained in the widget. |
onChange | Is fired when the value of the widget changes. |
Property | Description |
---|---|
value | The value of the value property is the text
that is entered in the widget. Note: This property can be used in the Condition and Actions part
of ECA rule.
|
isMandatory | The value of the widget cannot be empty if the
isMandatory property is true. Note: This property can be used in the Condition and Actions part
of ECA rule.
|
readOnly | The readOnly property
can be set to keep a user from changing the value. The default value
for the readOnly property is false. Note: This
property can be used in the Condition and Actions part
of ECA rule.
|
visibility | The visibility
property defines how a widget is displayed on a GUI. The following
values can be specified for this property:
Note: This property can be used in the Condition and Actions part
of ECA rule.
|
disabled | Disabled elements
cannot have focus, do not receive or fire mouse events, cannot receive
user input. If you select a value of true for the
disabled property, the widget is displayed on a GUI but a user cannot
interact with it. Data contained in a disabled widget is not processed
when the form is submitted. The default value for the disabled property
is false. Note: This property can be used in
the Condition and Actions part
of ECA rule.
|
hint | The hint is a description of the widget that
is displayed as a tooltip for a user. The hint property has multilingual
support. Note: This property can be used in the Actions part
of ECA rule.
|
styleClass | The styleClass property
specifies the name of the CSS style ( also known as CSS style class)
associated with the widget. This property is set by selecting a style
from the CSS styles table in the Style tab of the Properties view.
If you do not configure the styleClass property, the default style
is used instead. For more detailed information, refer to Setting CSS style to widgets Note: This
property can be used in the Actions part of
ECA rule.
|
Function | Description |
---|---|
isFocusable | Returns a value of true if
a widget can be focused and a value of false if it
cannot be focused. Note: The
function can be used in the Condition part
of ECA rule.
|
focus | Specifies that the widget
should be focused. Note: The
function can be used in the Actions part of
ECA rule.
|
showErrorMessage | The showMessage function displays an error message
on a GUI. Note: The function can be used in the Actions part
of ECA rule.
|