Ext.data.proxy.Ajax

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

Defaults to: true

Available since: 2.0.0

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'

Available since: 1.1.0

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

Available since: 2.0.0

The name of the cache param added to the url when using noCache.

Defaults to: "_dc"

Available since: 1.1.0

The name of the direction parameter to send in a request.

Note: This is only used when simpleSortMode is set to true.

Defaults to: 'dir'

Available since: 2.0.0

This can be set to false if you want to prevent the paging params to be sent along with the requests made by this proxy.

Defaults to: true

Available since: 2.0.0

Extra parameters that will be included on every request. Individual requests with params of the same name will override these params when they are in conflict.

Defaults to: {}

Available since: 1.1.0

The name of the 'filter' parameter to send in a request. Set this to undefined if you don't want to send a filter parameter.

Defaults to: 'filter'

Available since: 1.1.0

The name of the group parameter to send in a request. Set this to false if you don't want to send a group parameter.

Defaults to: 'group'

Available since: 1.1.0

The name of the limit parameter to send in a request. Set this to false if you don't want to send a limit parameter.

Defaults to: 'limit'

Available since: 1.1.0

A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the addListener example for attaching multiple handlers at once.

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

Available since: 1.1.0

Disable caching by adding a unique parameter name to the request. Set to false to allow caching.

Defaults to: true

Available since: 1.1.0

The name of the page parameter to send in a request. Set this to false if you don't want to send a page parameter.

Defaults to: 'page'

Available since: 1.1.0

The Ext.data.reader.Reader to use to decode the server's response or data read from client. This can either be a Reader instance, a config object or just a valid Reader type name (e.g. 'json', 'xml').

Defaults to: {type: 'json'}

Available since: 2.0.0

Enabling simpleSortMode in conjunction with remoteSort will only send one sort property and a direction when a remote sort is requested. The directionParam and sortParam will be sent with the property name and either 'ASC' or 'DESC'.

Defaults to: false

Available since: 2.0.0

The name of the sort parameter to send in a request. Set this to undefined if you don't want to send a sort parameter.

Defaults to: 'sort'

Available since: 1.1.0

The name of the start parameter to send in a request. Set this to false if you don't want to send a start parameter.

Defaults to: 'start'

Available since: 1.1.0

The number of milliseconds to wait for a response.

Defaults to: 30000

Available since: 1.1.0

The URL from which to request the data object.

Available since: 1.1.0

The Ext.data.writer.Writer to use to encode any request sent to the server or saved to client. This can either be a Writer instance, a config object or just a valid Writer type name (e.g. 'json', 'xml').

Defaults to: {type: 'json'}

Available since: 2.0.0

Defaults to: 'ext-'

Available since: 2.0.0

Defaults to: '-'

Available since: 2.0.0

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

Available since: 2.0.0

Defaults to: false

Available since: 2.0.0

Defaults to: true

Available since: 2.0.0

Defaults to: true

Available since: 1.1.0

Defaults to: true

Available since: 2.0.0

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

Available since: 2.0.0

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

Available since: 2.0.0

Defaults to: 'identifiable'

Available since: 2.0.0

Defaults to: '#'

Available since: 2.0.0

Defaults to: 'observable'

Available since: 2.0.0

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

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

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

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


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

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

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

Available since: 2.0.0

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

Available since: 2.0.0

Appends an after-event handler.

Same as addListener with order set to 'after'.

Available since: 2.0.0

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.

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

Same as addListener with order set to 'before'.

Available since: 2.0.0

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.

Available since: 2.0.0

Parameters

• selector : Object
• name : Object
• fn : Object
• scope : Object
• options : Object
• order : Object

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

Available since: 1.1.0

Parameters

