Ext JS 4.0.7 Sencha Docs

Ext.data.AbstractStore

Hierarchy

Ext.Base
Ext.data.AbstractStore

Mixins

Requires

Subclasses

Files

AbstractStore is a superclass of Ext.data.Store and Ext.data.TreeStore. It's never used directly, but offers a set of methods used by both of those subclasses.

We've left it here in the docs for reference purposes, but unless you need to make a whole new type of Store, what you're probably looking for is Ext.data.Store. If you're still interested, here's a brief description of what AbstractStore is and is not.

AbstractStore provides the basic configuration for anything that can be considered a Store. It expects to be given a Model that represents the type of data in the Store. It also expects to be given a Proxy that handles the loading of data into the Store.

AbstractStore provides a few helpful methods such as load and sync, which load and save data respectively, passing the requests through the configured proxy. Both built-in Store subclasses add extra behavior to each of these functions. Note also that each AbstractStore subclass has its own way of storing data - in Ext.data.Store the data is saved as a flat MixedCollection, whereas in TreeStore we use a Ext.data.Tree to maintain the data's hierarchy.

The store provides filtering and sorting support. This sorting/filtering can happen on the client side or can be completed on the server. This is controlled by the remoteSort and remoteFilter config options. For more information see the sort and filter methods.

Available since: 4.0.0

Defined By

Config options

Ext.data.AbstractStore
view source
: Boolean/Object
If data is not specified, and if autoLoad is true or an Object, this store's load method is automatically called afte...

If data is not specified, and if autoLoad is true or an Object, this store's load method is automatically called after creation. If the value of autoLoad is an Object, this Object will be passed to the store's load method.

Defaults to: false

Available since: Ext 2

Ext.data.AbstractStore
view source
: Boolean
True to automatically sync the Store with its Proxy after every edit to one of its Records. ...

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

Ext.data.AbstractStore
view source
: Object[]
This may be used in place of specifying a model configuration. ...

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 be avoided, it exists for the purposes of backwards compatibility. For anything more complicated, such as specifying a particular id property or assocations, a Ext.data.Model should be defined and specified for the model config.

Available since: Ext 2

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

Available since: 1.1.0

Ext.data.AbstractStore
view source
: String
Name of the Model associated with this store. ...

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

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: Ext 1

Ext.data.AbstractStore
view source
: String
Unique identifier for this store. ...

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

Available since: 4.0.0

Defined By

Properties

Available since: 4.0.0

Ext.data.AbstractStore
view source
: String
Sets the updating behavior based on batch synchronization. ...

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

Ext.data.AbstractStore
view source
: String
The string type of the Proxy to create if none is specified. ...

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

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

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

Defaults to: "ASC"

Available since: 4.0.0

...

Defaults to: /^(?:scope|delay|buffer|single|stopEvent|preventDefault|stopPropagation|normalized|args|delegate|element|vertical|horizontal|freezeEvent)$/

Available since: 4.0.0

Ext.data.AbstractStore
view source
: Boolean
If true, any filters attached to this Store will be run after loading data, before the datachanged event is fired. ...

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

The collection of Filters currently applied to this Store

The collection of Filters currently applied to this Store

Available since: 4.0.0

Ext.data.AbstractStore
view source
: Booleanprivate
True if a model was created implicitly for this Store. ...

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

Ext.data.AbstractStore
view source
: Boolean
True if the Store has already been destroyed. ...

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: Ext 3

...

Defaults to: true

Available since: 4.0.0

Flag denoting that this object is sortable. ...

Flag denoting that this object is sortable. Always true.

Defaults to: true

Available since: 4.0.0

Ext.data.AbstractStore
view source
: Booleanprivate
...

Defaults to: true

Available since: 4.0.0

Ext.data.AbstractStore
view source
: Objectprivate
A set of default values to be applied to every model instance added via insert or created via create. ...

A set of default values to be applied to every model instance added via insert or created via create. 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

Ext.data.AbstractStore
view source
: Booleanprivate
...

Defaults to: false

Available since: 4.0.0

Ext.data.AbstractStore
view source
: Booleanprivate
...

Defaults to: false

Available since: 4.0.0

Ext.data.AbstractStore
view source
: Ext.data.Model[]private
Temporary cache in which removed model instances are kept until successfully synchronised with a Proxy, at which poin...

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

Defaults to: []

Available since: 4.0.0

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'

        return 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

