Defaults to: false

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

An object containing request headers which are added to each request made by this object.

Defaults to: 'application/x-www-form-urlencoded; charset=UTF-8'

The value of the default Xhr header (X-Requested-With). This is only used when useDefaultXhrHeader is set to true.

Defaults to: 'XMLHttpRequest'

true to add a unique cache-buster param to GET requests.

Defaults to: true

Change the parameter which is sent went disabling caching through a cache buster.

Defaults to: '_dc'

Any parameters to be appended to the request.

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

The default HTTP method to be used for requests.

Note: This is case-sensitive and should be all caps.

Defaults to undefined; if not set but params are present will use "POST", otherwise "GET".

Defaults to: ''

The timeout in milliseconds to be used for requests.

Defaults to: 30000

The default URL to be used for requests to the server.

Defaults to: true

Set this to false to not send the default Xhr header (X-Requested-With) with every request. This should be set to false when making CORS (cross-domain) requests.

Defaults to: true

Defaults to: ''

Defaults to: 'ext-'

Defaults to: '-'

Defaults to: false

Creates the appropriate XHR transport for the browser.

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

Defaults to: true

Defaults to: true

Defaults to: /\r\n/g

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: /multipart\/form-data/i

Defaults to: '#'

Defaults to: 'observable'

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: /textarea/i

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

Aborts any outstanding request.

Parameters

• request : Object (optional)

  Defaults to the last request.

Fires

• requestcomplete
• requestexception

Aborts all outstanding requests.

Fires

• requestcomplete
• requestexception

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

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

Parameters

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

Fires

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

Parameters

• eventNames : Object/String...

  Either an object with event names as properties with a value of true 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.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

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

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

• bubbleEvents : Object

Fires

Parameters

• listeners : Object

Fires

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. 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 is often done to "patch" a method that contains a bug but for whatever reason cannot be fixed directly.

Consider:

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

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

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

         this.callParent();
     }
 });

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

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

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

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

         this.callSuper();
     }
 });

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

Parameters

• args : Array/Arguments

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

Returns

• Object

  Returns the result of calling the superclass method

Parameters

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

Returns

• Ext.mixin.Observable

  this

Cleans up any left over information from the request.

Parameters

• The : Object

  request.

Removes all listeners for this object.

Fires

Parameters

• object : Object

Fires

Clears the timeout on the request.

Parameters

• The : Object

  request

Parameters

• name : Object

Fires

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

Parameters

• newName : String

Returns

• Function

Fires

Creates the exception object.

Parameters

• request : Object

Creates the response object.

Parameters

• request : Object

Fires

• destroy

Overrides: Ext.Base.destroy, Ext.mixin.Observable.destroy, Ext.util.Collection.destroy

Parameters

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

Returns

• Boolean

Fires

Parameters

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

Fires

Parameters

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

Fires

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

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

• Object

Fires

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

Returns

• Boolean

Returns the value of autoAbort.

Returns

• Boolean

Returns the value of bubbleEvents.

Returns

• String/String[]

Parameters

• name : Object

Returns the value of defaultHeaders.

Returns

• Object

Returns the value of defaultPostHeader.

Returns

• String

Returns the value of defaultXhrHeader.

Returns

• String

Returns the value of disableCaching.

Returns

• Boolean

Returns the value of disableCachingParam.

Returns

• String

Fires

Returns the value of extraParams.

Returns

• Object

Gets the form object from options.

Parameters

• options : Object

  The request options.

Returns

• HTMLElement/null

  The form, null if not passed.

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

Returns

• String

  id

Fires

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

• Object/Mixed

Returns the value of listeners.

Returns

• Object

Parameters

• object : Object
• eventName : Object

Returns the value of method.

Returns

• String

Fires

Returns the value of password.

Returns

• String

Returns the value of timeout.

Returns

• Number

Returns the value of url.

Returns

• String

Returns the value of useDefaultHeader.

Returns

• Boolean

Returns the value of useDefaultXhrHeader.

Returns

• Boolean

Returns the value of username.

Returns

• String

Parameters

• name : Object

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

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

• instanceConfig : Object

Returns

• Object

  mixins The mixin prototypes as key - value pairs

Fires

Detects whether the form is intended to be used for an upload.

Parameters

• options : Object

Fires

Determines whether this object has a request outstanding.

Parameters

• request : Object

  The request to check.

Returns

• Boolean

  True if there is an outstanding request.

Parameters

• name : String
• value : Mixed

Returns

• Mixed

Alias for addManagedListener.

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.

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.

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'

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.

