Properties Methods Events Config Options Direct Link

    Observable
      AbstractSelectionModel
        RowSelectionModel
          CheckboxSelectionModel

# Class Ext.grid.CheckboxSelectionModel

Package: | Ext.grid
Defined In: | CheckboxSelectionModel.js
Class: | CheckboxSelectionModel
Extends: | RowSelectionModel

A custom selection model that renders a column of checkboxes that can be toggled to select or deselect rows.

## Config Options

Config Options | Defined By
--- | ---
| header : String Any valid text or HTML fragment to display in the header cell for the checkbox column (defaults to '<div class="x-... Any valid text or HTML fragment to display in the header cell for the checkbox column (defaults to '<div class="x-grid3-hd-checker"> </div>'). The default CSS class of 'x-grid3-hd-checker' displays a checkbox in the header and provides support for automatic check all/none behavior on header click. This string can be replaced by any valid HTML fragment, including a simple text string (e.g., 'Select Rows'), but the automatic check all/none behavior will only work if the 'x-grid3-hd-checker' class is supplied. | CheckboxSelectionModel
| listeners : Object A config object containing one or more event handlers to be added to this object during initialization. This should b... A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the addListener example for attaching multiple handlers at once. | Observable
| singleSelect : Boolean True to allow selection of only one row at a time (defaults to false) | RowSelectionModel
| sortable : Boolean True if the checkbox column is sortable (defaults to false). | CheckboxSelectionModel
| width : Number The default width in pixels of the checkbox column (defaults to 20). | CheckboxSelectionModel

## Public Properties

This class has no public properties.

## Public Methods

Method | Defined By
--- | ---
| CheckboxSelectionModel( `Object config` ) Parameters: `config` : Object The configuration options Returns: `` | CheckboxSelectionModel
| addEvents( `Object object` ) : void Used to define events on this Observable Used to define events on this Observable Parameters: `object` : Object The object with the events defined Returns: `void` | Observable
- | addListener( `String eventName`, `Function handler`, [`Object scope`], [`Object options`] ) : void Appends an event handler to this component Appends an event handler to this component Parameters: `eventName` : String The type of event to listen for `handler` : Function The method the event invokes `scope` : Object (optional) The scope in which to execute the handler function. The handler function's "this" context. `options` : Object (optional) An object containing handler configuration properties. This may contain any of the following properties: scope : Object The scope in which to execute the handler function. The handler function's "this" context. delay : Number The number of milliseconds to delay the invocation of the handler after the event fires. single : Boolean True to add a handler to handle just the next firing of the event, and then remove itself. buffer {Number} Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place. Combining Options Using the options argument, it is possible to combine different types of listeners: A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)
      el.on('click', this.onClick, this, {
          single: true,
          delay: 100,
          forumId: 4
      });
  Attaching multiple handlers in 1 call The method also allows for a single argument to be passed which is a config object containing properties which specify multiple handlers.
      foo.on({
          'click' : {
              fn: this.onClick,
              scope: this,
              delay: 100
          },
          'mouseover' : {
              fn: this.onMouseOver,
              scope: this
          },
          'mouseout' : {
              fn: this.onMouseOut,
              scope: this
          }
      });
  Or a shorthand syntax:
      foo.on({
          'click' : this.onClick,
          'mouseover' : this.onMouseOver,
          'mouseout' : this.onMouseOut,
           scope: this
      });