• eventNames : Object/String...

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

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.on('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.on({
    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.on({
    tap  : { fn: this.onTap, scope: this, single: true },
    swipe: { fn: button.onSwipe, scope: button }
});

See the Events Guide for more.

Available since: 1.1.0

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

  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.on({
        // 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'

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

Available since: 1.1.0

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.

Optional callback function which can be used to clean up after a request has been completed.

Available since: 1.1.0

Parameters

• request : Ext.data.Request

  The Request object

• success : Boolean

  True if the request was successful

Available since: 2.0.0

Parameters

• bubbleEvents : Object

Encode any values being sent to the server. Can be overridden in subclasses.

Available since: 2.0.0

Parameters

• value : Array

  An array of sorters/filters.

Returns

• Object

  The encoded value

Available since: 2.0.0

Parameters

• listeners : Object

Available since: 2.0.0

Parameters

• model : Object

Available since: 2.0.0

Parameters

• reader : Object
• currentReader : Object

Available since: 2.0.0

Parameters

• writer : Object
• currentWriter : Object

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.

Available since: 1.1.0

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

• Ext.data.Batch

  The newly created Batch

Creates and returns an Ext.data.Request object based on the options passed by the Store that this Proxy is attached to.

Available since: 1.1.0

Parameters

• operation : Ext.data.Operation

  The Operation object to execute

Returns

• Ext.data.Request

  The request object

Generates a url based on a given Ext.data.Request object. By default, ServerProxy's buildUrl will add the cache-buster param to the end of the url. Subclasses may need to perform additional modifications to the url.

Available since: 1.1.0

Parameters

• request : Ext.data.Request

  The request object

Returns

• String

  The url

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"

Available since: 2.0.0

Parameters

• args : Array/Arguments

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

Returns

• Object

  Returns the result of calling the overridden method

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

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

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

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

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

 var obj = new My.Derived();

 alert(obj.x);  // alerts 21

This can be used with an override as follows:

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

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

 var obj = new My.Derived();

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

This also works with static methods.

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

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

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

Lastly, it also works with overridden static methods.

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

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

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

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

Available since: 2.0.0

Parameters

• args : Array/Arguments

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

Returns

• Object

  Returns the result of calling the parent method

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

Consider:

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

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

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

         this.callParent();
     }
 });

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

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

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

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

         this.callSuper();
     }
 });

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

Available since: 2.1.0

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

Available since: 2.0.0

Parameters

• operation : Object
• eventName : Object
• fn : Object
• scope : Object
• options : Object
• order : Object

Returns

• Object

Removes all listeners for this object.

Available since: 1.1.0

Available since: 1.1.0

Parameters

• object : Object

in a ServerProxy all four CRUD operations are executed in the same manner, so we delegate to doRequest in each case

Performs the given create operation. If you override this method in a custom Proxy, remember to always call the provided callback method when you are done with your operation.

Available since: 1.1.0

Parameters

• operation : Ext.data.Operation

  The Operation to perform

• callback : Function

  Callback function to be called when the Operation has completed (whether successful or not)

• scope : Object

  Scope to execute the callback function in

Overrides: Ext.data.proxy.Proxy.create

Available since: 2.0.0

Parameters

• name : Object

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

Available since: 2.0.0

Parameters

• newName : Object

Returns

• Function

Performs the given destroy operation. If you override this method in a custom Proxy, remember to always call the provided callback method when you are done with your operation.

Available since: 1.1.0

Parameters

• operation : Ext.data.Operation

  The Operation to perform

• callback : Function

  Callback function to be called when the Operation has completed (whether successful or not)

• scope : Object

  Scope to execute the callback function in

Overrides: Ext.data.proxy.Proxy.destroy

Available since: 2.0.0

Parameters

• name : Object
• fn : Object
• scope : Object
• options : Object

Returns

• Boolean

Available since: 2.0.0

Parameters

• eventName : Object
• args : Object
• action : Object
• connectedController : Object

Available since: 2.0.0

Parameters

• name : Object
• fn : Object
• scope : Object
• options : Object
• order : Object

Available since: 2.0.0

Parameters

• me : Object
• value : Object
• oldValue : Object
• options : Object

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.

Available since: 1.1.0

Parameters

• events : String/String[]

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

