CheckBox

Implementation base

The CheckBox widget is a Dojo-based widget:
  • com.ibm.btt.dijit.CheckBox

Properties

The following properties can be configured for the CheckBox widget.
Table 1. Properties that can be configured for the CheckBox widget
Property Description
dataName The dataName property is the name of the data element to which the widget is bound. This property is optional.
styleClass The styleClass property specifies the class selector that is associated with the widget. If you do not configure the styleClass property, the default class selector is used instead.
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 The disabled property is an expert-level property, which means that it is available for use in the XUI editor only if the XUI editor is configured to display expert properties. 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 is an expert-level property, which means that it is available for use in the XUI editor only if the XUI editor is configured to display expert properties. If you select a value of true for the readOnly property, the widget is displayed on a GUI but a user cannot interact with it. If a widget has the value of its readOnly property set to true and the value of its disabled property set to false, the data of the widget is taken into account during form submission. The default value for the readOnly property is false.
id The id is the identifier for the widget.
hint The hint is a description of the widget that is displayed as a tooltip for a user. The hint property has multilingual support.
text 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.
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.
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.

Data mapping

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 WebSphere® Multichannel Bank Transformation Toolkit data type to the field, and then converting the client-side string to another object such as a boolean or an integer.

ECA editor support

The following events, properties, and functions can be configured for the CheckBox widget with the ECA editor.
Table 2. 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.
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.
Table 3. Properties that can be configured for the CheckBox widget by using the ECA editor.
Property Description
readOnly The readOnly property is an expert-level property, which means that it is available for use in the XUI editor only if the XUI editor is configured to display expert properties. If you select a value of true for the readOnly property, the widget is displayed on a GUI but a user cannot interact with it. If a widget has the value of its readOnly property set to true and the value of its disabled property set to false, the data of the widget is taken into account during form submission. The default value for the readOnly property is false.
text 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.
isChecked The isChecked property indicates whether the widget has been selected. Possible values are true and false..
Table 4. Functions that can be configured for the CheckBox widget by using the ECA editor.
Function Description
isFocusable Returns a value of true if a widget can be focused and a value of false if it cannot be focused.
focus Specifies that the widget should be focused.