A check box with four states for selecting the containing row in a tree. The four check box states are off, on, mixed-off, and mixed-on. Changing the selection state of descendant rows toggles only the mixed state of a row. For example, when all descendants of a selected row are deselected, the selected row remains selected. The user can select individual rows independent of the state of their descendants. You can disable check boxes on a per-row basis by supplying a binding expression for the disabled
property.
Initial State | User Action | ||
---|---|---|---|
Deselect All Descendants | Deselect Some, Select Some Descendants | Select All Descendants | |
off | off | mixed-off | mixed-off |
on | mixed-on | mixed-on | on |
mixed-off | off | mixed-off | mixed-off |
mixed-on | mixed-on | mixed-on | on |
To enable selecting rows, the tree's content provider must implement the com.webmethods.caf.faces.data.ISelectableTableContentProvide
interface. The interface enables selecting rows that are in selected or unselected mode. In selected mode, specified rows are selected explicitly. In unselected mode, all rows are implicitly selected, and only specified rows are unselected. The tree's content provider might implement the com.webmethods.caf.faces.data.tree.ISelectableTreeContentProvider
interface that enables the content provider to optimize mixed state calculations.
Info | Value |
---|---|
Component Type | com.webmethods.caf.faces.tree.SelectRowQuadStateCheckbox |
Handler Class | None |
Renderer Type | com.webmethods.caf.faces.tree.SelectRowQuadStateCheckbox |
Description | Checkbox with four states (off, on, mixed-off, mixed-on) that selects its containing tree row |
Palette Location | CAF Html/Control/Table/Table Row Tools/Select Row Quad-State Checkbox |
Client-Side Model | CAF.Select.Row.Checkbox.QuadState.Model |
Name | Required | Type | Description |
---|---|---|---|
accesskey | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Keyboard shortcut letter |
disabled | false | javax.el.ValueExpression
(must evaluate to boolean )
| True if control is grayed-out (use an expression to enable/disable on a per-row basis) |
id | false | java.lang.String | Control identifier |
rendered | false | javax.el.ValueExpression
(must evaluate to boolean )
|
True to render control; false to ignore it
If not specified, the default value is "true". |
tabindex | false | javax.el.ValueExpression
(must evaluate to java.lang.String )
| Order in tab (key) sequence, from 1 to n. Zero adds control to tab sequence, negative integer removes control. |
Output generated by Vdldoc View Declaration Language Documentation Generator.