Encodes the array of Ext.util.Filter objects into a string to be sent in the request url. By default, this simply JSON-encodes the filter data

Available since: 1.1.0

Parameters

• filters : Ext.util.Filter[]

  The array of Filter objects

Returns

• String

  The encoded filters

Encodes the array of Ext.util.Sorter objects into a string to be sent in the request url. By default, this simply JSON-encodes the sorter data

Available since: 1.1.0

Parameters

• sorters : Ext.util.Sorter[]

  The array of Sorter objects

Returns

• String

  The encoded sorters

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

Available since: 2.0.0

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

• Object

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.

Available since: 1.1.0

Parameters

• eventName : String

  The name of the event to fire.

• args : Object...

  Variable number of parameters are passed to handlers.

Returns

• Boolean

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

Returns the value of api.

Available since: 2.0.0

Returns

• Object

Returns the value of batchActions.

Available since: 2.0.0

Returns

• Boolean

Returns the value of batchOrder.

Available since: 2.0.0

Returns

• String

Returns the value of bubbleEvents.

Available since: 2.0.0

Returns

• String/String[]

Available since: 2.0.0

Returns the value of cacheString.

Available since: 2.0.0

Returns

• String

Available since: 2.0.0

Parameters

• name : Object

Available since: 2.0.0

Returns the value of directionParam.

Available since: 2.0.0

Returns

• String

Returns the value of enablePagingParams.

Available since: 2.0.0

Returns

• Boolean

Available since: 2.0.0

Returns the value of extraParams.

Available since: 2.0.0

Returns

• Object

Returns the value of filterParam.

Available since: 2.0.0

Returns

• String

Returns the value of groupParam.

Available since: 2.0.0

Returns

• String

Retrieves the id of this component. Will autogenerate an id if one has not already been set.

Available since: 2.0.0

Returns

• String

  id

Returns the initial configuration passed to constructor.

Available since: 2.0.0

Parameters

• name : String (optional)

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

Returns

• Object/Mixed

Returns the value of limitParam.

Available since: 2.0.0

Returns

• String

Returns the value of listeners.

Available since: 2.0.0

Returns

• Object

Available since: 2.0.0

Parameters

• object : Object
• eventName : Object

Returns the value of model.

Available since: 1.1.0

Returns

• String/Ext.data.Model

Returns the value of noCache.

Available since: 2.0.0

Returns

• Boolean

Available since: 2.0.0

Available since: 2.0.0

Available since: 2.0.0

Available since: 2.0.0

Returns the value of pageParam.

Available since: 2.0.0

Returns

• String

Copy any sorters, filters etc into the params so they can be sent over the wire

Available since: 1.1.0

Parameters

• operation : Object

Returns the value of reader.

Available since: 1.1.0

Returns

• Object/String/Ext.data.reader.Reader

Returns the value of simpleSortMode.

Available since: 2.0.0

Returns

• Boolean

Returns the value of sortParam.

Available since: 2.0.0

Returns

• String

Returns the value of startParam.

Available since: 2.0.0

Returns

• String

Returns the value of timeout.

Available since: 2.0.0

Returns

• Number

Available since: 2.0.0

Get the url for the request taking into account the order of priority, - The request - The api - The url

Available since: 2.0.0

Parameters

• request : Ext.data.Request

  The request

Returns

• String

  The url

Available since: 2.0.0

Returns the value of writer.

Available since: 1.1.0

Returns

• Object/String/Ext.data.writer.Writer

Available since: 2.0.0

Parameters

• name : Object

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

Initialize configuration for this class. a typical example:

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

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

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

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

Available since: 2.0.0

Parameters

• instanceConfig : Object

Returns

• Object

  mixins The mixin prototypes as key - value pairs

Available since: 2.0.0

Available since: 2.1.0

Parameters

• name : Object
• value : Object

Returns

• Mixed

Alias for addManagedListener.

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

Available since: 2.0.0

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.

Alias for removeManagedListener.

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

Available since: 2.0.0

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.

