Ext.data.Store

True to automatically sync the Store with its Proxy after every edit to one of its Records. Defaults to false.

Defaults to: false

Available since: 4.0.0

Sets the updating behavior based on batch synchronization. 'operation' (the default) will update the Store's internal representation of the data after each operation of the batch has completed, 'complete' will wait until the entire batch has been completed before updating the Store's data. 'complete' is a good choice for local storage proxies, 'operation' is better for remote proxies, where there is a comparatively high latency.

Defaults to: 'operation'

Available since: 4.1.1

The default sort direction to use if one is not specified.

Defaults to: "ASC"

Available since: Ext JS 4.1.3

This may be used in place of specifying a model configuration. The fields should be a set of Ext.data.Field configuration objects. The store will automatically create a Ext.data.Model with these fields. In general this configuration option should only be used for simple stores like a two-field store of ComboBox. For anything more complicated, such as specifying a particular id property or associations, a Ext.data.Model should be defined and specified for the model config.

Available since: 2.3.0

If true, any filters attached to this Store will be run after loading data, before the datachanged event is fired. Defaults to true, ignored if remoteFilter is true

Defaults to: true

Available since: 4.1.1

Array of Filters for this store. Can also be passed array of functions which will be used as the filterFn config for filters:

filters: [
    function(item) {
        return item.internalId > 0;
    }
]

To filter after the grid is loaded use the filterBy function.

Available since: 4.1.0

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'); }
        }
    }
});

Available since: 1.1.0

Name of the Model associated with this store. The string is used as an argument for Ext.ModelManager.getModel.

Available since: 4.0.4

The Proxy to use for this Store. This can be either a string, a config object or a Proxy instance - see setProxy for details.

Available since: 1.1.0

If true, any sorters attached to this Store will be run after loading data, before the datachanged event is fired. Defaults to true, igored if remoteSort is true

Defaults to: true

Available since: 4.1.1

The property in each item that contains the data to sort.

Available since: Ext JS 4.1.3

The initial set of Sorters

Available since: Ext JS 4.1.3

Unique identifier for this store. If present, this Store will be registered with the Ext.data.StoreManager, making it easy to reuse elsewhere.

Note that when store is instatiated by Controller, the storeId will be overridden by the name of the store.

Available since: 4.0.0

Defaults to: {}

Available since: 4.1.1

The string type of the Proxy to create if none is specified. This defaults to creating a memory proxy.

Defaults to: 'memory'

Available since: 4.0.0

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

Defaults to: 0

Available since: 4.1.1

The collection of Filters currently applied to this Store

Available since: 4.0.0

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);
 }

Available since: 4.1.0

True if a model was created implicitly for this Store. This happens if a fields array is passed to the Store's constructor instead of a model constructor or name.

Defaults to: false

Available since: 4.0.0

Defaults to: []

Available since: 4.1.1

Defaults to: {}

Available since: 4.1.1

True if the Store has already been destroyed. If this is true, the reference to Store should be deleted as it will not function correctly any more.

Defaults to: false

Available since: 3.4.0

Defaults to: true

Available since: 4.1.1

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

Defaults to: true

Available since: 4.0.0

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

Defaults to: true

Available since: 4.0.0

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

Defaults to: true

Available since: 4.0.0

A set of default values to be applied to every model instance added via insert or created via createModel. This is used internally by associations to set foreign keys and other fields. See the Association classes source code for examples. This should not need to be used by application developers.

Available since: 4.0.0

Temporary cache in which removed model instances are kept until successfully synchronised with a Proxy, at which point this is cleared.

Available since: 4.0.0

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'

Available since: 4.0.0

The collection of Sorters currently applied to this Store

Available since: 4.0.0

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

Available since: 1.1.0

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');
  

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}
});

Available since: 1.1.0

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

    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
    });
    

    Defaults to: false

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

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

Available since: 4.0.0

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();
  

A model instance should call this method on the Store it has been joined to.

Available since: 3.4.0

Parameters

• record : Ext.data.Model

  The model instance that was edited

A model instance should call this method on the Store it has been joined to.

Available since: 3.4.0

Parameters

• record : Ext.data.Model

  The model instance that was edited

• modifiedFieldNames : String[]

  Array of field names changed during edit.

