Ext JS Sencha Docs

Ext.selection.CellModel

Hierarchy

Inherited mixins

Requires

Files

Defined By

Config options

Allow users to deselect a record in a DataView, List or Grid. ...

Allow users to deselect a record in a DataView, List or Grid. Only applicable when the mode is 'SINGLE'.

Ext.selection.CellModel
view source
: Boolean
Turns on/off keyboard navigation within the grid. ...

Turns on/off keyboard navigation within the grid.

Defaults to: true

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

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 Ext JS Components

While some Ext JS 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 itemclick event passing the node clicked on. To access DOM events directly from a child element of a Component, we need to specify the element option to identify the Component property to add a DOM listener to:

new Ext.panel.Panel({
    width: 400,
    height: 200,
    dockedItems: [{
        xtype: 'toolbar'
    }],
    listeners: {
        click: {
            element: 'el', //bind to the underlying el property on the panel
            fn: function(){ console.log('click el'); }
        },
        dblclick: {
            element: 'body', //bind to the underlying body property on the panel
            fn: function(){ console.log('dblclick body'); }
        }
    }
});
Ext.selection.CellModel
view source
: "SINGLE"
Mode of selection. ...

Mode of selection. Valid values are:

  • "SINGLE" - Only allows selecting one item at a time. This is the default.

Overrides: Ext.selection.Model.mode

Ext.selection.CellModel
view source
: Boolean
Set this configuration to true to prevent wrapping around of selection as a user navigates to the first or last column. ...

Set this configuration to true to prevent wrapping around of selection as a user navigates to the first or last column.

Defaults to: false

Remove records from the selection when they are removed from the store. ...

Remove records from the selection when they are removed from the store.

Important: When using paging or a sparsely populated (buffered) Store, records which are cached in the Store's data collection may be removed from the Store when pages change, or when rows are scrolled out of view. For this reason pruneRemoved should be set to false when using a buffered Store.

Also, when previously pruned pages are returned to the cache, the records objects in the page will be new instances, and will not match the instances in the selection model's collection. For this reason, you MUST ensure that the Model definition's idProperty references a unique key because in this situation, records in the Store have their IDs compared to records in the SelectionModel in order to re-select a record which is scrolled back into view.

Defaults to: true

true to toggle the selection state of an item when clicked. ...

true to toggle the selection state of an item when clicked. Only applicable when the mode is 'SINGLE'. Only applicable when the allowDeselect is 'true'.

Defaults to: true

Properties

Defined By

Instance properties

...

Defaults to: 'Ext.Base'

...

Defaults to: {}

Initial suspended call count. ...

Initial suspended call count. Incremented when suspendEvents is called, decremented when resumeEvents is called.

Defaults to: 0

This object holds a key for any event that has a listener. ...

This object holds a key for any event that has a listener. The listener may be set directly on the instance, or on its class or a super class (via observe) or on the MVC EventBus. The values of this object are truthy (a non-zero number) and falsy (0 or undefined). They do not represent an exact count of listeners. The value for an event is truthy if the event must be fired and is falsy if there is no need to fire the event.

The intended use of this property is to avoid the expense of fireEvent calls when there are no listeners. This can be particularly helpful when one would otherwise have to call fireEvent hundreds or thousands of times. It is used like this:

 if (this.hasListeners.foo) {
     this.fireEvent('foo', this, arg1);
 }
...

Defaults to: []

...

Defaults to: {}

...

Defaults to: true

true in this class to identify an object as an instantiated Observable, or subclass thereof. ...

true in this class to identify an object as an instantiated Observable, or subclass thereof.

Defaults to: true

Ext.selection.CellModel
view source
: Objectprivate

private property to use when firing a deselect when no old selection exists.

private property to use when firing a deselect when no old selection exists.

A MixedCollection that maintains all of the currently selected records. ...

A MixedCollection that maintains all of the currently selected records.

Get the reference to the current class from which this object was instantiated. ...

Get the reference to the current class from which this object was instantiated. Unlike statics, this.self is scope-dependent and it's meant to be used for dynamic inheritance. See statics for a detailed comparison

Ext.define('My.Cat', {
    statics: {
        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
    },

    constructor: function() {
        alert(this.self.speciesName); // dependent on 'this'
    },

    clone: function() {
        return new this.self();
    }
});


Ext.define('My.SnowLeopard', {
    extend: 'My.Cat',
    statics: {
        speciesName: 'Snow Leopard'         // My.SnowLeopard.speciesName = 'Snow Leopard'
    }
});

