Development tools : XUI editor : XUI widgets and containers : Widget descriptions : CheckBox
  
CheckBox
The CheckBox widget allows a user to either check or uncheck an option. A data element is associated to this widget and you can decide which value will be set for this data element when either the box is checked or unchecked.
See
Implementation base
Properties for the CheckBox widget
Data binding
See also
Widget descriptions
Implementation base
The CheckBox widget is a Dojo-based widget:
com.ibm.btt.dijit.CheckBox
See also
CheckBox
Properties for the CheckBox 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.
checkedValue
This is a required property. The checkValue property specifies the value of the checkbox field when it is selected. The default value is true.
uncheckedValue
This is a required property. The uncheckValue property specifies the value of the checkbox field when it is not selected. The default value is false.
text
The text property is the text that is displayed on the label for a user if a value has not been assigned for the dataName property. This is an optional property.
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.
hint
A description of the widget that is displayed as a tooltip for a user. This property has multilingual support.
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 Checkbox is : focus and select checkbox
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
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.
See also
CheckBox
Data binding
When the CheckBox widget is being loaded with data from a context, the check box is selected if the value of the data field matches the value that is specified for the checkedValue property. If the value of the data field does not match the value that is specified for the checkedValue property, the check box is not selected.
When data is sent from the CheckBox widget to a context, a string containing either checkedValue or uncheckedValue is sent depending on the selection that is made by a user.
Data mapping can be changed by associating a UDTT data type to the field, and then converting the client-side string to another object such as a boolean or an integer.
See
ECA editor support
See also
CheckBox
ECA editor support
The following events, properties, and functions can be configured for the CheckBox widget with the ECA editor.
Events that can be added to the CheckBox widget by using the ECA editor
 
Event
Description
onClick
Is fired when the left mouse button is clicked.
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.
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 CheckBox widget by using the ECA editor
 
Property
Description
id
This property can be used in the Condition part of ECA rule.
isChecked
The isChecked property indicates whether the widget has been selected. Possible values are true and false..
This property can be used in the Condition and Actions part of ECA rule.
text
The text property is the text that is displayed on the label for a user if a value has not been assigned for the dataName property. This is an optional property.
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.
readOnly
To prevent a user from changing the value, set readOnly to true. The default value is false.
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 CheckBox 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.
See also
Data binding