Class idx.form.TriStateCheckBox
Extends
dijit.form.ToggleButton, idx.form._CompositeMixin, idx.form._CssStateMixin, idx.form._ValidationMixin.
idx.form.TriStateCheckBox is implemented according to IBM One UI(tm) Check Boxes Standard
Compared with dijit.form.CheckBox, TriStateCheckBox has a indeterminate state in addtion to checked state and unchecked state.
The state cycle of TriStateCheckBox is configureable, so you can even create a CheckBox with states cycle such as: 'checked' -> 'indeterminate' -> 'checked' -> 'unchecked'
As idx.form.TriStateCheckBox is a composite widget. You can set a label for it directly rather than adding a label tag mannually.
Defined in: <idx\form\TriStateCheckBox.js>.
Constructor Summary
Constructor Attributes | Constructor Name and Description |
---|---|
Field Summary
Field Attributes | Field Name and Description |
---|---|
Current check state of the check box.
|
|
Should this widget respond to user input or not.
|
|
States cycle of a TriStateCheckBox.
|
|
The submit value for each state.
|
- Fields borrowed from class idx.form._CompositeMixin:
- fieldWidth, help, hint, hintPosition, label, labelAlignment, labelWidth, required, unit
- Fields borrowed from class idx.form._ValidationMixin:
- instantValidate, invalidMessage, missingMessage, tooltipPosition
Method Summary
Method Attributes | Method Name and Description |
---|---|
click()
|
|
displayMessage(message, message)
|
|
fixState()
|
|
postCreate(scope)
|
|
reset()
|
|
resize()
|
|
setChecked(checked)
|
|
startup()
|
- Methods borrowed from class idx.form._CompositeMixin:
- _setFieldWidthAttr, _setHintAttr, _setLabelAlignmentAttr, _setLabelAttr, _setLabelWidthAttr, _setRequiredAttr, _setUnitAttr, postMixInProperties, validateAndFocus
- Methods borrowed from class idx.form._ValidationMixin:
- _isEmpty, _isValid, getErrorMessage, isValid, refocus, validate
Field Detail
{Boolean|String} checked
Current check state of the check box. Can be one of element in 'states' property.
- Default Value:
- false
{Boolean} readOnly
Should this widget respond to user input or not.
In markup, this is specified as "readOnly".
Similar to disabled except readOnly form values are submitted.
{Array|String} states
States cycle of a TriStateCheckBox. By default it's [false, "mixed", true] which means the state cycles from
'unchecked' -> 'indeterminate' -> 'checked'.
Note: The value of the 'checked' property of a TriStateCheckBox should be one of these states.
For example, if the 'states' property of a TriStateCheckBox is [false, true], then setting 'checked'
property to 'midex' is invalid.
- Default Value:
- [false, "mixed", true]
{Object} stateValues
The submit value for each state. By default, "on"/"mixed" will be submitted
if the state of a TriStateCheckBox is checked/indeterminate.
- Default Value:
- ;
Method Detail
click()
constructor()
displayMessage(message, message)
Defined in: <idx\form\plugins\phone\TriStateCheckBoxPlugin.js>.
- Parameters:
- {Object} message
- message
fixState()
postCreate(scope)
Defined in: <idx\form\plugins\phone\TriStateCheckBoxPlugin.js>.
- Parameters:
- scope
reset()
resize()
setChecked(checked)
- Parameters:
- checked