Ext JS 3.4.0 Sencha Docs

Ext.grid.CheckboxSelectionModel

Hierarchy

Files

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

Available since: 2.3.0

Defined By

Config options

Ext.grid.CheckboxSelectionModel
view source
: Boolean

true if rows can only be selected by clicking on the checkbox column (defaults to false).

true if rows can only be selected by clicking on the checkbox column (defaults to false).

Available since: Ext JS 3.4.0

Ext.grid.CheckboxSelectionModel
view source
: String
Any valid text or HTML fragment to display in the header cell for the checkbox column. ...

Any valid text or HTML fragment to display in the header cell for the checkbox column. Defaults to:

'<div class="x-grid3-hd-checker">&#160;</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.

Defaults to: '<div class="x-grid3-hd-checker">&#160;</div>'

Available since: 2.3.0

(optional) A config object containing one or more event handlers to be added to this object during initialization. ...

(optional)

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.


DOM events from ExtJs Components


While some ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this

is usually only done when extra value can be added. For example the DataView's click event passing the node clicked on. To access DOM events directly from a Component's HTMLElement, listeners must be added to the Element after the Component has been rendered. A plugin can simplify this step:

// Plugin is configured with a listeners config object.
// The Component is appended to the argument list of all handler functions.
Ext.DomObserver = Ext.extend(Object, {
    constructor: function(config) {
        this.listeners = config.listeners ? config.listeners : config;
    },

    // Component passes itself into plugin's init method
    init: function(c) {
        var p, l = this.listeners;
        for (p in l) {
            if (Ext.isFunction(l[p])) {
                l[p] = this.createHandler(l[p], c);
            } else {
                l[p].fn = this.createHandler(l[p].fn, c);
            }
        }

        // Add the listeners to the Element immediately following the render call
        c.render = c.render.createSequence(function() {
            var e = c.getEl();
            if (e) {
                e.on(l);
            }
        });
    },

    createHandler: function(fn, c) {
        return function(e) {
            fn.call(this, e, c);
        };
    }
});

var combo = new Ext.form.ComboBox({

    // Collapse combo when its element is clicked on
    plugins: [ new Ext.DomObserver({
        click: function(evt, comp) {
            comp.collapse();
        }
    })],
    store: myStore,
    typeAhead: true,
    mode: 'local',
    triggerAction: 'all'
});

Available since: 1.1.0

false to turn off moving the editor to the next row down when the enter key is pressed or the next row up when shift ...

false to turn off moving the editor to the next row down when the enter key is pressed or the next row up when shift + enter keys are pressed.

Available since: 2.3.0

true to allow selection of only one row at a time (defaults to false allowing multiple selections) ...

true to allow selection of only one row at a time (defaults to false allowing multiple selections)

Defaults to: false

Available since: 1.1.0

Ext.grid.CheckboxSelectionModel
view source
: Boolean
true if the checkbox column is sortable (defaults to false). ...

true if the checkbox column is sortable (defaults to false).

Defaults to: false

Available since: 2.3.0

Ext.grid.CheckboxSelectionModel
view source
: Number
The default width in pixels of the checkbox column (defaults to 20). ...

The default width in pixels of the checkbox column (defaults to 20).

Defaults to: 20

Available since: 2.3.0

Defined By

Properties

Ext.grid.CheckboxSelectionModel
view source
: Stringprivate
...

Defaults to: ''

Available since: 2.3.0

Ext.grid.CheckboxSelectionModel
view source
: Booleanprivate
...

Defaults to: true

Available since: 2.3.0

The GridPanel for which this SelectionModel is handling selection. ...

The GridPanel for which this SelectionModel is handling selection. Read-only.

Available since: 2.3.0

Ext.grid.CheckboxSelectionModel
view source
: Booleanprivate
...

Defaults to: false

Available since: Ext JS 3.4.0

Ext.grid.CheckboxSelectionModel
view source
: Stringprivate
...

Defaults to: 'checker'

Available since: 2.3.0

Ext.grid.CheckboxSelectionModel
view source
: Booleanprivate
...

Defaults to: true

Available since: Ext JS 3.4.0

Ext.grid.CheckboxSelectionModel
view source
: Booleanprivate
private ...

private

Defaults to: true

Available since: 2.3.0

Defined By

Methods

So that ColumnModel doesn't feed this through the Column constructor ...

So that ColumnModel doesn't feed this through the Column constructor

Available since: 2.3.0

