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.
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. |
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 | 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:
|
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. |
hint | The hint is a description of the widget that is displayed as a tooltip for a user. The hint property has multilingual support. |
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. |
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 |
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.
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. |
Property | Description |
---|---|
isChecked | The isChecked property indicates whether the
widget has been selected. Possible values are true and false.. Note: This
property can be used in the Condition and Actions part
of ECA rule.
|
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. 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.
|
readOnly | The readOnly property can be set to keep a user from changing the value. The default value for the readOnly property 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. 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.
|