A model instance should call this method on the Store it has been joined to..

Available since: 3.4.0

Parameters

• record : Ext.data.Model

  The model instance that was edited

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"

Available since: 4.0.0

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

Available since: 4.0.0

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

Available since: Ext JS 4.1.3

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

Removes all listeners for this object including the managed listeners

Available since: 4.0.0

Removes all managed listeners for this object.

Available since: 4.0.0

Available since: 4.1.1

Continue to fire event.

Available since: 4.0.7

Parameters

• eventName : String
• args : Array
• bubbles : Boolean

saves any phantom records

Available since: 4.0.0

Parameters

• data : Object
• options : Object

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

Available since: 4.0.0

Parameters

• newName : Object
• beginEnd : Array (optional)

  The caller can specify on which indices to slice

Returns

• Function

Normalizes an array of filter objects, ensuring that they are all Ext.util.Filter instances

Available since: 4.0.0

Parameters

• filters : Object[]

  The filters array

Returns

• Ext.util.Filter[]

  Array of Ext.util.Filter objects

Normalizes an array of sorter objects, ensuring that they are all Ext.util.Sorter instances

Available since: 4.0.0

Parameters

• sorters : Object[]

  The sorters array

Returns

• Ext.util.Sorter[]

  Array of Ext.util.Sorter objects

tells the attached proxy to destroy the given records

Available since: 3.4.0

Overrides: Ext.Base.destroy

Available since: 4.1.0

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');
        }
    }
});

Available since: 3.4.0

Parameters

• eventNames : String/String[]

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

Filter function for new records.

Available since: 4.0.0

Parameters

• item : Object

Filter function for updated records.

Available since: 4.0.0

Parameters

• item : Object

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.

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.

Returns a comparator function which compares two items and returns -1, 0, or 1 depending on the currently defined set of sorters.

If there are no sorters defined, it returns a function which returns 0 meaning that no sorting will occur.

Available since: 4.1.0

Returns an object which is passed in as the listeners argument to proxy.batch inside this.sync. This is broken out into a separate function to allow for customisation of the listeners

Available since: 4.0.0

Returns

• Object

  The listeners object

Gets the bubbling parent for an Observable

Available since: 4.0.7

Returns

• Ext.util.Observable

  The bubble parent. null is returned if no bubble target exists

Available since: 4.1.0

Parameters

• name : Object

Gets the first sorter from the sorters collection, excluding any groupers that may be in place

Available since: 4.1.1

Returns

• Ext.util.Sorter

  The sorter, null if none exist

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

Available since: 4.1.0

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.

Gets all records added or updated since the last commit. Note that the order of records returned is not deterministic and does not indicate the order in which records were modified. Note also that removed records are not included (use getRemovedRecords for that).

Available since: 4.1.0

Returns

• Ext.data.Model[]

  The added and updated Model instances

Returns the proxy currently attached to this proxy instance

Available since: 4.0.0

Returns

• Ext.data.proxy.Proxy

  The Proxy instance

Returns any records that have been removed from the store but not yet destroyed on the proxy.

Available since: 4.0.0

Returns

• Ext.data.Model[]

  The removed Model instances

Available since: 4.0.0

Available since: 4.1.0

Parameters

• config : Object

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.

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 or bubbles, else false

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'

Available since: 4.0.0

Parameters

• config : Object

Returns

• Ext.Base

  this

Performs initialization of this mixin. Component classes using this mixin should call this method during their own initialization.

Available since: 4.0.0

Returns true if the Store is currently performing a load operation

Available since: 4.0.0

Returns

• Boolean

  True if the Store is currently loading

Shorthand for addManagedListener.

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

Available since: 4.0.2

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();
  

Shorthand for removeManagedListener.

Removes listeners that were added by the mon method.

Available since: 4.0.2

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.

Shorthand for addListener.

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}
});

Available since: 1.1.0

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

    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
    });
    

    Defaults to: false

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();
  

Attached as the 'complete' event listener to a proxy's Batch object. Iterates over the batch operations and updates the Store's internal data MixedCollection.

Available since: 4.0.0

Parameters

• batch : Object
• operation : Object

Available since: 4.0.0

Parameters

• batch : Object
• operation : Object