Returns

Overrides: Ext.grid.AbstractSelectionModel.constructor, Ext.grid.RowSelectionModel.constructor

private ...

private

Available since: Ext JS 3.4.0

Parameters

  • row : Object
  • col : Object
  • cm : Object
Adds the specified events to the list of events which this Observable may fire. ...

Adds the specified events to the list of events which this Observable may fire.

Available since: 1.1.0

Parameters

  • o : Object|String

    Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters.

  • Optional : string

    . Event name if multiple event names are being passed as separate parameters. Usage:

    this.addEvents('storeloaded', 'storecleared');
    
( eventName, handler, [scope], [options] )
Appends an event handler to this object. ...

Appends an event handler to this object.

Available since: 1.1.0

Parameters

  • eventName : String

    The name of the event to listen for.

  • handler : Function

    The method the event invokes.

  • scope : Object (optional)

    The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

  • options : Object (optional)

    An object containing handler configuration. properties. This may contain any of the following properties:

    • scope : Object
      The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.
    • 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.
    • target : Observable
      Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.

    Combining Options
    Using the options argument, it is possible to combine different types of listeners:

    A delayed, one-time listener.

    myDataView.on('click', this.onClick, this, {
    single: true,
    delay: 100
    });

    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.

    myGridPanel.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:

    myGridPanel.on({
    'click' : this.onClick,
    'mouseover' : this.onMouseOver,
    'mouseout' : this.onMouseOut,
     scope: this
    });

