Class idx.grid.cells.CheckBox
Extends
idx.grid.cells._Widget.
Always shows a check box in each cell.
Defined in: <idx\grid\cells.js>.
Constructor Summary
Constructor Attributes | Constructor Name and Description |
---|---|
Field Summary
Field Attributes | Field Name and Description |
---|---|
Shows a check box in the header cell to check/uncheck all rows.
|
|
The label to associate with the checkbox.
|
Method Summary
Method Attributes | Method Name and Description |
---|---|
apply(index)
Applies "checked" attribute of the check box to the data store item.
|
|
checkAll(checked)
Checks on or off all check boxes.
|
|
formatter(value, index)
Sets "checked" attribute to the widget of the row.
|
|
Returns true if all check boxes are checked.
|
Field Detail
{Boolean} allCheckable
Shows a check box in the header cell to check/uncheck all rows.
- Default Value:
- false
labelText
The label to associate with the checkbox. If none given then the
default is used.
Method Detail
apply(index)
Applies "checked" attribute of the check box to the data store item.
- Parameters:
- {Number} index
checkAll(checked)
Checks on or off all check boxes.
- Parameters:
- {Boolean} checked
{Widget} formatter(value, index)
Sets "checked" attribute to the widget of the row.
If applicable, adds a check box to the column header.
- Parameters:
- {Boolean} value
- {Number} index
- Returns:
- {Widget}
{Boolean} isAllChecked()
Returns true if all check boxes are checked.
- Returns:
- {Boolean}