Parameters

• response : Object
• frame : Object
• options : Object

Fires

• requestcomplete

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

• cls : Object
• data : Object

Fires

Overrides: Ext.AbstractComponent.onClassExtended, Ext.Container.onClassExtended, Ext.draw.sprite.Sprite.onClassExtended, Ext.Evented.onClassExtended, Ext.Component.onClassExtended

To be called when the request has come back from the server.

Parameters

• request : Object

Returns

• Object

  The response.

Fires

• requestcomplete
• requestexception

Parameters

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

Fires when the state of the XHR changes.

Parameters

• request : Object

  The request

Fires

• requestcomplete
• requestexception

Parameters

• frame : Object
• options : Object
• id : Object

Fires

• requestcomplete

Checks if the response status was successful.

Parameters

• status : Number

  The status code.

• xhr : XMLHttpRequest

Returns

• Object

  An object containing success/status state.

Parameters

• args : Object
• fn : Object
• scope : Object
• options : Object
• order : Object

Fires

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

• Ext.mixin.Observable

  this

Fires

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

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

Parameters

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

Fires

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

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

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.

Sends an HTTP request to a remote server.

Important: Ajax server requests are asynchronous, and this call will return before the response has been received. Process any returned data in a callback function.

Ext.Ajax.request({
    url: 'ajax_demo/sample.json',
    success: function(response, opts) {
        var obj = Ext.decode(response.responseText);
        console.dir(obj);
    },
    failure: function(response, opts) {
        console.log('server-side failure with status code ' + response.status);
    }
});

To execute a callback function in the correct scope, use the scope option.

Parameters

• options : Object

  An object which may contain the following properties:

  (The options object may also contain any other property which might be needed to perform post-processing in a callback because it is passed to callback functions.)

  • url : String/Function

    The URL to which to send the request, or a function to call which returns a URL string. The scope of the function is specified by the scope option. Defaults to the configured url.

  • params : Object/String/Function

    An object containing properties which are used as parameters to the request, a url encoded string or a function to call to get either. The scope of the function is specified by the scope option.

  • method : String

    The HTTP method to use for the request. Defaults to the configured method, or if no method was configured, "GET" if no parameters are being sent, and "POST" if parameters are being sent.

    Note: The method name is case-sensitive and should be all caps.

  • callback : Function

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

    Parameters

    • options : Object

      The parameter to the request call.

    • success : Boolean

      true if the request succeeded.

    • response : Object

      The XMLHttpRequest object containing the response data. See www.w3.org/TR/XMLHttpRequest/ for details about accessing elements of the response.

  • success : Function

    The function to be called upon success of the request. The callback is passed the following parameters:

    Parameters

    • response : Object

      The XMLHttpRequest object containing the response data.

    • options : Object

      The parameter to the request call.

  • failure : Function

    The function to be called upon failure of the request. The callback is passed the following parameters:

    Parameters

    • response : Object

      The XMLHttpRequest object containing the response data.

    • options : Object

      The parameter to the request call.

  • scope : Object

    The scope in which to execute the callbacks: The "this" object for the callback function. If the url, or params options were specified as functions from which to draw values, then this also serves as the scope for those function calls. Defaults to the browser window.

  • xhr2 : Boolean

    Determines is this request should use XHR2 features like FormData, UploadStatus, etc if they are avaiable.

  • timeout : Number (optional)

    The timeout in milliseconds to be used for this request.

    Defaults to: 30000

  • form : HTMLElement/HTMLElement/String

    The <form> Element or the id of the <form> to pull parameters from.

  • isUpload : Boolean

    Only meaningful when used with the form option.

    True if the form object is a file upload (will be set automatically if the form was configured with enctype "multipart/form-data").

    File uploads are not performed using normal "Ajax" techniques, that is they are not performed using XMLHttpRequests. Instead the form is submitted in the standard manner with the DOM <form> element temporarily modified to have its target set to refer to a dynamically generated, hidden <iframe> which is inserted into the document but removed after the return data has been gathered.

    The server response is parsed by the browser to create the document for the IFRAME. If the server is using JSON to send the return object, then the Content-Type header must be set to "text/html" in order to tell the browser to insert the text unchanged into the document body.

    The response text is retrieved from the document, and a fake XMLHttpRequest object is created containing a responseText property in order to conform to the requirements of event handlers and callbacks.

    Be aware that file upload packets are sent with the content type multipart/form and some server technologies (notably JEE) may require some custom processing in order to retrieve parameter names and parameter values from the packet content.

  • headers : Object

    Request headers to set for the request.

  • xmlData : Object

    XML document to use for the post.

    Note: This will be used instead of params for the post data. Any params will be appended to the URL.

  • jsonData : Object/String

    JSON data to use as the post.

    Note: This will be used instead of params for the post data. Any params will be appended to the URL.

  • binaryData : Array

    An array of bytes to submit in binary form. Any params will be appended to the URL. Returned data will be assumed to be a byte array or ArrayBuffer and placed in responseBytes. Other response types (e.g. xml / json) will not be provided.

    Note: This will be used instead of params for the post data. Any params will be appended to the URL.

  • disableCaching : Boolean

    True to add a unique cache-buster param to GET requests.