Alias for addListener.

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.on('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.on({
    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.on({
    tap  : { fn: this.onTap, scope: this, single: true },
    swipe: { fn: button.onSwipe, scope: button }
});

See the Events Guide for more.

Available since: 1.1.0

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

  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.on({
        // 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'

Alias for addAfterListener.

Appends an after-event handler.

Same as addListener with order set to 'after'.

Available since: 2.0.0

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

Available since: 2.0.0

Parameters

• batchOptions : Object
• batch : Object

Alias for addBeforeListener.

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

Same as addListener with order set to 'before'.

Available since: 2.0.0

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.

Available since: 2.0.0

Parameters

• cls : Object
• data : Object

Overrides: Ext.Evented.onClassExtended

Available since: 2.0.0

Parameters

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

Available since: 2.0.0

Available since: 2.0.0

Parameters

• data : Object

This method handles the processing of the response and is usually overridden by subclasses to do additional processing.

Available since: 2.0.0

Parameters

• success : Boolean

  Whether or not this request was successful

• operation : Ext.data.Operation

  The operation we made this request for

• request : Ext.data.Request

  The request that was made

• response : Object

  The response that we got

• callback : Function

  The callback to be fired onces the response is processed

• scope : Object

  The scope in which we call the callback

Performs the given read operation. If you override this method in a custom Proxy, remember to always call the provided callback method when you are done with your operation.

Available since: 1.1.0

Parameters

• operation : Ext.data.Operation

  The Operation to perform

• callback : Function

  Callback function to be called when the Operation has completed (whether successful or not)

• scope : Object

  Scope to execute the callback function in

Overrides: Ext.data.proxy.Proxy.read

Available since: 2.0.0

Parameters

• args : Object
• fn : Object

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

Available since: 1.1.0

Parameters

• object : Object

  The Observable whose events this object is to relay.

• events : String/Array/Object

  Array of event names to relay.

Returns

• Ext.mixin.Observable

  this

Removes a before-event handler.

Same as removeListener with order set to 'after'.

Available since: 2.0.0

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.

Removes a before-event handler.

Same as removeListener with order set to 'before'.

Available since: 2.0.0

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.

Available since: 2.0.0

Parameters

• selector : Object
• name : Object
• fn : Object
• scope : Object
• order : Object

Removes an event handler.

Available since: 1.1.0

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'

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

Available since: 1.1.0

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.

Resumes firing events (see suspendEvents).

Available since: 1.1.0

Sets the value of api.

Available since: 2.0.0

Parameters

• api : Object

Sets the value of batchActions.

Available since: 2.0.0

Parameters

• batchActions : Boolean

Sets the value of batchOrder.

Available since: 2.0.0

Parameters

• batchOrder : String

Sets the value of bubbleEvents.

Available since: 2.0.0

Parameters

• bubbleEvents : String/String[]

Sets the value of cacheString.

Available since: 2.0.0

Parameters

• cacheString : String

Available since: 2.0.0

Parameters

• config : Object
• applyIfNotSet : Object

Returns

• Ext.Base

  this

Sets the value of directionParam.

Available since: 2.0.0

Parameters

• directionParam : String

Sets the value of enablePagingParams.

Available since: 2.0.0

Parameters

• enablePagingParams : Boolean

Sets up an exception on the operation

Available since: 2.0.0

Parameters

• operation : Ext.data.Operation

  The operation

• response : Object

  The response

Sets a value in the underlying extraParams.

Available since: 2.0.0

Parameters

• name : String

  The key for the new value

• value : Object

  The value

Sets the value of extraParams.

Available since: 2.0.0

Parameters

• extraParams : Object

Sets the value of filterParam.

Available since: 2.0.0

Parameters

• filterParam : String

Sets the value of groupParam.

Available since: 2.0.0

Parameters

• groupParam : String

Available since: 2.0.0

Parameters

• id : Object

Sets the value of limitParam.

Available since: 2.0.0

Parameters

• limitParam : String

Sets the value of listeners.

Available since: 2.0.0

Parameters

• listeners : Object

Sets the value of model.

Available since: 1.1.0

Parameters

• model : String/Ext.data.Model

Sets the value of noCache.

Available since: 2.0.0

Parameters

• noCache : Boolean

Sets the value of pageParam.

Available since: 2.0.0

Parameters

• pageParam : String

Sets the value of reader.

Available since: 1.1.0

Parameters

• reader : Object/String/Ext.data.reader.Reader

Sets the value of simpleSortMode.

Available since: 2.0.0

Parameters

• simpleSortMode : Boolean

Sets the value of sortParam.

Available since: 2.0.0

Parameters

• sortParam : String

Sets the value of startParam.

Available since: 2.0.0

Parameters

• startParam : String

Sets the value of timeout.

Available since: 2.0.0

Parameters

• timeout : Number

Sets the value of url.

Available since: 2.0.0

Parameters

• url : String

Sets the value of writer.

Available since: 1.1.0

Parameters

• writer : Object/String/Ext.data.writer.Writer

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

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

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

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

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

        statics.totalCreated++;
    },

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

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

        return cloned;
    }
});


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

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

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

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

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

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

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