Returns: `void` | Observable
| clearSelections() : void Clears all selections. Clears all selections. Parameters: None. Returns: `void` | RowSelectionModel
| deselectRange( `Number startRow`, `Number endRow` ) : void Deselects a range of rows. All rows in between startRow and endRow are also deselected. Deselects a range of rows. All rows in between startRow and endRow are also deselected. Parameters: `startRow` : Number The index of the first row in the range `endRow` : Number The index of the last row in the range Returns: `void` | RowSelectionModel
| deselectRow( `Number row` ) : void Deselects a row. Deselects a row. Parameters: `row` : Number The index of the row to deselect Returns: `void` | RowSelectionModel
| each( `Function fn`, [`Object scope`] ) : Boolean Calls the passed function with each selection. If the function returns false, iteration is stopped and this function ... Calls the passed function with each selection. If the function returns false, iteration is stopped and this function returns false. Otherwise it returns true. Parameters: `fn` : Function `scope` : Object (optional) Returns: `Boolean` true if all selections were iterated | RowSelectionModel
| fireEvent( `String eventName`, `Object... args` ) : Boolean Fires the specified event with the passed parameters (minus the event name). Fires the specified event with the passed parameters (minus the event name). Parameters: `eventName` : String `args` : Object... Variable number of parameters are passed to handlers Returns: `Boolean` returns false if any of the handlers return false otherwise it returns true | Observable
| getCount() : Number Gets the number of selected rows. Gets the number of selected rows. Parameters: None. Returns: `Number` | RowSelectionModel
| getSelected() : Record Returns the first selected record. Returns the first selected record. Parameters: None. Returns: `Record` | RowSelectionModel
| getSelections() : Array Returns the selected records Returns the selected records Parameters: None. Returns: `Array` Array of selected records | RowSelectionModel
| hasListener( `String eventName` ) : Boolean Checks to see if this object has any listeners for a specified event Checks to see if this object has any listeners for a specified event Parameters: `eventName` : String The name of the event to check for Returns: `Boolean` True if the event is being listened for, else false | Observable
| hasNext() : Boolean Returns true if there is a next record to select Returns true if there is a next record to select Parameters: None. Returns: `Boolean` | RowSelectionModel
| hasPrevious() : Boolean Returns true if there is a previous record to select Returns true if there is a previous record to select Parameters: None. Returns: `Boolean` | RowSelectionModel
| hasSelection() : Boolean Returns True if there is a selection. Returns True if there is a selection. Parameters: None. Returns: `Boolean` | RowSelectionModel
| isIdSelected( `String id` ) : Boolean Returns True if the specified record id is selected. Returns True if the specified record id is selected. Parameters: `id` : String The id of record to check Returns: `Boolean` | RowSelectionModel
| isLocked() : Boolean Returns true if the selections are locked. Returns true if the selections are locked. Parameters: None. Returns: `Boolean` | AbstractSelectionModel
| isSelected( `Number/Record record` ) : Boolean Returns True if the specified row is selected. Returns True if the specified row is selected. Parameters: `record` : Number/Record The record or index of the record to check Returns: `Boolean` | RowSelectionModel
| lock() : void Locks the selections. Locks the selections. Parameters: None. Returns: `void` | AbstractSelectionModel
| on( `String eventName`, `Function handler`, [`Object scope`], [`Object options`] ) : void Appends an event handler to this element (shorthand for addListener) Appends an event handler to this element (shorthand for addListener) Parameters: `eventName` : String The type of event to listen for `handler` : Function The method the event invokes `scope` : Object (optional) The scope in which to execute the handler function. The handler function's "this" context. `options` : Object (optional) Returns: `void` | Observable
| purgeListeners() : void Removes all listeners for this object Removes all listeners for this object Parameters: None. Returns: `void` | Observable
| removeListener( `String eventName`, `Function handler`, [`Object scope`] ) : void Removes a listener Removes a listener Parameters: `eventName` : String The type of event to listen for `handler` : Function The handler to remove `scope` : Object (optional) The scope (this object) for the handler Returns: `void` | Observable
| resumeEvents() : void Resume firing events. (see suspendEvents) Resume firing events. (see suspendEvents) Parameters: None. Returns: `void` | Observable
| selectAll() : void Selects all rows. Selects all rows. Parameters: None. Returns: `void` | RowSelectionModel
| selectFirstRow() : void Selects the first row in the grid. Selects the first row in the grid. Parameters: None. Returns: `void` | RowSelectionModel
| selectLastRow( [`Boolean keepExisting`] ) : void Select the last row. Select the last row. Parameters: `keepExisting` : Boolean (optional) True to keep existing selections Returns: `void` | RowSelectionModel
| selectNext( [`Boolean keepExisting`] ) : void Selects the row immediately following the last selected row. Selects the row immediately following the last selected row. Parameters: `keepExisting` : Boolean (optional) True to keep existing selections Returns: `void` | RowSelectionModel
| selectPrevious( [`Boolean keepExisting`] ) : void Selects the row that precedes the last selected row. Selects the row that precedes the last selected row. Parameters: `keepExisting` : Boolean (optional) True to keep existing selections Returns: `void` | RowSelectionModel
| selectRange( `Number startRow`, `Number endRow`, [`Boolean keepExisting`] ) : void Selects a range of rows. All rows in between startRow and endRow are also selected. Selects a range of rows. All rows in between startRow and endRow are also selected. Parameters: `startRow` : Number The index of the first row in the range `endRow` : Number The index of the last row in the range `keepExisting` : Boolean (optional) True to retain existing selections Returns: `void` | RowSelectionModel
| selectRecords( `Array records`, [`Boolean keepExisting`] ) : void Select records. Select records. Parameters: `records` : Array The records to select `keepExisting` : Boolean (optional) True to keep existing selections Returns: `void` | RowSelectionModel
| selectRow( `Number row`, [`Boolean keepExisting`] ) : void Selects a row. Selects a row. Parameters: `row` : Number The index of the row to select `keepExisting` : Boolean (optional) True to keep existing selections Returns: `void` | RowSelectionModel
| selectRows( `Array rows`, [`Boolean keepExisting`] ) : void Selects multiple rows. Selects multiple rows. Parameters: `rows` : Array Array of the indexes of the row to select `keepExisting` : Boolean (optional) True to keep existing selections Returns: `void` | RowSelectionModel
| suspendEvents() : void Suspend the firing of all events. (see resumeEvents) Suspend the firing of all events. (see resumeEvents) Parameters: None. Returns: `void` | Observable
| un( `String eventName`, `Function handler`, [`Object scope`] ) : void Removes a listener (shorthand for removeListener) Removes a listener (shorthand for removeListener) Parameters: `eventName` : String The type of event to listen for `handler` : Function The handler to remove `scope` : Object (optional) The scope (this object) for the handler Returns: `void` | Observable
| unlock() : void Unlocks the selections. Unlocks the selections. Parameters: None. Returns: `void` | AbstractSelectionModel

## Public Events

Event | Defined By
--- | ---
| beforerowselect : ( `SelectionModel this`, `Number rowIndex`, `Boolean keepExisting`, `Record record` ) Fires when a row is being selected, return false to cancel. Fires when a row is being selected, return false to cancel. Listeners will be called with the following arguments: `this` : SelectionModel `rowIndex` : Number The index to be selected `keepExisting` : Boolean False if other selections will be cleared `record` : Record The record to be selected | RowSelectionModel
| rowdeselect : ( `SelectionModel this`, `Number rowIndex`, `Record record` ) Fires when a row is deselected. Fires when a row is deselected. Listeners will be called with the following arguments: `this` : SelectionModel `rowIndex` : Number `record` : Record | RowSelectionModel
| rowselect : ( `SelectionModel this`, `Number rowIndex`, `Ext.data.Record r` ) Fires when a row is selected. Fires when a row is selected. Listeners will be called with the following arguments: `this` : SelectionModel `rowIndex` : Number The selected index `r` : Ext.data.Record The selected record | RowSelectionModel
| selectionchange : ( `SelectionModel this` ) Fires when the selection changes Fires when the selection changes Listeners will be called with the following arguments: `this` : SelectionModel | RowSelectionModel