A check box with three states for selecting the containing row in a tree. The three check box states are off, on, and mixed-off. When a user deselects all descendants of a given row, the row's selection state switches to off. When a user selects some, but not all descendants of a given row, the row's selection state switches to mixed-off. When a user selects all descendants of a given row, the row's selection state switches to the on state. Supply a binding expression for the disabled property to change the state to use a per-row basis.
| Initial State | User Action | ||
|---|---|---|---|
| Deselect All Descendants | Deselect Some, Select Some Descendants | Select All Descendants | |
| off | off | mixed-off | on |
| on | off | mixed-off | on |
| mixed-off | off | mixed-off | on |
To enable selecting rows, the tree's content provider must implement the com.webmethods.caf.faces.data.ISelectableTableContentProvider interface. This interface enables selecting rows 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, which allows the content provider to optimize mixed state calculations.
| Info | Value |
|---|---|
| Component Type | com.webmethods.caf.faces.tree.SelectRowTriStateCheckbox |
| Handler Class | None |
| Renderer Type | com.webmethods.caf.faces.tree.SelectRowTriStateCheckbox |
| Description | Checkbox with three states (off, on, mixed-off) that selects its containing tree row |
| Palette Location | CAF Html/Control/Table/Table Row Tools/Select Row Tri-State Checkbox |
| Client-Side Model | CAF.Select.Row.Checkbox.TriState.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.