Fires

    Clears all selections if the selection model is not locked. ...

    Clears all selections if the selection model is not locked.

    Available since: 1.1.0

    Parameters

    • fast : Boolean (optional)

      true to bypass the conditional checks and events described in deselectRow.

    Fires

    Deselects a range of rows if the selection model is not locked. ...

    Deselects a range of rows if the selection model is not locked.
    All rows in between startRow and endRow are also deselected.

    Available since: 1.1.0

    Parameters

    • startRow : Number

      The index of the first row in the range

    • endRow : Number

      The index of the last row in the range

    Fires

    Deselects a row. ...

    Deselects a row. Before deselecting a row, checks if the selection model is locked. If this check is satisfied the row will be deselected and followed up by firing the rowdeselect and selectionchange events.

    Available since: 1.1.0

    Parameters

    • row : Number

      The index of the row to deselect

    • preventViewNotify : Boolean (optional)

      Specify true to prevent notifying the view (disables updating the selected appearance)

    Fires

    ...

    Available since: Ext JS 3.4.0

    Overrides: Ext.grid.AbstractSelectionModel.destroy

    Calls the passed function with each selection. ...

    Calls the passed function with each selection. If the function returns false, iteration is stopped and this function returns false. Otherwise it returns true.

    Available since: 2.3.0

    Parameters

    • fn : Function

      The function to call upon each iteration. It is passed the selected Record.

    • scope : Object (optional)

      The scope (this reference) in which the function is executed. Defaults to this RowSelectionModel.

    Returns

    • Boolean

      true if all selections were iterated

    Fires

      Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if present. ...

      Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if present. There is no implementation in the Observable base class.

      This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to access the required target more quickly.

      Example:

      Ext.override(Ext.form.Field, {
          //  Add functionality to Field's initComponent to enable the change event to bubble
          initComponent : Ext.form.Field.prototype.initComponent.createSequence(function() {
              this.enableBubble('change');
          }),
      
          //  We know that we want Field's events to bubble directly to the FormPanel.
          getBubbleTarget : function() {
              if (!this.formPanel) {
                  this.formPanel = this.findParentByType('form');
              }
              return this.formPanel;
          }
      });
      
      var myForm = new Ext.formPanel({
          title: 'User Details',
          items: [{
              ...
          }],
          listeners: {
              change: function() {
                  // Title goes red if form has been modified.
                  myForm.header.setStyle('color', 'red');
              }
          }
      });
      

      Available since: Ext JS 3.4.0

      Parameters

      • events : String/Array

        The event name to bubble, or an Array of event names.

      ( eventName, 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).

      An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) by calling enableBubble.

      Available since: 1.1.0

      Parameters

      • eventName : String

        The name of the event to fire.

      • 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.

      Fires

        Gets the number of selected rows. ...

        Gets the number of selected rows.

        Available since: 1.1.0

        Returns

        Returns the first selected record. ...

        Returns the first selected record.

        Available since: 1.1.0

        Returns

        • Record
        Returns the selected records ...

        Returns the selected records

        Available since: 1.1.0

        Returns

        • Array

          Array of selected records

        private ...

        private

        Available since: Ext JS 3.4.0

        Parameters

        • g : Object
        • rowIndex : Object
        • e : Object

        Fires

        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

        Available since: 1.1.0

        Parameters

        • eventName : String

          The name of the event to check for

        Returns

        • Boolean

          True if the event is being listened for, else false

        Returns true if there is a next record to select ...

        Returns true if there is a next record to select

        Available since: 2.3.0

        Returns

        • Boolean
        Returns true if there is a previous record to select ...

        Returns true if there is a previous record to select

        Available since: 2.3.0

        Returns

        • Boolean
        Returns true if there is a selection. ...

        Returns true if there is a selection.

        Available since: 1.1.0

        Returns

        • Boolean
        Ext.grid.CheckboxSelectionModel
        view source
        ( )private
        private ...

        private

        Available since: 2.3.0

        Overrides: Ext.grid.RowSelectionModel.initEvents

        Returns true if the specified record id is selected. ...

        Returns true if the specified record id is selected.

        Available since: 1.1.0

        Parameters

        • id : String

          The id of record to check

        Returns

        • Boolean
        Returns true if the selections are locked. ...

        Returns true if the selections are locked.

        Available since: 1.1.0

        Returns

        • Boolean
        Returns true if the specified row is selected. ...

        Returns true if the specified row is selected.

        Available since: 1.1.0

        Parameters

        • index : Number/Record

          The record or index of the record to check

        Returns

        • Boolean
        Locks the selections. ...

        Locks the selections.

        Available since: 1.1.0

        ( eventName, handler, [scope], [options] )
        Appends an event handler to this object (shorthand for addListener.) ...

        Appends an event handler to this object (shorthand for addListener.)

        Available since: 1.1.0

        Parameters

        • eventName : String

          The type of event to listen for

        • handler : Function

          The method the event invokes

        • scope : Object (optional)

          The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

        • options : Object (optional)

          An object containing handler configuration.

        private ...

        private

        Available since: Ext JS 3.4.0

        Parameters

        • field : Object
        • e : Object

        Fires

        Ext.grid.CheckboxSelectionModel
        view source
        ( row, lastRow )private
        ...

        Available since: Ext JS 3.4.0

        Parameters

        • row : Object
        • lastRow : Object

        Fires

        Overrides: Ext.grid.RowSelectionModel.onEditorSelect

        Ext.grid.CheckboxSelectionModel
        view source
        ( e, t )private
        private ...

        private

        Available since: 2.3.0

        Parameters

        • e : Object
        • t : Object

        Fires

        ...

        Available since: Ext JS 3.4.0

        Parameters

        • e : Object
        • name : Object

        Fires

        Ext.grid.CheckboxSelectionModel
        view source
        ( e, t )private
        private ...

        private

        Available since: 2.3.0

        Parameters

        • e : Object
        • t : Object

        Fires

        private ...

        private

        Available since: Ext JS 3.4.0

        Fires

        private ...

        private

        Available since: Ext JS 3.4.0

        Parameters

        • v : Object
        • index : Object
        • r : Object

        Fires

        private ...

        private

        Available since: Ext JS 3.4.0

        Parameters

        • v : Object
        • index : Object
        • r : Object

        Fires

          Ext.grid.CheckboxSelectionModel
          view source
          ( name, e, grid, rowIndex, colIndex )private
          Process and refire events routed from the GridView's processEvent method. ...

          Process and refire events routed from the GridView's processEvent method.

          Available since: Ext JS 3.4.0

          Parameters

          • name : Object
          • e : Object
          • grid : Object
          • rowIndex : Object
          • colIndex : Object

          Fires

          Removes all listeners for this object ...

          Removes all listeners for this object

          Available since: 1.1.0

          Relays selected events from the specified Observable as if the events were fired by this. ...

          Relays selected events from the specified Observable as if the events were fired by this.

          Available since: 2.3.0

          Parameters

          • o : Object

            The Observable whose events this object is to relay.

          • events : Array

            Array of event names to relay.

          ( eventName, handler, [scope] )
          Removes an event handler. ...

          Removes an event handler.

          Available since: 1.1.0

          Parameters

          • eventName : String

            The type of event the handler was associated with.

          • handler : Function

            The handler to remove. This must be a reference to the function passed into the addListener call.

          • scope : Object (optional)

            The scope originally specified for the handler.

          Ext.grid.CheckboxSelectionModel
          view source
          ( v, p, record )private
          private ...

          private

          Available since: 2.3.0

          Parameters

          • v : Object
          • p : Object
          • record : Object
          Resume firing events. ...

          Resume firing events. (see suspendEvents) If events were suspended using the queueSuspended parameter, then all events fired during event suspension will be sent to any listeners now.

          Available since: 2.3.0

          Selects all rows if the selection model is not locked. ...

          Selects all rows if the selection model is not locked.

          Available since: 1.1.0

          Fires

          Selects the first row in the grid. ...

          Selects the first row in the grid.

          Available since: 1.1.0

          Fires

          Select the last row. ...

          Select the last row.

          Available since: 1.1.0

          Parameters

          • keepExisting : Boolean (optional)

            true to keep existing selections

          Fires

          Selects the row immediately following the last selected row. ...

          Selects the row immediately following the last selected row.

          Available since: 1.1.0

          Parameters

          • keepExisting : Boolean (optional)

            true to keep existing selections

          Returns

          • Boolean

            true if there is a next row, else false

          Fires

          Selects the row that precedes the last selected row. ...

          Selects the row that precedes the last selected row.

          Available since: 1.1.0

          Parameters

          • keepExisting : Boolean (optional)

            true to keep existing selections

          Returns

          • Boolean

            true if there is a previous row, else false

          Fires

          ( startRow, endRow, [keepExisting] )
          Selects a range of rows if the selection model is not locked. ...

          Selects a range of rows if the selection model is not locked. All rows in between startRow and endRow are also selected.

          Available since: 1.1.0

          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

          Fires

          Select records. ...

          Select records.

          Available since: 1.1.0

          Parameters

          • records : Array

            The records to select

          • keepExisting : Boolean (optional)

            true to keep existing selections

          Fires

          ( row, [keepExisting], [preventViewNotify] )
          Selects a row. ...

          Selects a row. Before selecting a row, checks if the selection model is locked and fires the beforerowselect event. If these checks are satisfied the row will be selected and followed up by firing the rowselect and selectionchange events.

          Available since: 1.1.0

          Parameters

          • row : Number

            The index of the row to select

          • keepExisting : Boolean (optional)

            true to keep existing selections

          • preventViewNotify : Boolean (optional)

            Specify true to prevent notifying the view (disables updating the selected appearance)

          Fires

          Selects multiple rows. ...

          Selects multiple rows.

          Available since: 1.1.0

          Parameters

          • rows : Array

            Array of the indexes of the row to select

          • keepExisting : Boolean (optional)

            true to keep existing selections (defaults to false)

          Fires

          set the lock states before and after a view refresh ...

          set the lock states before and after a view refresh

          Available since: Ext JS 3.4.0

          set the lock states before and after a view refresh ...

          set the lock states before and after a view refresh

          Available since: Ext JS 3.4.0

          Suspend the firing of all events. ...

          Suspend the firing of all events. (see resumeEvents)

          Available since: 2.3.0

          Parameters

          • queueSuspended : Boolean

            Pass as true to queue up suspended events to be fired after the resumeEvents call instead of discarding all suspended events;

          ( eventName, handler, [scope] )
          Removes an event handler (shorthand for removeListener.) ...

          Removes an event handler (shorthand for removeListener.)

          Available since: 1.1.0

          Parameters

          • eventName : String

            The type of event the handler was associated with.

          • handler : Function

            The handler to remove. This must be a reference to the function passed into the addListener call.

          • scope : Object (optional)

            The scope originally specified for the handler.

          Unlocks the selections. ...

          Unlocks the selections.

          Available since: 1.1.0

          Defined By

          Events

          ( this, rowIndex, keepExisting, record )
          Fires before a row is selected, return false to cancel the selection. ...

          Fires before a row is selected, return false to cancel the selection.

          Available since: 1.1.0

          Parameters

          • 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

          Fires when a row is deselected. ...

          Fires when a row is deselected. To prevent deselection lock the selections.

          Available since: 1.1.0

          Parameters

          • this : SelectionModel
          • rowIndex : Number
          • record : Record
          Fires when a row is selected. ...

          Fires when a row is selected.

          Available since: 1.1.0

          Parameters

          Fires when the selection changes ...

          Fires when the selection changes

          Available since: 1.1.0

          Parameters

          • this : SelectionModel