Development tools : XUI editor : XUI widgets and containers : Widget descriptions : Text
  
Text
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.
See
Implementation base
Properties for the Text widget
Data binding
Keyboard access of DateTextbox
See also
Widget descriptions
Implementation base
The Text widget is a Dojo-based widget.
There are four types of Text widgets:
com.ibm.btt.dijit.StringTextBox
com.ibm.btt.dijit.NumberTextBox
com.ibm.btt.dijit.CurrencyTextBox
com.ibm.btt.dijit.DateTextBox
The type of Text widget that is used depends on the data type to which the widget is bound.
See also
Text
Properties for the Text widget
 
Property
Description
id
The identifier for the widget.
dataName
The name of the data element to which the widget is bound. This property is not mandatory. When there is no data need to be sent to the server, this property can be left blank.
isMandatory
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:
visible
The widget is displayed on a GUI and users are able to interact with the widget.
hidden
The widget is not displayed on a GUI, but it occupies space on the GUI.
gone
The widget is not displayed on a GUI, and it does not occupy space on the GUI.
disabled
Disabled elements cannot have focus; do not receive or fire mouse events; and cannot receive user input. If you set this property to true, 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 is false.
readOnly
To prevent a user from changing the value, set readOnly to true. The default value is false.
shortcut
Shortcut is a single character from the document character set. Pressing a shortcut assigned to a widget together with hot key of browser gives focus to the widget. Different widget may have different action when it receives focus. For example, when user activates a TextBox, this TextBox is focused and all texts are selected; when user activates a button, this button is focused and selected. The toolkit supports a shortcut function based on standard HTML access key and browser capability. That's mean the shortcut character and the hot key may be different in different browsers. For more information about HTML access keys, see:
Action for Text is: Focus widget and select all text
Shortcut character: a-z 0-9 , . / ; ’ [ ]  = -
Hot key
Firefox: Shift + Alt + shortcut
IE: Alt + shortcut
Sample
Input on UDTT tooling: a
Usage on IE: Pressing Alt + a
To access DateTextBox elements through keyboard, see Keyboard access of DateTextbox.
hint
A description of the widget that is displayed as a tooltip for a user. This 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.
See also
Text
Data binding
Text that is entered by a user into a Text widget is submitted as a value of a data field in a context. Note that client-side and server-side validation and formatting is applied according to the data type to which the Text widget is bound. The default implementation of DateTextBox only supports standard date pattern type.
See
ECA editor support
See also
Text
ECA editor support
The following events, properties, and functions can be configured for the Text widget with the ECA editor.
Events that can be added to the Text widget by using the ECA editor
 
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.
Properties that can be configured for the Text widget by using the ECA editor
 
Property
Description
id
This property can be used in the Condition part of ECA rule.
value
The value of the value property is the text that is entered in the widget.
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.
This property can be used in the Condition and Actions part of ECA rule.
readOnly
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:
visible
The widget is displayed on a GUI and users are able to interact with the widget.
hidden
The widget is not displayed on a GUI, but it occupies space on the GUI.
gone
The widget is not displayed on a GUI, and it does not occupy space on the GUI.
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.
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.
This property can be used in the Action part of ECA rule.
styleClass
This property can be used in the Action part of ECA rule.
Functions that can be configured for the Text widget by using the ECA editor
 
Function
Description
isFocusable
This property can be used in the Condition part of ECA rule.
focus
This property can be used in the Action part of ECA rule.
showErrorMessage
The showMessage function displays an error message on a GUI.
This property can be used in the Action part of ECA rule.
See also
Data binding
Keyboard access of DateTextbox
 
Action
Key
Navigate between date cells
Left, Right, Up, and down arrows
Navigate to same day in next month
Page-down
Navigate to same day in previous month
Page-up
Navigate to same day in next year
Control+Page-down
Navigate to same day in previous year
Control+Page-up
Navigate to first day in month
Home
Navigate to last day in month
End
Select the date
Enter, Space
See also
Text