Returns

• Object/null

  The request object. This may be used to cancel the request.

Fires

• beforerequest
• exception
• requestcomplete
• requestexception
• requestuploadprogress

Resumes firing events (see suspendEvents).

Parameters

• discardQueuedEvents : Boolean

  Pass as true to discard any queued events.

Sets the value of async.

Parameters

• async : Boolean

Sets the value of autoAbort.

Parameters

• autoAbort : Boolean

Sets the value of bubbleEvents.

Parameters

• bubbleEvents : String/String[]

Parameters

• config : Object
• applyIfNotSet : Object

Returns

• Ext.Base

  this

Sets the value of defaultHeaders.

Parameters

• defaultHeaders : Object

Sets the value of defaultPostHeader.

Parameters

• defaultPostHeader : String

Sets the value of defaultXhrHeader.

Parameters

• defaultXhrHeader : String

Sets the value of disableCaching.

Parameters

• disableCaching : Boolean

Sets the value of disableCachingParam.

Parameters

• disableCachingParam : String

Sets the value of extraParams.

Parameters

• extraParams : Object

Parameters

• id : Object

Sets the value of listeners.

Parameters

• listeners : Object

Sets the value of method.

Parameters

• method : String

Sets various options such as the url, params for the request.

Parameters

• options : Object

  The initial options.

• scope : Object

  The scope to execute in.

Returns

• Object

  The params for the request.

Fires

Sets the value of password.

Parameters

• password : String

Sets the value of timeout.

Parameters

• timeout : Number

Sets the value of url.

Parameters

• url : String

Sets the value of useDefaultHeader.

Parameters

• useDefaultHeader : Boolean

Sets the value of useDefaultXhrHeader.

Parameters

• useDefaultXhrHeader : Boolean

Sets the value of username.

Parameters

• username : String

Setup all the headers for the request.

Parameters

• xhr : Object

  The xhr object.

• options : Object

  The options for the request.

• data : Object

  The data for the request.

• params : Object

  The params for the request.

Fires

• exception

Template method for overriding method.

Parameters

• options : Object
• method : String

Returns

• String

  The modified method.

Fires

Template method for overriding params.

Parameters

• options : Object
• params : String

Returns

• String

  The modified params.

Fires

Template method for overriding url.

Parameters

• options : Object
• url : String

Returns

• String

  The modified url

Fires

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

• Ext.Class

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

Parameters

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

Fires

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'

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.

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.

Returns

• Ext.Base

  this

Fires

Uploads a form using a hidden iframe.

Parameters

• form : String/HTMLElement/Ext.Element

  The form to upload.

• url : String

  The url to post to.

• params : String

  Any extra parameters to pass.

• options : Object

  The initial options.

Parameters

• members : Object

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

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

Parameters

• members : Object

Returns

• Ext.Base

  this

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

Parameters

• fromClass : Ext.Base

  The class to borrow members from

• members : Array/String

  The names of the members to borrow

Returns

• Ext.Base

  this

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.

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

Parameters

• alias : String/Object

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

• origin : String/Object

  The original method name

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'

Returns

• String

  className

Used internally by the mixins pre-processor

Parameters

• name : Object
• mixinClass : Object

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

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

Fires if the request was successfully completed.

Parameters

• conn : Ext.data.Connection

  This Connection object.

• response : Object

  The XHR object containing the response data. See The XMLHttpRequest Object for details.

• options : Object

  The options config object passed to the request method.

• eOpts : Object

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

Fires if an error HTTP status was returned from the server. See HTTP Status Code Definitions for details of HTTP status codes.

Parameters

• conn : Ext.data.Connection

  This Connection object.

• response : Object

  The XHR object containing the response data. See The XMLHttpRequest Object for details.

• options : Object

  The options config object passed to the request method.

• eOpts : Object

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