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.
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.
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.
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
Go up to
Widget descriptions