var cat = new My.Cat();                     // alerts 'Cat'
var snowLeopard = new My.SnowLeopard();     // alerts 'Snow Leopard'

var clone = snowLeopard.clone();
alert(Ext.getClassName(clone));             // alerts 'My.SnowLeopard'
Defined By

Static properties

...

Defaults to: []

Methods

Defined By

Instance methods

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.

Parameters

  • eventNames : Object/String...

    Either an object with event names as properties with a value of true. For example:

    this.addEvents({
        storeloaded: true,
        storecleared: true
    });
    

    Or any number of event names as separate parameters. For example:

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

Appends an event handler to this object. For example:

myGridPanel.on("mouseover", this.onMouseOver, this);

The method also allows for a single argument to be passed which is a config object containing properties which specify multiple events. For example:

myGridPanel.on({
    cellClick: this.onCellClick,
    mouseover: this.onMouseOver,
    mouseout: this.onMouseOut,
    scope: this // Important. Ensure "this" is correct during handler execution
});

One can also specify options for each event handler separately:

myGridPanel.on({
    cellClick: {fn: this.onCellClick, scope: this, single: true},
    mouseover: {fn: panel.onMouseOver, scope: panel}
});

Names of methods in a specified scope may also be used. Note that scope MUST be specified to use this option:

myGridPanel.on({
    cellClick: {fn: 'onCellClick', scope: this, single: true},
    mouseover: {fn: 'onMouseOver', scope: panel}
});

Parameters

  • eventName : String/Object

    The name of the event to listen for. May also be an object who's property names are event names.

  • fn : Function (optional)

    The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below.

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

    Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.

    This object 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 : Ext.util.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.

    • element : String

      This option is only valid for listeners bound to Components. The name of a Component property which references an element to add a listener to.

      This option is useful during Component construction to add DOM event listeners to elements of Components which will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:

        new Ext.panel.Panel({
            title: 'The title',
            listeners: {
                click: this.handlePanelClick,
                element: 'body'
            }
        });
      
    • destroyable : Boolean (optional)

      When specified as true, the function returns A Destroyable object. An object which implements the destroy method which removes all listeners added in this call.

      Defaults to: false

    • priority : Number (optional)

      An optional numeric priority that determines the order in which event handlers are run. Event handlers with no priority will be run as if they had a priority of 0. Handlers with a higher priority will be prioritized to run sooner than those with a lower priority. Negative numbers can be used to set a priority lower than the default. Internally, the framework uses a range of 1000 or greater, and -1000 or lesser for handers that are intended to run before or after all others, so it is recommended to stay within the range of -999 to 999 when setting the priority of event handlers in application-level code.

      Combining Options

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

      A delayed, one-time listener.

      myPanel.on('hide', this.handleClick, this, {
          single: true,
          delay: 100
      });
      

Returns

  • Object

    Only when the destroyable option is specified.

    A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

    this.btnListeners =  = myButton.on({
        destroyable: true
        mouseover:   function() { console.log('mouseover'); },
        mouseout:    function() { console.log('mouseout'); },
        click:       function() { console.log('click'); }
    });
    

    And when those listeners need to be removed:

    Ext.destroy(this.btnListeners);
    

    or

    this.btnListeners.destroy();
    

Overrides: Ext.AbstractComponent.addListener

( item, ename, [fn], [scope], [options] ) : Object
Adds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is destr...

Adds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is destroyed.

Parameters

  • item : Ext.util.Observable/Ext.Element

    The item to which to add a listener/listeners.

  • ename : Object/String

    The event name, or an object containing event name properties.

  • fn : Function (optional)

    If the ename parameter was an event name, this is the handler function.

  • scope : Object (optional)

    If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

  • options : Object (optional)

    If the ename parameter was an event name, this is the addListener options.

Returns

  • Object

    Only when the destroyable option is specified.

    A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

    this.btnListeners =  = myButton.mon({
        destroyable: true
        mouseover:   function() { console.log('mouseover'); },
        mouseout:    function() { console.log('mouseout'); },
        click:       function() { console.log('click'); }
    });
    

    And when those listeners need to be removed:

    Ext.destroy(this.btnListeners);
    

    or

    this.btnListeners.destroy();
    
Private Called after a new record has been navigated to by a keystroke. ...

Private Called after a new record has been navigated to by a keystroke. Event is passed so that shift and ctrl can be handled.

Parameters

Fires

Ext.selection.CellModel
view source
( view )private
binds the store to the selModel. ...

binds the store to the selModel.

Parameters

Fires

Overrides: Ext.util.Bindable.bindStore

Binds listeners for this component to the store. ...