Attached as the 'operationcomplete' event listener to a proxy's Batch object. By default just calls through to onProxyWrite.

Available since: 4.0.0

Parameters

• batch : Object
• operation : Object

Available since: 4.1.0

Parameters

• cls : Object
• data : Object
• hooks : Object

Available since: 4.1.0

Parameters

• names : Object
• callback : Object
• scope : Object

may be implemented by store subclasses

Available since: 4.1.0

Removes any records when a write is returned from the server.

Available since: 4.1.0

Parameters

• records : Ext.data.Model[]

  The array of removed records

• operation : Ext.data.Operation

  The operation that just completed

• success : Boolean

  True if the operation was successful

private

Available since: 4.1.0

Parameters

• proxy : Object
• meta : Object

Callback for any write Operation over the Proxy. Updates the Store's MixedCollection to reflect the updates provided by the Proxy

Available since: 4.0.0

Parameters

• operation : Object

may be implemented by store subclasses

Available since: 4.1.0

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.

Available since: 4.1.0

Parameters

• T : Function

  The class constructor to prepare.

Available since: 4.0.0

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.

Available since: 2.3.0

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.

Available since: 1.1.0

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 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 addListener or the listener will not be removed.

Removes listeners that were added by the mon method.

Available since: 4.0.0

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

Available since: 4.0.1

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 automatically syncing the Store with its Proxy. Only applicable if autoSync is true

Available since: 4.1.0

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.

Available since: 2.3.0

Saves all pending changes via the configured proxy. Use sync instead.

Available since: 4.0.0

Available since: 4.0.0

Parameters

• config : Object
• applyIfNotSet : Object

Returns

• Ext.Base

  this

Sets the Store's Proxy by string, config object or Proxy instance

Available since: 4.0.0

Parameters

• proxy : String/Object/Ext.data.proxy.Proxy

  The new Proxy, which can be either a type string, a configuration object or an Ext.data.proxy.Proxy instance

Returns

• Ext.data.proxy.Proxy

  The attached Proxy object

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

Available since: 4.0.0

Returns

• Ext.Class

Suspends automatically syncing the Store with its Proxy. Only applicable if autoSync is true

Available since: 4.1.0

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

Synchronizes the store with its proxy. This asks the proxy to batch together any new, updated and deleted records in the store, updating the store's internal representation of the records as each operation completes.

Available since: 4.0.0

Parameters

• options : Object (optional)

  Object containing one or more properties supported by the sync method (these get passed along to the underlying proxy's batch method):

  • batch : Ext.data.Batch/Object (optional)

    A Ext.data.Batch object (or batch config to apply to the created batch). If unspecified a default batch will be auto-created as needed.

  • callback : Function (optional)

    The function to be called upon completion of the sync. The callback is called regardless of success or failure and is passed the following parameters:

    Parameters

    • batch : Ext.data.Batch

      The batch that was processed, containing all operations in their current state after processing

    • options : Object

      The options argument that was originally passed into sync

  • success : Function (optional)

    The function to be called upon successful completion of the sync. The success function is called only if no exceptions were reported in any operations. If one or more exceptions occurred then the failure function will be called instead. The success function is called with the following parameters:

    Parameters

    • batch : Ext.data.Batch

      The batch that was processed, containing all operations in their current state after processing

    • options : Object

      The options argument that was originally passed into sync

  • failure : Function (optional)

    The function to be called upon unsuccessful completion of the sync. The failure function is called when one or more operations returns an exception during processing (even if some operations were also successful). In this case you can check the batch's exceptions array to see exactly which operations had exceptions. The failure function is called with the following parameters:

    Parameters

    • batch : Ext.data.Batch

      The Ext.data.Batch that was processed, containing all operations in their current state after processing

    • options : Object

      The options argument that was originally passed into sync

  • scope : Object (optional)

    The scope in which to execute any callbacks (i.e. the this object inside the callback, success and/or failure functions). Defaults to the store's proxy.

Returns

• Ext.data.Store

  this

Shorthand for removeListener.

Removes an event handler.

Available since: 1.1.0

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 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 addListener or the listener will not be removed.

Available since: 4.0.0

Parameters

• options : Object

Available since: 4.1.1

Parameters

• members : Object

Available since: 4.1.1

Parameters

• name : Object
• member : Object

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();

Available since: 4.1.0

Parameters

• members : Object

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() { ... };
});