Available since: 2.0.0

Returns

• Ext.Class

Suspends the firing of all events. (see resumeEvents)

Available since: 1.1.0

Available since: 2.1.0

Parameters

• toggle : Object
• eventName : Object
• fn : Object
• scope : Object
• options : Object
• order : Object

Alias for removeListener.

Removes an event handler.

Available since: 1.1.0

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'

Alias for removeAfterListener.

Removes a before-event handler.

Same as removeListener with order set to 'after'.

Available since: 2.0.0

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.

Alias for removeBeforeListener.

Removes a before-event handler.

Same as removeListener with order set to 'before'.

Available since: 2.0.0

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.

Available since: 2.1.0

Returns

• Ext.Base

  this

Performs the given update operation. If you override this method in a custom Proxy, remember to always call the provided callback method when you are done with your operation.

Available since: 1.1.0

Parameters

• operation : Ext.data.Operation

  The Operation to perform

• callback : Function

  Callback function to be called when the Operation has completed (whether successful or not)

• scope : Object

  Scope to execute the callback function in

Overrides: Ext.data.proxy.Proxy.update

Available since: 2.0.0

Parameters

• model : Object

Available since: 2.0.0

Parameters

• reader : Object

Available since: 2.0.0

Parameters

• members : Object

Available since: 2.0.0

Parameters

• name : Object
• member : Object

Add methods / properties to the prototype of this class.

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

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

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

Available since: 2.0.0

Parameters

• members : Object

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

Available since: 2.0.0

Parameters

• members : Object

Returns

• Ext.Base

  this

Available since: 2.0.0

Parameters

• xtype : Object

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

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

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

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

var steve = new Thief();

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

Available since: 2.0.0

Parameters

• fromClass : Ext.Base

  The class to borrow members from

• members : Array/String

  The names of the members to borrow

Returns

• Ext.Base

  this

Available since: 2.0.0

Parameters

• args : Object

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.

Available since: 2.0.0

Returns

• Object

  the created instance.

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: 2.0.0

Parameters

• alias : String/Object

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

• origin : String/Object

  The original method name

Available since: 2.0.0

Parameters

• parent : Object

Get the current class' name in string format.

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

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

Available since: 2.0.0

Returns

• String

  className

Available since: 2.0.0

Used internally by the mixins pre-processor

Available since: 2.0.0

Parameters

• name : Object
• mixinClass : Object

Available since: 2.0.0

Parameters

• fn : Object
• scope : Object

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

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

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

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

Available since: 2.0.0

Parameters

• members : Object

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

Returns

• Ext.Base

  this class

Available since: 2.0.0

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

Available since: 2.0.0

Parameters

• this : Ext.data.Proxy
• data : Object

  The metadata sent back from the server

• eOpts : Object

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