Ext.data.proxy.SessionStorage

Alternate names

Ext.data.SessionStorageProxy

Hierarchy

Inherited mixins

Files

Proxy which uses HTML5 session storage as its data storage/retrieval mechanism. If this proxy is used in a browser where session storage is not supported, the constructor will throw an error. A session storage proxy requires a unique ID which is used as a key in which all record data are stored in the session storage object.

It's important to supply this unique ID as it cannot be reliably determined otherwise. If no id is provided but the attached store has a storeId, the storeId will be used. If neither option is presented the proxy will throw an error.

Proxies are almost always used with a store:

new Ext.data.Store({
    proxy: {
        type: 'sessionstorage',
        id  : 'myProxyKey'
    }
});

Alternatively you can instantiate the Proxy directly:

new Ext.data.proxy.SessionStorage({
    id  : 'myOtherProxyKey'
});

Note that session storage is different to local storage (see Ext.data.proxy.LocalStorage) - if a browser session is ended (e.g. by closing the browser) then all data in a SessionStorageProxy are lost. Browser restarts don't affect the Ext.data.proxy.LocalStorage - the data are preserved.

Config options

Defined By

Required config options

The name of the Model to tie to this Proxy. ...

The name of the Model to tie to this Proxy. Can be either the string name of the Model, or a reference to the Model constructor.

Defined By

Optional config options

True to batch actions of a particular type when synchronizing the store. ...

True to batch actions of a particular type when synchronizing the store.

Defaults to: true

Comma-separated ordering 'create', 'update' and 'destroy' actions when batching. ...

Comma-separated ordering 'create', 'update' and 'destroy' actions when batching. Override this to set a different order for the batched CRUD actions to be executed in.

Defaults to: 'create,update,destroy'

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

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

...

Defaults to: 'Y-m-d H:i:s.u'

This can be set to true if you want the webstorage proxy to comply to the paging params set on the store. ...

This can be set to true if you want the webstorage proxy to comply to the paging params set on the store.

Defaults to: false

The unique ID used as the key in which all record data are stored in the local storage object.

The unique ID used as the key in which all record data are stored in the local storage object.

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.

See the Event guide for more

Note: It is bad practice to specify a listener's config when you are defining a class using Ext.define(). Instead, only specify listeners when you are instantiating your class with Ext.create().

Properties

Defined By

Instance properties

Cached map of records already retrieved by this Proxy. ...

Cached map of records already retrieved by this Proxy. Ensures that the same instance is always retrieved.

Defaults to: {}

...

Defaults to: /\.|[^\w\-]/g

...

Defaults to: false

...

Defaults to: true

...

Defaults to: /^(?:delegate|single|delay|buffer|args|prepend)$/

...

Defaults to: {id: 'observable', hooks: {destroy: 'destroy'}}

Overrides: Ext.mixin.Sortable.mixinConfig

...

Defaults to: 'identifiable'

...

Defaults to: 'observable'

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

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

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

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

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


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

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

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

Defaults to: /^([\w\-]+)$/

Defined By

Static properties

...

Defaults to: []

Methods

Defined By

Instance methods

Creates the proxy, throws an error if local storage is not supported in the current browser. ...

Creates the proxy, throws an error if local storage is not supported in the current browser.

Parameters

  • config : Object (optional)

    Config object.

Returns