Available since: 4.0.2

Parameters

• members : Object

Returns

• Ext.Base

  this

Available since: 4.1.1

Parameters

• xtype : Object

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 '$$$$$$$'

Available since: 4.0.2

Parameters

• fromClass : Ext.Base

  The class to borrow members from

• members : Array/String

  The names of the members to borrow

Returns

• Ext.Base

  this

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()

Available since: 4.0.2

Parameters

• alias : String/Object

  The new method name, or an object to set multiple aliases. See flexSetter

• origin : String/Object

  The original method name

Available since: 4.1.1

Parameters

• config : Object

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'

Available since: 4.0.4

Returns

• String

  className

Adds members to class.

Available since: 4.0.2

Used internally by the mixins pre-processor

Available since: 4.1.1

Parameters

• name : Object
• mixinClass : Object

Available since: 4.1.1

Parameters

• fn : Object
• scope : Object

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

Available since: 4.0.2

Parameters

• members : Object

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

Returns

• Ext.Base

  this class

Available since: 4.1.1

Fires before a request is made for a new data object. If the beforeload handler returns false the load action will be canceled.

Available since: 1.1.0

Parameters

• store : Ext.data.Store

  This Store

• operation : Ext.data.Operation

  The Ext.data.Operation object that will be passed to the Proxy to load the Store

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

Fired before a call to sync is executed. Return false from any listener to cancel the sync

Available since: 4.0.0

Parameters

• options : Object

  Hash of all records to be synchronized, broken down into create, update and destroy

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

Fired at the end of the remove method when all records in the passed array have been removed.

If many records may be removed in one go, then it is more efficient to listen for this event and perform any processing for a bulk remove than to listen for many remove events.

Available since: 4.1.2

Parameters

• store : Ext.data.Store

  The Store object

• records : Ext.data.Model[]

  The array of records that were removed (In the order they appear in the Store)

• indexes : Number[]

  The indexes of the records that were removed

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

Fired after the removeAll method is called.

Available since: 1.1.0

Parameters

• this : Ext.data.Store
• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

Fires whenever the records in the Store have changed in some way - this could include adding or removing records, or updating the data in existing records

Available since: 1.1.0

Parameters

• this : Ext.data.Store

  The data store

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

Fires whenever the store reads data from a remote data source.

Available since: 1.1.0

Parameters

• this : Ext.data.Store
• records : Ext.data.Model[]

  An array of records

• successful : Boolean

  True if the operation was successful.

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

Fires when this store's underlying reader (available via the proxy) provides new metadata. Metadata usually consists of new field definitions, but can include any configuration data required by an application, and can be processed as needed in the event handler. This event is currently only fired for JsonReaders.

Available since: 1.1.0

Parameters

• this : Ext.data.Store
• meta : Object

  The JSON metadata

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

Fires when the data cache has changed in a bulk manner (e.g., it has been sorted, filtered, etc.) and a widget that is using this Store as a Record cache should refresh its view.

Available since: 4.1.0

Parameters

• this : Ext.data.Store

  The data store

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

Fired when a Model instance has been removed from this Store.

If many records may be removed in one go, then it is more efficient to listen for the bulkremove event and perform any processing for a bulk remove than to listen for this remove event.

Available since: 1.1.0

Parameters

• store : Ext.data.Store

  The Store object

• record : Ext.data.Model

  The record that was removed

• index : Number

  The index of the record that was removed

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

Fires when a Model instance has been updated.

Available since: 1.1.0

Parameters

• this : Ext.data.Store
• record : Ext.data.Model

  The Model instance that was updated

• operation : String

  The update operation being performed. Value may be one of:

  Ext.data.Model.EDIT
  Ext.data.Model.REJECT
  Ext.data.Model.COMMIT
  

• modifiedFieldNames : String[]

  Array of field names changed during edit.

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

Fires whenever a successful write has been made via the configured Proxy

Available since: 3.4.0

Parameters

• store : Ext.data.Store

  This Store

• operation : Ext.data.Operation

  The Operation object that was used in the write

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.