Ext.data.AbstractStore
view source
: Boolean
If true, any sorters attached to this Store will be run after loading data, before the datachanged event is fired. ...

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

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

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

Available since: 4.0.0

The collection of Sorters currently applied to this Store

The collection of Sorters currently applied to this Store

Available since: 4.0.0

Methods

Defined By

Instance methods

Ext.data.AbstractStore
view source
new( config ) : Ext.data.AbstractStore
documented above ...

documented above

Available since: 4.0.0

Parameters

Returns

Fires

    Overrides: Ext.util.Observable.constructor, Ext.data.AbstractStore.constructor

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

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

    Available since: 1.1.0

    Parameters

    • o : Object/String

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

      this.addEvents({
          storeloaded: true,
          storecleared: true
      });
      
    • more : String... (optional)

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

      this.addEvents('storeloaded', 'storecleared');
      
    ...

    Available since: 4.0.6

    Parameters

    Returns

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

    Appends an event handler to this object.

    Available since: 1.1.0

    Parameters

    • eventName : String

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

    • fn : Function

      The method the event invokes. 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 : 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'
            }
        });
        

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

      Attaching multiple handlers in 1 call

      The method also allows for a single argument to be passed which is a config object containing properties which specify multiple 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}
      });
      

    Fires

      ( item, ename, [fn], [scope], [opt] )
      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.

      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.

      • opt : Object (optional)

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

      Fires

        Ext.data.AbstractStore
        view source
        ( record )private
        A model instance should call this method on the Store it has been joined to. ...

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

        Available since: Ext 3

        Parameters

        Fires

        Ext.data.AbstractStore
        view source
        ( record )private
        A model instance should call this method on the Store it has been joined to. ...

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

        Available since: Ext 3

        Parameters

        Fires

        Ext.data.AbstractStore
        view source
        ( record )private
        A model instance should call this method on the Store it has been joined to.. ...

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

        Available since: Ext 3

        Parameters

        Fires

        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!");
        
                return this;
            }
        });
        
        My.Cat.override({
            constructor: function() {
                alert("I'm going to be a cat!");
        
                var instance = this.callOverridden();
        
                alert("Meeeeoooowwww");
        
                return instance;
            }
        });
        
        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

        Returns

        • Object

          Returns the result after calling the overridden method

        Call the parent's overridden method. ...

        Call the parent's overridden method. For example:

        Ext.define('My.own.A', {
            constructor: function(test) {
                alert(test);
            }
        });
        
        Ext.define('My.own.B', {
            extend: 'My.own.A',
        
            constructor: function(test) {
                alert(test);
        
                this.callParent([test + 1]);
            }
        });
        
        Ext.define('My.own.C', {
            extend: 'My.own.B',
        
            constructor: function() {
                alert("Going to call parent's overriden constructor...");
        
                this.callParent(arguments);
            }
        });
        
        var a = new My.own.A(1); // alerts '1'
        var b = new My.own.B(1); // alerts '1', then alerts '2'
        var c = new My.own.C(2); // alerts "Going to call parent's overriden constructor..."
                                 // alerts '2', then alerts '3'
        

        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 from the superclass' method

        Ext.data.AbstractStore
        view source
        ( )private
        ...

        Available since: 4.0.0

        Ext.data.AbstractStore
        view source
        ( supressEvent )private
        ...

        Available since: 4.0.0

        Parameters

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

        Removes all listeners for this object including the managed listeners

        Available since: 4.0.0

        Fires

          Removes all managed listeners for this object. ...

          Removes all managed listeners for this object.

          Available since: 4.0.0

          Fires

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

            Continue to fire event.

            Available since: Ext JS 4.0.7

            Parameters

            Fires

              Ext.data.AbstractStore
              view source
              ( data, options )private
              saves any phantom records ...

              saves any phantom records

              Available since: 4.0.0

              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.

              Available since: 4.0.0

              Parameters

              Returns

              Ext.data.AbstractStore
              view source
              ( filters ) : Ext.util.Filter[]private
              Normalizes an array of filter objects, ensuring that they are all Ext.util.Filter instances ...

              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

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

              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.data.AbstractStore
              view source
              ( options )private
              tells the attached proxy to destroy the given records ...

              tells the attached proxy to destroy the given records

              Available since: Ext 3

              Parameters

              Fires

                Ext.data.AbstractStore
                view source
                ( )private
                ...

                Available since: 4.0.0

                Fires

                  Ext.data.AbstractStore
                  view source
                  ( sorterFn )private
                  ...

                  Available since: 4.0.0

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

                  Available since: 3.4.0

                  Parameters

                  • events : String/String[]

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

                  Ext.data.AbstractStore
                  view source
                  ( filters, value )private
                  ...

                  Available since: 4.0.0

                  Parameters

                  Ext.data.AbstractStore
                  view source
                  ( fn, scope )private
                  ...

                  Available since: 4.0.0

                  Parameters

                  Ext.data.AbstractStore
                  view source
                  ( item )private
                  Filter function for new records. ...

                  Filter function for new records.

                  Available since: 4.0.0

                  Parameters

                  Ext.data.AbstractStore
                  view source
                  ( item )private
                  Filter function for updated records. ...

                  Filter function for updated records.

                  Available since: 4.0.0

                  Parameters

                  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.

                  Available since: 1.1.0

                  Parameters

                  • eventName : String

                    The name of the event to fire.

                  • args : Object...

                    Variable number of parameters are passed to handlers.

                  Returns

                  • Boolean

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

                  Fires

                    Ext.data.AbstractStore
                    view source
                    ( ) : Objectprivate
                    Returns an object which is passed in as the listeners argument to proxy.batch inside this.sync. ...

                    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

                    Gets the bubbling parent for an Observable ...

                    Gets the bubbling parent for an Observable

                    Available since: Ext JS 4.0.7

                    Returns

                    Fires

                      Ext.data.AbstractStore
                      view source
                      ( )private
                      ...

                      Available since: 4.0.0

                      Ext.data.AbstractStore
                      view source
                      ( )private
                      ...

                      Available since: 4.0.0

                      Ext.data.AbstractStore
                      view source
                      ( ) : Ext.data.Model[]
                      Returns all Model instances that are either currently a phantom (e.g. ...

                      Returns all Model instances that are either currently a phantom (e.g. have no id), or have an ID but have not yet been saved on this Store (this happens when adding a non-phantom record from another Store into this one)

                      Available since: 4.0.0

                      Returns

                      Ext.data.AbstractStore
                      view source
                      ( ) : Ext.data.proxy.Proxy
                      Returns the proxy currently attached to this proxy instance ...

                      Returns the proxy currently attached to this proxy instance

                      Available since: 4.0.0

                      Returns

                      Ext.data.AbstractStore
                      view source
                      ( ) : Ext.data.Model[]
                      Returns any records that have been removed from the store but not yet destroyed on the proxy. ...

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

                      Available since: 4.0.0

                      Returns

                      ...

                      Available since: 4.0.0

                      Ext.data.AbstractStore
                      view source
                      ( ) : Ext.data.Model[]
                      Returns all Model instances that have been updated in the Store but not yet synchronized with the Proxy ...

                      Returns all Model instances that have been updated in the Store but not yet synchronized with the Proxy

                      Available since: 4.0.0

                      Returns

                      Checks to see if this object has any listeners for a specified event ...

                      Checks to see if this object has any listeners for a specified event

                      Available since: 1.1.0

                      Parameters

                      • eventName : String

                        The name of the event to check for

                      Returns

                      • Boolean

                        True if the event is being listened for, else false

                      ( config ) : Objectchainableprotected
                      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);
                      
                              return this;
                          }
                      });
                      
                      var awesome = new My.awesome.Class({
                          name: 'Super Awesome'
                      });
                      
                      alert(awesome.getName()); // 'Super Awesome'
                      

                      Available since: 4.0.0

                      Parameters

                      Returns

                      • Object

                        mixins The mixin prototypes as key - value pairs

                      Fires

                        Performs initialization of this mixin. ...

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

                        Available since: 4.0.0

                        Fires

                          Ext.data.AbstractStore
                          view source
                          ( )private
                          ...

                          Available since: 4.0.0

                          Ext.data.AbstractStore
                          view source
                          ( ) : Boolean
                          Returns true if the Store is currently performing a load operation ...

                          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

                          Ext.data.AbstractStore
                          view source
                          ( [options] )
                          Loads the Store using its configured proxy. ...

                          Loads the Store using its configured proxy.

                          Available since: Ext 1

                          Parameters

                          Fires

                          ( name, cls )private
                          Used internally by the mixins pre-processor ...

                          Used internally by the mixins pre-processor

                          Available since: 4.0.6

                          Parameters

                          Fires

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

                            Shorthand for addManagedListener.

                            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.

                            • opt : Object (optional)

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

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

                            Shorthand for removeManagedListener.

                            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.

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

                            Shorthand for addListener.

                            Available since: 1.1.0

                            Parameters

                            • eventName : String

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

                            • fn : Function

                              The method the event invokes. 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 : 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'
                                    }
                                });
                                

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

                              Attaching multiple handlers in 1 call

                              The method also allows for a single argument to be passed which is a config object containing properties which specify multiple 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}
                              });
                              
                            Ext.data.AbstractStore
                            view source
                            ( batch, operation )private
                            Attached as the 'complete' event listener to a proxy's Batch object. ...

                            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

                            Fires

                            Ext.data.AbstractStore
                            view source
                            ( batch, operation )private
                            ...

                            Available since: 4.0.0

                            Parameters

                            Ext.data.AbstractStore
                            view source
                            ( batch, operation )private
                            Attached as the 'operationcomplete' event listener to a proxy's Batch 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

                            Fires

                            ...

                            Available since: 4.0.0

                            Ext.data.AbstractStore
                            view source
                            ( )private
                            ...

                            Available since: 4.0.0

                            Ext.data.AbstractStore
                            view source
                            ( operation )private
                            Callback for any write Operation over the Proxy. ...

                            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

                            Fires

                            ( name, value )private
                            ...

                            Available since: 4.0.6

                            Parameters

                            Fires

                              ( name, fn )private
                              ...

                              Available since: 4.0.0

                              Parameters

                              ...

                              Available since: 1.1.0

                              ...

                              Available since: 4.0.0

                              Ext.data.AbstractStore
                              view source
                              ( )private
                              ...

                              Available since: 4.0.0

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

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

                              Available since: 2.3.0

                              Parameters

                              • origin : Object

                                The Observable whose events this object is to relay.

                              • events : String[]

                                Array of event names to relay.

                              • prefix : String

                              Fires

                                Ext.data.AbstractStore
                                view source
                                ( )
                                Removes all records from the store. ...

                                Removes all records from the store. This method does a "fast remove", individual remove events are not called. The clear event is fired upon completion.

                                Available since: Ext 1

                                Removes an event handler. ...

                                Removes an event handler.

                                Available since: 1.1.0

                                Parameters

                                • eventName : String

                                  The type of event the handler was associated with.

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

                                Fires

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

                                  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.

                                  Fires

                                    Remove a single managed listener item ...

                                    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

                                    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.

                                    Available since: 2.3.0

                                    Ext.data.AbstractStore
                                    view source
                                    ( )private
                                    deprecated, will be removed in 5.0 ...

                                    deprecated, will be removed in 5.0

                                    Available since: 4.0.0

                                    ( config ) : Ext.Basechainableprivate
                                    ...

                                    Available since: 4.0.0

                                    Parameters

                                    Returns

                                    Fires

                                      Ext.data.AbstractStore
                                      view source
                                      ( proxy ) : Ext.data.proxy.Proxy
                                      Sets the Store's Proxy by string, config object or Proxy instance ...

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

                                      Available since: 4.0.0

                                      Parameters

                                      Returns

                                      Sorts the data in the Store by one or more of its properties. ...

                                      Sorts the data in the Store by one or more of its properties. Example usage:

                                      //sort by a single field
                                      myStore.sort('myField', 'DESC');
                                      
                                      //sorting by multiple fields
                                      myStore.sort([
                                          {
                                              property : 'age',
                                              direction: 'ASC'
                                          },
                                          {
                                              property : 'name',
                                              direction: 'DESC'
                                          }
                                      ]);
                                      

                                      Internally, Store converts the passed arguments into an array of Ext.util.Sorter instances, and delegates the actual sorting to its internal Ext.util.MixedCollection.

                                      When passing a single string argument to sort, Store maintains a ASC/DESC toggler per field, so this code:

                                      store.sort('myField');
                                      store.sort('myField');
                                      

                                      Is equivalent to this code, because Store handles the toggling automatically:

                                      store.sort('myField', 'ASC');
                                      store.sort('myField', 'DESC');
                                      

                                      Available since: 4.0.0

                                      Parameters

                                      • sorters : String/Ext.util.Sorter[]

                                        Either a string name of one of the fields in this Store's configured Model, or an array of sorter configurations.

                                      • direction : String

                                        The overall direction to sort the data by. Defaults to "ASC".

                                      Returns

                                      Fires

                                      • datachanged
                                      • sort
                                      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++;
                                      
                                              return this;
                                          },
                                      
                                          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

                                      Suspends the firing of all events. ...

                                      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.

                                      Ext.data.AbstractStore
                                      view source
                                      ( )
                                      Synchronizes the Store with its Proxy. ...

                                      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

                                      Fires

                                      ( eventName, fn, [scope] )
                                      Shorthand for removeListener. ...

                                      Shorthand for removeListener.

                                      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.

                                      Ext.data.AbstractStore
                                      view source
                                      ( options )private
                                      ...

                                      Available since: 4.0.0

                                      Parameters

                                      Fires

                                        Defined By

                                        Static methods

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

                                        Available since: 4.0.2

                                        Parameters

                                        Returns

                                        ( fromClass, members ) : Ext.Basechainablestatic
                                        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 '$$$$$$$'
                                        

                                        Available since: 4.0.2

                                        Parameters

                                        • fromClass : Ext.Base

                                          The class to borrow members from

                                        • members : String/String[]

                                          The names of the members to borrow

                                        Returns

                                        Ext.data.AbstractStore
                                        view source
                                        ( store )privatestatic
                                        ...

                                        Available since: 4.0.0

                                        Parameters

                                        Overrides: Ext.Base.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()
                                        

                                        Available since: 4.0.2

                                        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'
                                        

                                        Available since: 4.0.4

                                        Returns

                                        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.implement({
                                             meow: function() {
                                                alert('Meowww...');
                                             }
                                         });
                                        
                                         var kitty = new My.awesome.Cat;
                                         kitty.meow();
                                        

                                        Available since: 4.0.2

                                        Parameters

                                        ( members ) : Ext.Basechainablestatic
                                        Override prototype members of this class. ...

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

                                        Ext.define('My.Cat', {
                                            constructor: function() {
                                                alert("I'm a cat!");
                                        
                                                return this;
                                            }
                                        });
                                        
                                        My.Cat.override({
                                            constructor: function() {
                                                alert("I'm going to be a cat!");
                                        
                                                var instance = this.callOverridden();
                                        
                                                alert("Meeeeoooowwww");
                                        
                                                return instance;
                                            }
                                        });
                                        
                                        var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
                                                                  // alerts "I'm a cat!"
                                                                  // alerts "Meeeeoooowwww"
                                        

                                        Available since: 4.0.2

                                        Parameters

                                        Returns

                                        Defined By

                                        Events

                                        Ext.data.AbstractStore
                                        view source
                                        ( store, records, index, eOpts )
                                        Fired when a Model instance has been added to this Store ...

                                        Fired when a Model instance has been added to this Store

                                        Available since: Ext 1

                                        Parameters

                                        Ext.data.AbstractStore
                                        view source
                                        ( store, operation, eOpts )
                                        Fires before a request is made for a new data object. ...

                                        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: Ext 1

                                        Parameters

                                        Ext.data.AbstractStore
                                        view source
                                        ( options, eOpts )
                                        Fired before a call to sync is executed. ...

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

                                        Available since: 4.0.0

                                        Parameters

                                        Ext.data.AbstractStore
                                        view source
                                        ( this, eOpts )
                                        Fired after the removeAll method is called. ...

                                        Fired after the removeAll method is called.

                                        Available since: Ext 1

                                        Parameters

                                        Ext.data.AbstractStore
                                        view source
                                        ( this, eOpts )
                                        Fires whenever the records in the Store have changed in some way - this could include adding or removing records, or ...

                                        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: Ext 1

                                        Parameters

                                        Ext.data.AbstractStore
                                        view source
                                        ( this, records, successful, eOpts )
                                        Fires whenever the store reads data from a remote data source. ...

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

                                        Available since: Ext 1

                                        Parameters

                                        Ext.data.AbstractStore
                                        view source
                                        ( store, record, index, eOpts )
                                        Fired when a Model instance has been removed from this Store ...

                                        Fired when a Model instance has been removed from this Store

                                        Available since: Ext 1

                                        Parameters

                                        Ext.data.AbstractStore
                                        view source
                                        ( this, record, operation, eOpts )
                                        Fires when a Model instance has been updated ...

                                        Fires when a Model instance has been updated

                                        Available since: Ext 1

                                        Parameters

                                        Ext.data.AbstractStore
                                        view source
                                        ( store, operation, eOpts )
                                        Fires whenever a successful write has been made via the configured Proxy ...

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

                                        Available since: Ext 3

                                        Parameters