Fires

    Overrides: Ext.Evented.constructor

    ( eventName, fn, [scope], [options] )
    Appends an after-event handler. ...

    Appends an after-event handler.

    Same as addListener with order set to 'after'.

    Parameters

    • eventName : String/String[]/Object

      The name of the event to listen for.

    • fn : Function/String

      The method the event invokes.

    • scope : Object (optional)

      The scope for fn.

    • options : Object (optional)

      An object containing handler configuration.

    Fires

      ( eventName, fn, [scope], [options] )
      Appends a before-event handler. ...

      Appends a before-event handler. Returning false from the handler will stop the event.

      Same as addListener with order set to 'before'.

      Parameters

      • eventName : String/String[]/Object

        The name of the event to listen for.

      • fn : Function/String

        The method the event invokes.

      • scope : Object (optional)

        The scope for fn.

      • options : Object (optional)

        An object containing handler configuration.

      Fires

        ( selector, name, fn, scope, options, order )private
        ...

        Parameters

        Fires

          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.

          This method has been deprecated since 2.0

          It's no longer needed to add events before firing.

          Parameters

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

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

          Appends an event handler to this object. You can review the available handlers by looking at the 'events' section of the documentation for the component you are working with.

          Combining Options

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

          A delayed, one-time listener:

          container.addListener('tap', this.handleTap, 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:

          container.addListener({
              tap  : this.onTap,
              swipe: this.onSwipe,
          
              scope: this // Important. Ensure "this" is correct during handler execution
          });
          

          One can also specify options for each event handler separately:

          container.addListener({
              tap  : { fn: this.onTap, scope: this, single: true },
              swipe: { fn: button.onSwipe, scope: button }
          });
          

          See the Events Guide for more.

          Parameters

          • eventName : String/String[]/Object

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

          • fn : Function/String (optional)

            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.

            This object may contain any of the following properties:

            • scope : Object (optional)

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

            • delay : Number (optional)

              The number of milliseconds to delay the invocation of the handler after the event fires.

            • single : Boolean (optional)

              true to add a handler to handle just the next firing of the event, and then remove itself.

            • order : String (optional)

              The order of when the listener should be added into the listener queue.

              If you set an order of before and the event you are listening to is preventable, you can return false and it will stop the event.

              Available options are before, current and after.

              Defaults to: current

            • buffer : Number (optional)

              Causes the handler to be 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.

            • element : String (optional)

              Allows you to add a listener onto a element of this component using the elements reference.

              Ext.create('Ext.Component', {
                  listeners: {
                      element: 'element',
                      tap: function() {
                          alert('element tap!');
                      }
                  }
              });
              

              All components have the element reference, which is the outer most element of the component. Ext.Container also has the innerElement element which contains all children. In most cases element is adequate.

            • delegate : String (optional)

              Uses Ext.ComponentQuery to delegate events to a specified query selector within this item.

              // Create a container with a two children; a button and a toolbar
              var container = Ext.create('Ext.Container', {
                  items: [
                      {
                          xtype: 'toolbar',
                          docked: 'top',
                          title: 'My Toolbar'
                      },
                      {
                         xtype: 'button',
                         text: 'My Button'
                      }
                  ]
              });
              
              container.addListener({
                  // Ext.Buttons have an xtype of 'button', so we use that are a selector for our delegate
                  delegate: 'button',
              
                  tap: function() {
                      alert('Button tapped!');
                  }
              });
              
          • order : String (optional)

            The order of when the listener should be added into the listener queue. Possible values are before, current and after.

            Defaults to: 'current'

          Fires

            ( object, eventName, [fn], [scope], [options] )deprecated
            Adds listeners to any Observable object (or Element) which are automatically removed when this Component is destroyed. ...

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

            This method has been deprecated since 2.0

            All listeners are now automatically managed where necessary. Simply use addListener.

            Parameters

            • object : Ext.mixin.Observable/HTMLElement

              The item to which to add a listener/listeners.

            • eventName : Object/String

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

            • fn : Function (optional)

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

            • scope : Object (optional)

              If the eventName parameter was an event name, this is the scope in which the handler function is executed.

            • options : Object (optional)

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

            ...

            Parameters

            Fires

              ...

              Parameters

              Fires

                ...

                Parameters

                ( reader, currentReader )private
                ...

                Parameters

                ( writer, currentWriter )private
                ...

                Parameters

                Performs a batch of Operations, in the order specified by batchOrder. ...

                Performs a batch of Operations, in the order specified by batchOrder. Used internally by Ext.data.Store's sync method. Example usage:

                myProxy.batch({
                    create : [myModel1, myModel2],
                    update : [myModel3],
                    destroy: [myModel4, myModel5]
                });
                

                Where the myModel* above are Model instances - in this case 1 and 2 are new instances and have not been saved before, 3 has been saved previously but needs to be updated, and 4 and 5 have already been saved but should now be destroyed.

                Parameters

                • options : Object

                  Object containing one or more properties supported by the batch method:

                  • operations : Object

                    Object containing the Model instances to act upon, keyed by action name

                  • listeners : Object (optional)

                    Event listeners object passed straight through to the Batch - see Ext.data.Batch for details

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

                  • callback : Function (optional)

                    The function to be called upon completion of processing the batch. 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 batch

                  • success : Function (optional)

                    The function to be called upon successful completion of the batch. 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 batch

                  • failure : Function (optional)

                    The function to be called upon unsuccessful completion of the batch. The failure function is called when one or more operations returns an exception during processing (even if some operations were also successful). The failure 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 batch

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

                Returns

                Fires

                  Call the original method that was previously overridden with override, This method is deprecated as callParent does ...

                  Call the original method that was previously overridden with override,

                  This method is deprecated as callParent does the same thing.

                  Ext.define('My.Cat', {
                      constructor: function() {
                          alert("I'm a cat!");
                      }
                  });
                  
                  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"
                  

                  Parameters

                  • args : Array/Arguments

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

                  Returns

                  • Object

                    Returns the result of calling the overridden method

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

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

                   Ext.define('My.Base', {
                       constructor: function (x) {
                           this.x = x;
                       },
                  
                       statics: {
                           method: function (x) {
                               return x;
                           }
                       }
                   });
                  
                   Ext.define('My.Derived', {
                       extend: 'My.Base',
                  
                       constructor: function () {
                           this.callParent([21]);
                       }
                   });
                  
                   var obj = new My.Derived();
                  
                   alert(obj.x);  // alerts 21
                  

                  This can be used with an override as follows:

                   Ext.define('My.DerivedOverride', {
                       override: 'My.Derived',
                  
                       constructor: function (x) {
                           this.callParent([x*2]); // calls original My.Derived constructor
                       }
                   });
                  
                   var obj = new My.Derived();
                  
                   alert(obj.x);  // now alerts 42
                  

                  This also works with static methods.

                   Ext.define('My.Derived2', {
                       extend: 'My.Base',
                  
                       statics: {
                           method: function (x) {
                               return this.callParent([x*2]); // calls My.Base.method
                           }
                       }
                   });
                  
                   alert(My.Base.method(10));     // alerts 10
                   alert(My.Derived2.method(10)); // alerts 20
                  

                  Lastly, it also works with overridden static methods.

                   Ext.define('My.Derived2Override', {
                       override: 'My.Derived2',
                  
                       statics: {
                           method: function (x) {
                               return this.callParent([x*2]); // calls My.Derived2.method
                           }
                       }
                   });
                  
                   alert(My.Derived2.method(10)); // now alerts 40
                  

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

                  Parameters

                  • args : Array/Arguments

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

                  Returns

                  • Object

                    Returns the result of calling the parent method

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

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

                  Consider:

                   Ext.define('Ext.some.Class', {
                       method: function () {
                           console.log('Good');
                       }
                   });
                  
                   Ext.define('Ext.some.DerivedClass', {
                       method: function () {
                           console.log('Bad');
                  
                           // ... logic but with a bug ...
                  
                           this.callParent();
                       }
                   });
                  

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

                   Ext.define('App.paches.DerivedClass', {
                       override: 'Ext.some.DerivedClass',
                  
                       method: function () {
                           console.log('Fixed');
                  
                           // ... logic but with bug fixed ...
                  
                           this.callSuper();
                       }
                   });
                  

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

                  Parameters

                  • args : Array/Arguments

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

                  Returns

                  • Object

                    Returns the result of calling the superclass method

                  ( actionFn, eventName, fn, scope, options, order ) : Ext.mixin.Observablechainableprivate
                  ...

                  Parameters

                  Returns

                  Destroys all records stored in the proxy and removes all keys and values used to support the proxy from the storage o...

                  Destroys all records stored in the proxy and removes all keys and values used to support the proxy from the storage object.

                  Fires

                  • exception

                  Overrides: Ext.data.proxy.Client.clear

                  Removes all listeners for this object. ...

                  Removes all listeners for this object.

                  Fires

                    ...

                    Parameters

                    Fires

                      ( operation, callback, scope )
                      inherit docs ...

                      inherit docs

                      Parameters

                      Fires

                      • exception

                      Overrides: Ext.data.proxy.Proxy.create

                      ...

                      Parameters

                      Fires

                        Creates an event handling function which re-fires the event from this object as the passed event name. ...

                        Creates an event handling function which re-fires the event from this object as the passed event name.

                        Parameters

                        Returns

                        Fires

                          ( operation, callback, scope )
                          inherit ...

                          inherit

                          Parameters

                          Fires

                          • exception

                          Overrides: Ext.data.proxy.Proxy.destroy

                          ( name, fn, scope, options, order ) : Booleanprivate
                          ...

                          Parameters

                          Returns

                          Fires

                            ( eventName, args, action, connectedController )private
                            ...

                            Parameters

                            Fires

                              ( name, fn, scope, options, order )private
                              ...

                              Parameters

                              Fires

                                ( me, value, oldValue, options )private
                                ...

                                Parameters

                                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.

                                Parameters

                                • events : String/String[]

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

                                Fires

                                  ( eventName, args, fn, scope ) : Object
                                  Fires the specified event with the passed parameters and execute a function (action) at the end if there are no liste...

                                  Fires the specified event with the passed parameters and execute a function (action) at the end if there are no listeners that return false.

                                  Parameters

                                  • eventName : String

                                    The name of the event to fire.

                                  • args : Array

                                    Arguments to pass to handers.

                                  • fn : Function

                                    Action.

                                  • scope : Object

                                    Scope of fn.

                                  Returns

                                  Fires

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

                                    The first argument is the name of the event. Every other argument passed will be available when you listen for the event.

                                    Example

                                    Firstly, we set up a listener for our new event.

                                    this.on('myevent', function(arg1, arg2, arg3, arg4, options, e) {
                                        console.log(arg1); // true
                                        console.log(arg2); // 2
                                        console.log(arg3); // { test: 'foo' }
                                        console.log(arg4); // 14
                                        console.log(options); // the options added when adding the listener
                                        console.log(e); // the event object with information about the event
                                    });
                                    

                                    And then we can fire off the event.

                                    this.fireEvent('myevent', true, 2, { test: 'foo' }, 14);
                                    

                                    An event may be set to bubble up an Observable parent hierarchy by calling enableBubble.

                                    Parameters

                                    • eventName : String

                                      The name of the event to fire.

                                    • args : Object...

                                      Variable number of parameters are passed to handlers.

                                    Returns

                                    • Boolean

                                      Returns false if any of the handlers return false.

                                    Fires

                                      Returns the value of batchActions. ...

                                      Returns the value of batchActions.

                                      Returns

                                      Returns the value of batchOrder. ...

                                      Returns the value of batchOrder.

                                      Returns

                                      Returns the value of bubbleEvents. ...

                                      Returns the value of bubbleEvents.

                                      Returns

                                      ...

                                      Parameters

                                      Returns the value of defaultDateFormat. ...

                                      Returns the value of defaultDateFormat.

                                      Returns

                                      Returns the value of enablePagingParams. ...

                                      Returns the value of enablePagingParams.

                                      Returns

                                      Returns the value of id. ...

                                      Returns the value of id.

                                      Returns

                                      Overrides: Ext.mixin.Identifiable.getId

                                      Returns the array of record IDs stored in this Proxy ...

                                      Returns the array of record IDs stored in this Proxy

                                      Returns

                                      • Number[]

                                        The record IDs. Each is cast as a Number

                                      Fires

                                        Returns the initial configuration passed to constructor. ...

                                        Returns the initial configuration passed to constructor.

                                        Parameters

                                        • name : String (optional)

                                          When supplied, value for particular configuration option is returned, otherwise the full config object is returned.

                                        Returns

                                        Returns the value of listeners. ...

                                        Returns the value of listeners.

                                        Returns

                                        ...

                                        Parameters

                                        Returns the value of model. ...

                                        Returns the value of model.

                                        Returns

                                        Fetches a model instance from the Proxy by ID. ...

                                        Fetches a model instance from the Proxy by ID. Runs each field's decode function (if present) to decode the data.

                                        Parameters

                                        • id : String

                                          The record's unique ID

                                        Returns

                                        • Ext.data.Model

                                          The model instance or undefined if the record did not exist in the storage.

                                        Fires

                                          Given the id of a record, returns a unique string based on that id and the id of this proxy. ...

                                          Given the id of a record, returns a unique string based on that id and the id of this proxy. This is used when storing data in the local storage object and should prevent naming collisions.

                                          Parameters

                                          Returns

                                          • String

                                            The unique key for this record

                                          Fires

                                            Ext.data.proxy.SessionStorage
                                            view source
                                            ( ) : Objectprivate
                                            inherit docs ...

                                            inherit docs

                                            Returns

                                            Overrides: Ext.data.proxy.WebStorage.getStorageObject

                                            ...

                                            Parameters

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

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

                                            Parameters

                                            • eventName : String

                                              The name of the event to check for

                                            Returns

                                            • Boolean

                                              True if the event is being listened for, else false

                                            Fires

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

                                              Parameters

                                              Returns

                                              • Object

                                                mixins The mixin prototypes as key - value pairs

                                              Fires

                                                Sets up the Proxy by claiming the key in the storage object that corresponds to the unique id of this Proxy. ...

                                                Sets up the Proxy by claiming the key in the storage object that corresponds to the unique id of this Proxy. Called automatically by the constructor, this should not need to be called again unless clear has been called.

                                                Fires

                                                • exception

                                                Overrides: Ext.Evented.initialize

                                                ( object, eventName, [fn], [scope], [options] )deprecated
                                                Alias for addManagedListener. ...

                                                Alias for addManagedListener.

                                                This method has been deprecated since 2.0.0

                                                This is now done automatically

                                                Parameters

                                                • object : Ext.mixin.Observable/HTMLElement

                                                  The item to which to add a listener/listeners.

                                                • eventName : Object/String

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

                                                • fn : Function (optional)

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

                                                • scope : Object (optional)

                                                  If the eventName parameter was an event name, this is the scope in which the handler function is executed.

                                                • options : Object (optional)

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

                                                ( object, eventName, [fn], [scope] )deprecated
                                                Alias for removeManagedListener. ...

                                                Alias for removeManagedListener.

                                                This method has been deprecated since 2.0.0

                                                This is now done automatically

                                                Parameters

                                                • object : Ext.mixin.Observable/HTMLElement

                                                  The item to which to add a listener/listeners.

                                                • eventName : Object/String

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

                                                • fn : Function (optional)

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

                                                • scope : Object (optional)

                                                  If the eventName parameter was an event name, this is the scope in which the handler function is executed.

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

                                                Alias for addListener.

                                                Parameters

                                                • eventName : String/String[]/Object

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

                                                • fn : Function/String (optional)

                                                  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.

                                                  This object may contain any of the following properties:

                                                  • scope : Object (optional)

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

                                                  • delay : Number (optional)

                                                    The number of milliseconds to delay the invocation of the handler after the event fires.

                                                  • single : Boolean (optional)

                                                    true to add a handler to handle just the next firing of the event, and then remove itself.

                                                  • order : String (optional)

                                                    The order of when the listener should be added into the listener queue.

                                                    If you set an order of before and the event you are listening to is preventable, you can return false and it will stop the event.

                                                    Available options are before, current and after.

                                                    Defaults to: current

                                                  • buffer : Number (optional)

                                                    Causes the handler to be 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.

                                                  • element : String (optional)

                                                    Allows you to add a listener onto a element of this component using the elements reference.

                                                    Ext.create('Ext.Component', {
                                                        listeners: {
                                                            element: 'element',
                                                            tap: function() {
                                                                alert('element tap!');
                                                            }
                                                        }
                                                    });
                                                    

                                                    All components have the element reference, which is the outer most element of the component. Ext.Container also has the innerElement element which contains all children. In most cases element is adequate.

                                                  • delegate : String (optional)

                                                    Uses Ext.ComponentQuery to delegate events to a specified query selector within this item.

                                                    // Create a container with a two children; a button and a toolbar
                                                    var container = Ext.create('Ext.Container', {
                                                        items: [
                                                            {
                                                                xtype: 'toolbar',
                                                                docked: 'top',
                                                                title: 'My Toolbar'
                                                            },
                                                            {
                                                               xtype: 'button',
                                                               text: 'My Button'
                                                            }
                                                        ]
                                                    });
                                                    
                                                    container.addListener({
                                                        // Ext.Buttons have an xtype of 'button', so we use that are a selector for our delegate
                                                        delegate: 'button',
                                                    
                                                        tap: function() {
                                                            alert('Button tapped!');
                                                        }
                                                    });
                                                    
                                                • order : String (optional)

                                                  The order of when the listener should be added into the listener queue. Possible values are before, current and after.

                                                  Defaults to: 'current'

                                                ( eventName, fn, [scope], [options] )
                                                Alias for addAfterListener. ...

                                                Alias for addAfterListener.

                                                Parameters

                                                • eventName : String/String[]/Object

                                                  The name of the event to listen for.

                                                • fn : Function/String

                                                  The method the event invokes.

                                                • scope : Object (optional)

                                                  The scope for fn.

                                                • options : Object (optional)

                                                  An object containing handler configuration.

                                                The internal callback that the proxy uses to call any specified user callbacks after completion of a batch ...

                                                The internal callback that the proxy uses to call any specified user callbacks after completion of a batch

                                                Parameters

                                                ( eventName, fn, [scope], [options] )
                                                Alias for addBeforeListener. ...

                                                Alias for addBeforeListener.

                                                Parameters

                                                • eventName : String/String[]/Object

                                                  The name of the event to listen for.

                                                • fn : Function/String

                                                  The method the event invokes.

                                                • scope : Object (optional)

                                                  The scope for fn.

                                                • options : Object (optional)

                                                  An object containing handler configuration.

                                                ...

                                                Parameters

                                                Overrides: Ext.Evented.onClassExtended

                                                ( names, callback, scope )private
                                                ...

                                                Parameters

                                                ...

                                                Parameters

                                                Fires

                                                ( operation, callback, scope )
                                                inherit docs ...

                                                inherit docs

                                                Parameters

                                                Fires

                                                  Overrides: Ext.data.proxy.Proxy.read

                                                  ...

                                                  Parameters

                                                  Fires

                                                    ( args, fn, scope, options, order )private
                                                    ...

                                                    Parameters

                                                    Fires

                                                      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.

                                                      Parameters

                                                      • object : Object

                                                        The Observable whose events this object is to relay.

                                                      • events : String/Array/Object

                                                        Array of event names to relay.

                                                      Returns

                                                      Fires

                                                        ( eventName, fn, [scope], [options] )
                                                        Removes a before-event handler. ...

                                                        Removes a before-event handler.

                                                        Same as removeListener with order set to 'after'.

                                                        Parameters

                                                        • eventName : String/String[]/Object

                                                          The name of the event the handler was associated with.

                                                        • fn : Function/String

                                                          The handler to remove.

                                                        • scope : Object (optional)

                                                          The scope originally specified for fn.

                                                        • options : Object (optional)

                                                          Extra options object.

                                                        Fires

                                                          ( eventName, fn, [scope], [options] )
                                                          Removes a before-event handler. ...

                                                          Removes a before-event handler.

                                                          Same as removeListener with order set to 'before'.

                                                          Parameters

                                                          • eventName : String/String[]/Object

                                                            The name of the event the handler was associated with.

                                                          • fn : Function/String

                                                            The handler to remove.

                                                          • scope : Object (optional)

                                                            The scope originally specified for fn.

                                                          • options : Object (optional)

                                                            Extra options object.

                                                          Fires

                                                            ( selector, name, fn, scope, order )private
                                                            ...

                                                            Parameters

                                                            Fires

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

                                                              Removes an event handler.

                                                              Parameters

                                                              • eventName : String/String[]/Object

                                                                The type of event the handler was associated with.

                                                              • fn : Function/String

                                                                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.

                                                              • options : Object (optional)

                                                                Extra options object. See addListener for details.

                                                              • order : String (optional)

                                                                The order of the listener to remove. Possible values are before, current and after.

                                                                Defaults to: 'current'

                                                              Fires

                                                                ( object, eventName, [fn], [scope] )deprecated
                                                                Adds listeners to any Observable object (or Element) which are automatically removed when this Component is destroyed. ...

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

                                                                This method has been deprecated since 2.0

                                                                All listeners are now automatically managed where necessary. Simply use removeListener.

                                                                Parameters

                                                                • object : Ext.mixin.Observable/HTMLElement

                                                                  The item to which to add a listener/listeners.

                                                                • eventName : Object/String

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

                                                                • fn : Function (optional)

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

                                                                • scope : Object (optional)

                                                                  If the eventName parameter was an event name, this is the scope in which the handler function is executed.

                                                                Physically removes a given record from the local storage. ...

                                                                Physically removes a given record from the local storage. Used internally by destroy, which you should use instead because it updates the list of currently-stored record ids.

                                                                Parameters

                                                                Fires

                                                                • exception
                                                                Resumes firing events (see suspendEvents). ...

                                                                Resumes firing events (see suspendEvents).

                                                                Parameters

                                                                • discardQueuedEvents : Boolean

                                                                  Pass as true to discard any queued events.

                                                                Sets the value of batchActions. ...

                                                                Sets the value of batchActions.

                                                                Parameters

                                                                Sets the value of batchOrder. ...

                                                                Sets the value of batchOrder.

                                                                Parameters

                                                                Sets the value of bubbleEvents. ...

                                                                Sets the value of bubbleEvents.

                                                                Parameters

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

                                                                Parameters

                                                                Returns

                                                                Sets the value of defaultDateFormat. ...

                                                                Sets the value of defaultDateFormat.

                                                                Parameters

                                                                Sets the value of enablePagingParams. ...

                                                                Sets the value of enablePagingParams.

                                                                Parameters

                                                                Sets the value of id. ...

                                                                Sets the value of id.

                                                                Parameters

                                                                Overrides: Ext.mixin.Identifiable.setId

                                                                Saves the array of ids representing the set of all records in the Proxy ...

                                                                Saves the array of ids representing the set of all records in the Proxy

                                                                Parameters

                                                                Fires

                                                                • exception
                                                                Sets the value of listeners. ...

                                                                Sets the value of listeners.

                                                                Parameters

                                                                Sets the value of model. ...

                                                                Sets the value of model.

                                                                Parameters

                                                                Saves the given record in the Proxy. ...

                                                                Saves the given record in the Proxy. Runs each field's encode function (if present) to encode the data.

                                                                Parameters

                                                                • record : Ext.data.Model

                                                                  The model instance

                                                                • id : String (optional)

                                                                  The id to save the record under (defaults to the value of the record's getId() function)

                                                                Fires

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

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

                                                                Ext.define('My.Cat', {
                                                                    statics: {
                                                                        totalCreated: 0,
                                                                        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
                                                                    },
                                                                
                                                                    constructor: function() {
                                                                        var statics = this.statics();
                                                                
                                                                        alert(statics.speciesName);     // always equals to 'Cat' no matter what 'this' refers to
                                                                                                        // equivalent to: My.Cat.speciesName
                                                                
                                                                        alert(this.self.speciesName);   // dependent on 'this'
                                                                
                                                                        statics.totalCreated++;
                                                                    },
                                                                
                                                                    clone: function() {
                                                                        var cloned = new this.self();                    // dependent on 'this'
                                                                
                                                                        cloned.groupName = this.statics().speciesName;   // equivalent to: My.Cat.speciesName
                                                                
                                                                        return cloned;
                                                                    }
                                                                });
                                                                
                                                                
                                                                Ext.define('My.SnowLeopard', {
                                                                    extend: 'My.Cat',
                                                                
                                                                    statics: {
                                                                        speciesName: 'Snow Leopard'     // My.SnowLeopard.speciesName = 'Snow Leopard'
                                                                    },
                                                                
                                                                    constructor: function() {
                                                                        this.callParent();
                                                                    }
                                                                });
                                                                
                                                                var cat = new My.Cat();                 // alerts 'Cat', then alerts 'Cat'
                                                                
                                                                var snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'
                                                                
                                                                var clone = snowLeopard.clone();
                                                                alert(Ext.getClassName(clone));         // alerts 'My.SnowLeopard'
                                                                alert(clone.groupName);                 // alerts 'Cat'
                                                                
                                                                alert(My.Cat.totalCreated);             // alerts 3
                                                                

                                                                Returns

                                                                Suspends the firing of all events. ...

                                                                Suspends the firing of all events.

                                                                All events will be queued but you can discard the queued events by passing false in the resumeEvents call

                                                                ( toggle, eventName, fn, scope, options, order )private
                                                                ...

                                                                Parameters

                                                                Fires

                                                                  ( eventName, fn, [scope], [options], [order] )
                                                                  Alias for removeListener. ...

                                                                  Alias for removeListener.

                                                                  Parameters

                                                                  • eventName : String/String[]/Object

                                                                    The type of event the handler was associated with.

                                                                  • fn : Function/String

                                                                    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.

                                                                  • options : Object (optional)

                                                                    Extra options object. See addListener for details.

                                                                  • order : String (optional)

                                                                    The order of the listener to remove. Possible values are before, current and after.

                                                                    Defaults to: 'current'

                                                                  ( eventName, fn, [scope], [options] )
                                                                  Alias for removeAfterListener. ...

                                                                  Alias for removeAfterListener.

                                                                  Parameters

                                                                  • eventName : String/String[]/Object

                                                                    The name of the event the handler was associated with.

                                                                  • fn : Function/String

                                                                    The handler to remove.

                                                                  • scope : Object (optional)

                                                                    The scope originally specified for fn.

                                                                  • options : Object (optional)

                                                                    Extra options object.

                                                                  ( eventName, fn, [scope], [options] )
                                                                  Alias for removeBeforeListener. ...

                                                                  Alias for removeBeforeListener.

                                                                  Parameters

                                                                  • eventName : String/String[]/Object

                                                                    The name of the event the handler was associated with.

                                                                  • fn : Function/String

                                                                    The handler to remove.

                                                                  • scope : Object (optional)

                                                                    The scope originally specified for fn.

                                                                  • options : Object (optional)

                                                                    Extra options object.

                                                                  ( operation, callback, scope )
                                                                  inherit docs ...

                                                                  inherit docs

                                                                  Parameters

                                                                  Fires

                                                                  • exception

                                                                  Overrides: Ext.data.proxy.Proxy.update

                                                                  ...

                                                                  Parameters

                                                                  Fires

                                                                    ...

                                                                    Parameters

                                                                    Fires

                                                                      Defined By

                                                                      Static methods

                                                                      ( config, fullMerge )privatestatic
                                                                      ...

                                                                      Parameters

                                                                      ( members )chainableprivatestatic
                                                                      ...

                                                                      Parameters

                                                                      ( name, member )chainableprivatestatic
                                                                      ...

                                                                      Parameters

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

                                                                      Add methods / properties to the prototype of this class.

                                                                      Ext.define('My.awesome.Cat', {
                                                                          constructor: function() {
                                                                              // ...
                                                                          }
                                                                      });
                                                                      
                                                                       My.awesome.Cat.addMembers({
                                                                           meow: function() {
                                                                              alert('Meowww...');
                                                                           }
                                                                       });
                                                                      
                                                                       var kitty = new My.awesome.Cat();
                                                                       kitty.meow();
                                                                      

                                                                      Parameters

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

                                                                      Add / override static properties of this class.

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

                                                                      Parameters

                                                                      Returns

                                                                      ( xtype )chainableprivatestatic
                                                                      ...

                                                                      Parameters

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

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

                                                                      Ext.define('Bank', {
                                                                          money: '$$$',
                                                                          printMoney: function() {
                                                                              alert('$$$$$$$');
                                                                          }
                                                                      });
                                                                      
                                                                      Ext.define('Thief', {
                                                                          // ...
                                                                      });
                                                                      
                                                                      Thief.borrow(Bank, ['money', 'printMoney']);
                                                                      
                                                                      var steve = new Thief();
                                                                      
                                                                      alert(steve.money); // alerts '$$$'
                                                                      steve.printMoney(); // alerts '$$$$$$$'
                                                                      

                                                                      Parameters

                                                                      • fromClass : Ext.Base

                                                                        The class to borrow members from

                                                                      • members : Array/String

                                                                        The names of the members to borrow

                                                                      Returns

                                                                      ( args )protectedstatic
                                                                      ...

                                                                      Parameters

                                                                      Create a new instance of this Class. ...

                                                                      Create a new instance of this Class.

                                                                      Ext.define('My.cool.Class', {
                                                                          // ...
                                                                      });
                                                                      
                                                                      My.cool.Class.create({
                                                                          someConfig: true
                                                                      });
                                                                      

                                                                      All parameters are passed to the constructor of the class.

                                                                      Returns

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

                                                                      Create aliases for existing prototype methods. Example:

                                                                      Ext.define('My.cool.Class', {
                                                                          method1: function() {  },
                                                                          method2: function() {  }
                                                                      });
                                                                      
                                                                      var test = new My.cool.Class();
                                                                      
                                                                      My.cool.Class.createAlias({
                                                                          method3: 'method1',
                                                                          method4: 'method2'
                                                                      });
                                                                      
                                                                      test.method3(); // test.method1()
                                                                      
                                                                      My.cool.Class.createAlias('method5', 'method3');
                                                                      
                                                                      test.method5(); // test.method3() -> test.method1()
                                                                      

                                                                      Parameters

                                                                      ( parent )privatestatic
                                                                      ...

                                                                      Parameters

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

                                                                      Get the current class' name in string format.

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

                                                                      Returns

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

                                                                      Used internally by the mixins pre-processor

                                                                      Parameters

                                                                      ( fn, scope )chainableprivatestatic
                                                                      ...

                                                                      Parameters

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

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

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

                                                                      As of 2.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!");
                                                                      
                                                                              var instance = this.callParent(arguments);
                                                                      
                                                                              alert("Meeeeoooowwww");
                                                                      
                                                                              return instance;
                                                                          }
                                                                      });
                                                                      

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

                                                                      This method has been deprecated since 2.1.0

                                                                      Please use Ext.define instead

                                                                      Parameters

                                                                      • members : Object

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

                                                                      Returns

                                                                      Defined By

                                                                      Events

                                                                      Fires whenever the server has sent back new metadata to reconfigure the Reader. ...

                                                                      Fires whenever the server has sent back new metadata to reconfigure the Reader.

                                                                      Parameters