Binds listeners for this component to the store. By default it will add anything bound by the getStoreListeners method, however it can be overridden in a subclass to provide any more complicated handling.

Parameters

( args ) : Objectdeprecatedprotected
Call the original method that was previously overridden with override Ext.define('My.Cat', { constructor: functi...

Call the original method that was previously overridden with override

Ext.define('My.Cat', {
    constructor: function() {
        alert("I'm a cat!");
    }
});

My.Cat.override({
    constructor: function() {
        alert("I'm going to be a cat!");

        this.callOverridden();

        alert("Meeeeoooowwww");
    }
});

var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
                          // alerts "I'm a cat!"
                          // alerts "Meeeeoooowwww"

This method has been deprected

as of 4.1. Use callParent instead.

Parameters

  • args : Array/Arguments

    The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments)

Returns

  • Object

    Returns the result of calling the overridden method

Call the "parent" method of the current method. ...

Call the "parent" method of the current method. That is the method previously overridden by derivation or by an override (see Ext.define).

 Ext.define('My.Base', {
     constructor: function (x) {
         this.x = x;
     },

     statics: {
         method: function (x) {
             return x;
         }
     }
 });

 Ext.define('My.Derived', {
     extend: 'My.Base',

     constructor: function () {
         this.callParent([21]);
     }
 });

 var obj = new My.Derived();

 alert(obj.x);  // alerts 21

This can be used with an override as follows:

 Ext.define('My.DerivedOverride', {
     override: 'My.Derived',

     constructor: function (x) {
         this.callParent([x*2]); // calls original My.Derived constructor
     }
 });

 var obj = new My.Derived();

 alert(obj.x);  // now alerts 42

This also works with static methods.

 Ext.define('My.Derived2', {
     extend: 'My.Base',

     statics: {
         method: function (x) {
             return this.callParent([x*2]); // calls My.Base.method
         }
     }
 });

 alert(My.Base.method(10);     // alerts 10
 alert(My.Derived2.method(10); // alerts 20

Lastly, it also works with overridden static methods.

 Ext.define('My.Derived2Override', {
     override: 'My.Derived2',

     statics: {
         method: function (x) {
             return this.callParent([x*2]); // calls My.Derived2.method
         }
     }
 });

 alert(My.Derived2.method(10); // now alerts 40

To override a method and replace it and also call the superclass method, use callSuper. This is often done to patch a method to fix a bug.

Parameters

  • args : Array/Arguments

    The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments)

Returns

  • Object

    Returns the result of calling the parent method

This method is used by an override to call the superclass method but bypass any overridden method. ...

This method is used by an override to call the superclass method but bypass any overridden method. This is often done to "patch" a method that contains a bug but for whatever reason cannot be fixed directly.

Consider:

 Ext.define('Ext.some.Class', {
     method: function () {
         console.log('Good');
     }
 });

 Ext.define('Ext.some.DerivedClass', {
     method: function () {
         console.log('Bad');

         // ... logic but with a bug ...

         this.callParent();
     }
 });

To patch the bug in DerivedClass.method, the typical solution is to create an override:

 Ext.define('App.paches.DerivedClass', {
     override: 'Ext.some.DerivedClass',

     method: function () {
         console.log('Fixed');

         // ... logic but with bug fixed ...

         this.callSuper();
     }
 });

The patch method cannot use callParent to call the superclass method since that would call the overridden method containing the bug. In other words, the above patch would only produce "Fixed" then "Good" in the console log, whereas, using callParent would produce "Fixed" then "Bad" then "Good".

Parameters

  • args : Array/Arguments

    The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments)

Returns

  • Object

    Returns the result of calling the superclass method

...

Parameters

Removes all listeners for this object including the managed listeners ...

Removes all listeners for this object including the managed listeners

Removes all managed listeners for this object. ...

Removes all managed listeners for this object.

A fast reset of the selections without firing events, updating the ui, etc. ...

A fast reset of the selections without firing events, updating the ui, etc. For private usage only.

Fires

( eventName, args, bubbles )private
Continue to fire event. ...

Continue to fire event.

Parameters

Creates an event handling function which refires the event from this object as the passed event name. ...

Creates an event handling function which refires the event from this object as the passed event name.

Parameters

  • newName : String

    The name under which to refire the passed parameters.

  • beginEnd : Array (optional)

    The caller can specify on which indices to slice.

Returns

Ext.selection.CellModel
view source
( record, suppressEvent )
Deselects a record instance by record instance or index. ...

Deselects a record instance by record instance or index.

Parameters

Fires

Overrides: Ext.selection.Model.deselect

Deselects all records in the view. ...

Deselects all records in the view.

Parameters

  • suppressEvent : Boolean (optional)

    True to suppress any deselect events

Fires

Called by subclasses to deselect records upon detection of deletion from the store ...

Called by subclasses to deselect records upon detection of deletion from the store

Parameters

Fires

( toSelect, selected, suppressEvent )private
...

Parameters

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.

Parameters

Fires

cleanup. ...

cleanup.

Overrides: Ext.Base.destroy

( records, suppressEvent )private
records can be an index, a record or an array of records ...

records can be an index, a record or an array of records

Parameters

Fires

Ext.selection.CellModel
view source
( direction, e )private
...

Parameters

Fires

( records, keepExisting, suppressEvent )private
...

Parameters

Fires

( records, keepExisting, suppressEvent )private
...

Parameters

Fires

( record, suppressEvent )private
...

Parameters

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.define('Ext.overrides.form.field.Base', {
    override: 'Ext.form.field.Base',

    //  Add functionality to Field's initComponent to enable the change event to bubble
    initComponent: function () {
        this.callParent();
        this.enableBubble('change');
    }
});

var myForm = Ext.create('Ext.form.Panel', {
    title: 'User Details',
    items: [{
        ...
    }],
    listeners: {
        change: function() {
            // Title goes red if form has been modified.
            myForm.header.setStyle('color', 'red');
        }
    }
});

Parameters

  • eventNames : String/String[]

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

Fires the specified event with the passed parameters (minus the event name, plus the options object passed to addList...

Fires the specified event with the passed parameters (minus the event name, plus the options object passed to addListener).

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

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 the specified event with the passed parameter list. ...

Fires the specified event with the passed parameter list.

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

Parameters

  • eventName : String

    The name of the event to fire.

  • args : Object[]

    An array of parameters which are passed to handlers.

Returns

  • Boolean

    returns false if any of the handlers return false otherwise it returns true.

Gets the bubbling parent for an Observable ...

Gets the bubbling parent for an Observable

Returns

...

Parameters

Returns the count of selected records. ...

Returns the count of selected records.

Returns

  • Number

    The number of selected records

Ext.selection.CellModel
view source
( )
Returns the current position in the format {row: row, column: column} ...

Returns the current position in the format {row: row, column: column}

Ext.selection.CellModel
view source
( )private
...
Returns the initial configuration passed to constructor when instantiating this class. ...

Returns the initial configuration passed to constructor when instantiating this class.

Parameters

  • name : String (optional)

    Name of the config option to return.

Returns

  • Object/Mixed

    The full config object or a single config value when name parameter specified.

...

Returns

Returns an array of the currently selected records. ...

Returns an array of the currently selected records.

Returns

...

Parameters

Returns the current selectionMode. ...

Returns the current selectionMode.

Returns

  • String

    The selectionMode: 'SINGLE', 'MULTI' or 'SIMPLE'.

Gets the current store instance. ...

Gets the current store instance.

Returns

Gets the listeners to bind to a new store. ...

Gets the listeners to bind to a new store.

Returns

  • Object

    The listeners to be bound to the store in object literal form. The scope may be omitted, it is assumed to be the current instance.

Overrides: Ext.util.Bindable.getStoreListeners

...

Parameters

Checks to see if this object has any listeners for a specified event, or whether the event bubbles. ...

Checks to see if this object has any listeners for a specified event, or whether the event bubbles. The answer indicates whether the event needs firing or not.

Parameters

  • eventName : String

    The name of the event to check for

Returns

  • Boolean

    true if the event is being listened for or bubbles, else false

Returns true if there are any a selected records. ...

Returns true if there are any a selected records.

Returns

( config ) : Ext.Basechainableprotected
Initialize configuration for this class. ...

Initialize configuration for this class. a typical example:

Ext.define('My.awesome.Class', {
    // The default config
    config: {
        name: 'Awesome',
        isAwesome: true
    },

    constructor: function(config) {
        this.initConfig(config);
    }
});

var awesome = new My.awesome.Class({
    name: 'Super Awesome'
});

alert(awesome.getName()); // 'Super Awesome'

Parameters

Returns

Ext.selection.CellModel
view source
( view )private
...

Parameters

Ext.selection.CellModel
view source
( view, row, column )private
...

Parameters

Determines if this record is currently focused. ...

Determines if this record is currently focused.

Parameters

Returns true if the selections are locked. ...

Returns true if the selections are locked.

Returns

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

Returns true if the specified row is selected.

Parameters

Returns

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

Returns true if the specified row is selected.

Parameters

Returns

fire selection change as long as true is not passed into maybeFireSelectionChange ...

fire selection change as long as true is not passed into maybeFireSelectionChange

Parameters

Fires

( item, ename, [fn], [scope], [options] ) : Object
Shorthand for addManagedListener. ...

Shorthand for addManagedListener.

Parameters

  • item : Ext.util.Observable/Ext.Element

    The item to which to add a listener/listeners.

  • ename : Object/String

    The event name, or an object containing event name properties.

  • fn : Function (optional)

    If the ename parameter was an event name, this is the handler function.

  • scope : Object (optional)

    If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

  • options : Object (optional)

    If the ename parameter was an event name, this is the addListener options.

Returns

  • Object

    Only when the destroyable option is specified.

    A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

    this.btnListeners =  = myButton.mon({
        destroyable: true
        mouseover:   function() { console.log('mouseover'); },
        mouseout:    function() { console.log('mouseout'); },
        click:       function() { console.log('click'); }
    });
    

    And when those listeners need to be removed:

    Ext.destroy(this.btnListeners);
    

    or

    this.btnListeners.destroy();
    
Ext.selection.CellModel
view source
( dir, e )private
...

Parameters

Fires

( item, ename, [fn], [scope] )
Shorthand for removeManagedListener. ...

Shorthand for removeManagedListener.

Parameters

  • item : Ext.util.Observable/Ext.Element

    The item from which to remove a listener/listeners.

  • ename : Object/String

    The event name, or an object containing event name properties.

  • fn : Function (optional)

    If the ename parameter was an event name, this is the handler function.

  • scope : Object (optional)

    If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

...

Parameters

( eventName, [fn], [scope], [options] ) : Object
Shorthand for addListener. ...

Shorthand for addListener.

Parameters

  • eventName : String/Object

    The name of the event to listen for. May also be an object who's property names are event names.

  • fn : Function (optional)

    The method the event invokes, or if scope is specified, the name* of the method within the specified scope. Will be called with arguments given to Ext.util.Observable.fireEvent plus the options parameter described below.

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

    Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.

    This object 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 : Ext.util.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.

    • element : String

      This option is only valid for listeners bound to Components. The name of a Component property which references an element to add a listener to.

      This option is useful during Component construction to add DOM event listeners to elements of Components which will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:

        new Ext.panel.Panel({
            title: 'The title',
            listeners: {
                click: this.handlePanelClick,
                element: 'body'
            }
        });
      
    • destroyable : Boolean (optional)

      When specified as true, the function returns A Destroyable object. An object which implements the destroy method which removes all listeners added in this call.

      Defaults to: false

    • priority : Number (optional)

      An optional numeric priority that determines the order in which event handlers are run. Event handlers with no priority will be run as if they had a priority of 0. Handlers with a higher priority will be prioritized to run sooner than those with a lower priority. Negative numbers can be used to set a priority lower than the default. Internally, the framework uses a range of 1000 or greater, and -1000 or lesser for handers that are intended to run before or after all others, so it is recommended to stay within the range of -999 to 999 when setting the priority of event handlers in application-level code.

      Combining Options

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

      A delayed, one-time listener.

      myPanel.on('hide', this.handleClick, this, {
          single: true,
          delay: 100
      });
      

Returns

  • Object

    Only when the destroyable option is specified.

    A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

    this.btnListeners =  = myButton.on({
        destroyable: true
        mouseover:   function() { console.log('mouseover'); },
        mouseout:    function() { console.log('mouseout'); },
        click:       function() { console.log('click'); }
    });
    

    And when those listeners need to be removed:

    Ext.destroy(this.btnListeners);
    

    or

    this.btnListeners.destroy();
    
( store, initial )protected
Template method, it is called when a new store is bound to the current instance. ...

Template method, it is called when a new store is bound to the current instance.

Parameters

Ext.selection.CellModel
view source
( view, cell, cellIndex, record, row, recordIndex, e )private
Set the current position based on where the user clicks. ...

Set the current position based on where the user clicks. IMPORTANT* Due to V4.0.0 history, the cellIndex here is the index within ALL columns, including hidden.

Parameters

Fires

Ext.selection.CellModel
view source
( position, supressEvent )private
notify view that the cell has been deselected to update the ui appropriately ...

notify view that the cell has been deselected to update the ui appropriately

Parameters

Fires

Ext.selection.CellModel
view source
( position, supressEvent )private
notify the view that the cell has been selected to update the ui appropriately and bring the cell into focus ...

notify the view that the cell has been selected to update the ui appropriately and bring the cell into focus

Parameters

Fires

Ext.selection.CellModel
view source
( headerCt, header, fromIdx, toIdx )private
When grid uses optimizedColumnMove (the default), this is added as a columnmove handler to correctly maintain the sel...

When grid uses optimizedColumnMove (the default), this is added as a columnmove handler to correctly maintain the selected column using the same column header.

If optimizedColumnMove === false, (which some grid Features set) then the view is refreshed, so this is not added as a handler because the selected column.

Parameters

Fires

( names, callback, scope )private
...

Parameters

Ext.selection.CellModel
view source
( editingPlugin, e )private
...

Parameters

Fires

Ext.selection.CellModel
view source
( e )private
...
Ext.selection.CellModel
view source
( e )private
...
Ext.selection.CellModel
view source
( e )private
...
Ext.selection.CellModel
view source
( e, t )private
Tab key from the View's KeyNav, not from an editor. ...

Tab key from the View's KeyNav, not from an editor.

Parameters

Fires

Ext.selection.CellModel
view source
( e )private
...
( oldFocused, newFocused )abstractprivate
...

Parameters

Fires

( store, model, oldId, newId, oldInternalId )private
...

Parameters

Ext.selection.CellModel
view source
( record, isSelected, suppressEvent, commitFn )private
...

Parameters

Overrides: Ext.selection.Model.onSelectChange

Ext.selection.CellModel
view source
( )private
when a record is added to a store ...

when a record is added to a store

Fires

Overrides: Ext.selection.Model.onStoreAdd

when a store is cleared remove all selections (if there were any) ...

when a store is cleared remove all selections (if there were any)

Fires

Ext.selection.CellModel
view source
( store, records, indexes )private
Keep selection model in consistent state upon record deletion. ...

Keep selection model in consistent state upon record deletion.

Parameters

Fires

Overrides: Ext.selection.Model.onStoreRemove

if records are updated ...

if records are updated

Template method, it is called when an existing store is unbound from the current instance. ...

Template method, it is called when an existing store is unbound from the current instance.

Parameters

Ext.selection.CellModel
view source
( record )private
Called when the contents of the node are updated, perform any processing here. ...

Called when the contents of the node are updated, perform any processing here.

Parameters

Overrides: Ext.selection.Model.onUpdate

Ext.selection.CellModel
view source
( view )private
...

Parameters

Fires

Prepares a given class for observable instances. ...

Prepares a given class for observable instances. This method is called when a class derives from this class or uses this class as a mixin.

Parameters

  • T : Function

    The class constructor to prepare.

Ext.selection.CellModel
view source
( )private
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.

For example if you are extending Grid, you might decide to forward some events from store. So you can do this inside your initComponent:

this.relayEvents(this.getStore(), ['load']);

The grid instance will then have an observable 'load' event which will be passed the parameters of the store's load event and any function fired with the grid's load event would have access to the grid using the this keyword.

Parameters

  • origin : Object

    The Observable whose events this object is to relay.

  • events : String[]

    Array of event names to relay.

  • prefix : String (optional)

    A common prefix to prepend to the event names. For example:

    this.relayEvents(this.getStore(), ['load', 'clear'], 'store');
    

    Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'.

Returns

  • Object

    A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example:

    this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store');
    

    Can be undone by calling

    Ext.destroy(this.storeRelayers);
    

    or this.store.relayers.destroy();

Removes an event handler. ...

Removes an event handler.

Parameters

  • eventName : String

    The type of event the handler was associated with.

  • fn : Function

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

  • scope : Object (optional)

    The scope originally specified for the handler. It must be the same as the scope argument specified in the original call to Ext.util.Observable.addListener or the listener will not be removed.

Removes listeners that were added by the mon method. ...

Removes listeners that were added by the mon method.

Parameters

  • item : Ext.util.Observable/Ext.Element

    The item from which to remove a listener/listeners.

  • ename : Object/String

    The event name, or an object containing event name properties.

  • fn : Function (optional)

    If the ename parameter was an event name, this is the handler function.

  • scope : Object (optional)

    If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

Remove a single managed listener item ...

Remove a single managed listener item

Parameters

  • isClear : Boolean

    True if this is being called during a clear

  • managedListener : Object

    The managed listener item See removeManagedListener for other args

Overrides: Ext.AbstractComponent.removeManagedListenerItem

Resumes firing of the named event(s). ...

Resumes firing of the named event(s).

After calling this method to resume events, the events will fire when requested to fire.

Note that if the suspendEvent method is called multiple times for a certain event, this converse method will have to be called the same number of times for it to resume firing.

Parameters

  • eventName : String...

    Multiple event names to resume.

Resumes firing events (see suspendEvents). ...

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

Ext.selection.CellModel
view source
( pos, keepExisting, suppressEvent )
Selects a record instance by record instance or index. ...

Selects a record instance by record instance or index.

Parameters

Fires

Overrides: Ext.selection.Model.select

Selects all records in the view. ...

Selects all records in the view.

Parameters

  • suppressEvent : Boolean

    True to suppress any select events

Fires

Ext.selection.CellModel
view source
( position, suppressEvent )private
...

Parameters

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.

Parameters

Fires

Provides differentiation of logic between MULTI, SIMPLE and SINGLE selection modes. ...

Provides differentiation of logic between MULTI, SIMPLE and SINGLE selection modes. Requires that an event be passed so that we can know if user held ctrl or shift.

Parameters

Fires

( config, applyIfNotSet ) : Ext.Basechainableprivate
...

Parameters

Returns

Ext.selection.CellModel
view source
( position, suppressEvent )
Sets the current position ...

Sets the current position

Parameters

  • position : Object

    The position to set.

  • suppressEvent : Boolean

    True to suppress selection events

Fires

Sets a record as the last focused record. ...

Sets a record as the last focused record. This does NOT mean that the record has been selected.

Parameters

Fires

Locks the current selection and disables any changes from happening to the selection. ...

Locks the current selection and disables any changes from happening to the selection.

Parameters

  • locked : Boolean

    True to lock, false to unlock.

Sets the current selectionMode. ...

Sets the current selectionMode.

Parameters

  • selMode : String

    'SINGLE', 'MULTI' or 'SIMPLE'.

Get the reference to the class from which this object was instantiated. ...

Get the reference to the class from which this object was instantiated. Note that unlike self, this.statics() is scope-independent and it always returns the class from which it was called, regardless of what this points to during run-time

Ext.define('My.Cat', {
    statics: {
        totalCreated: 0,
        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
    },

    constructor: function() {
        var statics = this.statics();

        alert(statics.speciesName);     // always equals to 'Cat' no matter what 'this' refers to
                                        // equivalent to: My.Cat.speciesName

        alert(this.self.speciesName);   // dependent on 'this'

        statics.totalCreated++;
    },

    clone: function() {
        var cloned = new this.self;                      // dependent on 'this'

        cloned.groupName = this.statics().speciesName;   // equivalent to: My.Cat.speciesName

        return cloned;
    }
});


Ext.define('My.SnowLeopard', {
    extend: 'My.Cat',

    statics: {
        speciesName: 'Snow Leopard'     // My.SnowLeopard.speciesName = 'Snow Leopard'
    },

    constructor: function() {
        this.callParent();
    }
});

var cat = new My.Cat();                 // alerts 'Cat', then alerts 'Cat'

var snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'

var clone = snowLeopard.clone();
alert(Ext.getClassName(clone));         // alerts 'My.SnowLeopard'
alert(clone.groupName);                 // alerts 'Cat'

alert(My.Cat.totalCreated);             // alerts 3

Returns

We need this special check because we could have a model without an idProperty. ...

We need this special check because we could have a model without an idProperty. getById() is fast, so we use that if possible, otherwise we need to check the internalId

Parameters

Suspends firing of the named event(s). ...

Suspends firing of the named event(s).

After calling this method to suspend events, the events will no longer fire when requested to fire.

Note that if this is called multiple times for a certain event, the converse method resumeEvent will have to be called the same number of times for it to resume firing.

Parameters

  • eventName : String...

    Multiple event names to suspend.

Suspends the firing of all events. ...

Suspends the firing of all events. (see resumeEvents)

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, fn, [scope] )
Shorthand for removeListener. ...

Shorthand for removeListener.

Parameters

  • eventName : String

    The type of event the handler was associated with.

  • fn : Function

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

  • scope : Object (optional)

    The scope originally specified for the handler. It must be the same as the scope argument specified in the original call to Ext.util.Observable.addListener or the listener will not be removed.

Unbinds listeners from this component to the store. ...

Unbinds listeners from this component to the store. By default it will remove anything bound by the bindStoreListeners method, however it can be overridden in a subclass to provide any more complicated handling.

Parameters

Defined By

Static methods

( config )privatestatic
...

Parameters

( members )chainableprivatestatic
...

Parameters

( name, member )chainableprivatestatic
...

Parameters

( members )chainablestatic
Add methods / properties to the prototype of this class. ...

Add methods / properties to the prototype of this class.

Ext.define('My.awesome.Cat', {
    constructor: function() {
        ...
    }
});

 My.awesome.Cat.addMembers({
     meow: function() {
        alert('Meowww...');
     }
 });

 var kitty = new My.awesome.Cat;
 kitty.meow();

Parameters

( members ) : Ext.Basechainablestatic
Add / override static properties of this class. ...

Add / override static properties of this class.

Ext.define('My.cool.Class', {
    ...
});

My.cool.Class.addStatics({
    someProperty: 'someValue',      // My.cool.Class.someProperty = 'someValue'
    method1: function() { ... },    // My.cool.Class.method1 = function() { ... };
    method2: function() { ... }     // My.cool.Class.method2 = function() { ... };
});

Parameters

Returns

( xtype )chainableprivatestatic
...

Parameters

( fromClass, members ) : Ext.Basechainableprivatestatic
Borrow another class' members to the prototype of this class. ...

Borrow another class' members to the prototype of this class.

Ext.define('Bank', {
    money: '$$$',
    printMoney: function() {
        alert('$$$$$$$');
    }
});

Ext.define('Thief', {
    ...
});

Thief.borrow(Bank, ['money', 'printMoney']);

var steve = new Thief();

alert(steve.money); // alerts '$$$'
steve.printMoney(); // alerts '$$$$$$$'

Parameters

  • fromClass : Ext.Base

    The class to borrow members from

  • members : Array/String

    The names of the members to borrow

Returns

Create a new instance of this Class. ...

Create a new instance of this Class.

Ext.define('My.cool.Class', {
    ...
});

My.cool.Class.create({
    someConfig: true
});

All parameters are passed to the constructor of the class.

Returns

Overrides: Ext.layout.Layout.create

( alias, origin )static
Create aliases for existing prototype methods. ...

Create aliases for existing prototype methods. Example:

Ext.define('My.cool.Class', {
    method1: function() { ... },
    method2: function() { ... }
});

var test = new My.cool.Class();

My.cool.Class.createAlias({
    method3: 'method1',
    method4: 'method2'
});

test.method3(); // test.method1()

My.cool.Class.createAlias('method5', 'method3');

test.method5(); // test.method3() -> test.method1()

Parameters

( config )privatestatic
...

Parameters

Get the current class' name in string format. ...

Get the current class' name in string format.

Ext.define('My.cool.Class', {
    constructor: function() {
        alert(this.self.getName()); // alerts 'My.cool.Class'
    }
});

My.cool.Class.getName(); // 'My.cool.Class'

Returns

( )deprecatedstatic
Adds members to class. ...

Adds members to class.

This method has been deprected since 4.1

Use addMembers instead.

( name, mixinClass )privatestatic
Used internally by the mixins pre-processor ...

Used internally by the mixins pre-processor

Parameters

( fn, scope )chainableprivatestatic
...

Parameters

( members ) : Ext.Basechainabledeprecatedstatic
Override members of this class. ...

Override members of this class. Overridden methods can be invoked via callParent.

Ext.define('My.Cat', {
    constructor: function() {
        alert("I'm a cat!");
    }
});

My.Cat.override({
    constructor: function() {
        alert("I'm going to be a cat!");

        this.callParent(arguments);

        alert("Meeeeoooowwww");
    }
});

var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
                          // alerts "I'm a cat!"
                          // alerts "Meeeeoooowwww"

As of 4.1, direct use of this method is deprecated. Use Ext.define instead:

Ext.define('My.CatOverride', {
    override: 'My.Cat',
    constructor: function() {
        alert("I'm going to be a cat!");

        this.callParent(arguments);

        alert("Meeeeoooowwww");
    }
});

The above accomplishes the same result but can be managed by the Ext.Loader which can properly order the override and its target class and the build process can determine whether the override is needed based on the required state of the target class (My.Cat).

This method has been deprected since 4.1.0

Use Ext.define instead

Parameters

  • members : Object

    The properties to add to this class. This should be specified as an object literal containing one or more properties.

Returns

Defined By

Events

Ext.selection.CellModel
view source
( this, record, row, column, eOpts )
Fired after a cell is deselected ...

Fired after a cell is deselected

Parameters

( this, oldFocused, newFocused, eOpts )
Fired when a row is focused ...

Fired when a row is focused

Parameters

Ext.selection.CellModel
view source
( this, record, row, column, eOpts )
Fired after a cell is selected ...

Fired after a cell is selected

Parameters

Fired after a selection change has occurred ...

Fired after a selection change has occurred

Parameters