For up to date documentation and features, visit http://docs.sencha.com/ext-js/4-0

## Sencha Documentation

# Ext.Ajax

####

####

    HierarchyExt.data.ConnectionExt.AjaxMixinsExt.util.Observable

A singleton instance of an Ext.data.Connection. This class is used to communicate with your server side code. It can be used as follows:

    Ext.Ajax.request({
        url: 'page.php',
        params: {
            id: 1
        },
        success: function(response){
            var text = response.responseText;
            // process server response here
        }
    });

Default options for all requests can be set be changing a property on the Ext.Ajax class:

    Ext.Ajax.timeout = 60000; // 60 seconds

Any options specified in the request method for the Ajax request will override any defaults set on the Ext.Ajax class. In the code sample below, the timeout for the request will be 60 seconds.

    Ext.Ajax.timeout = 120000; // 120 seconds
    Ext.Ajax.request({
        url: 'page.aspx',
        timeout: 60000
    });

In general, this class will be used for all Ajax requests in your application. The main reason for creating a separate Ext.data.Connection is for a series of requests that share common settings that are different to all other requests in the application.

Defined By

### Config Options

#### Other Configs

Ext.util.Observable
view source
listeners : Object
(optional) A config object containing one or more event handlers to be added to this object during initialization. T...

(optional)

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

DOM events from ExtJs Components

While some ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this

is usually only done when extra value can be added. For example the DataView's `click` event passing the node clicked on. To access DOM events directly from a child element of a Component, we need to specify the `element` option to identify the Component property to add a DOM listener to:

    new Ext.panel.Panel({
        width: 400,
        height: 200,
        dockedItems: [{
            xtype: 'toolbar'
        }],
        listeners: {
            click: {
                element: 'el', //bind to the underlying el property on the panel
                fn: function(){ console.log('click el'); }
            },
            dblclick: {
                element: 'body', //bind to the underlying body property on the panel
                fn: function(){ console.log('dblclick body'); }
            }
        }
    });

Ext.data.Connection
view source
timeout : Number

(Optional) The timeout in milliseconds to be used for requests. (defaults to 30000)

(Optional) The timeout in milliseconds to be used for requests. (defaults to 30000)

Defined By

### Properties

Ext.Ajax
view source
autoAbort : Boolean

Whether a new request should abort any pending requests. (defaults to false)

Whether a new request should abort any pending requests. (defaults to false)

Ext.Ajax
view source
defaultHeaders : Object

An object containing request headers which are added to each request made by this object (defaults to undefined).

An object containing request headers which are added to each request made by this object (defaults to undefined).

Ext.Ajax
view source
disableCaching : Boolean

True to add a unique cache-buster param to GET requests. (defaults to true)

True to add a unique cache-buster param to GET requests. (defaults to true)

Ext.data.Connection
view source
disableCachingParam : String

(Optional) Change the parameter which is sent went disabling caching through a cache buster. Defaults to '_dc'

(Optional) Change the parameter which is sent went disabling caching through a cache buster. Defaults to '_dc'

Ext.Ajax
view source
extraParams : Object
An object containing properties which are used as extra parameters to each request made by this object (defaults to u...

An object containing properties which are used as extra parameters to each request made by this object (defaults to undefined). Session information and other data that you need to pass with each request are commonly put here.

Ext.Ajax
view source
method : String
The default HTTP method to be used for requests. Note that this is case-sensitive and should be all caps (defaults to...

The default HTTP method to be used for requests. Note that this is case-sensitive and should be all caps (defaults to undefined; if not set but params are present will use `"POST"`, otherwise will use `"GET"`.)

Ext.data.Connection
view source
onreadystatechange : Object
Clear out the onreadystatechange here, this allows us greater control, the browser may/may not fire the function depe...

Clear out the onreadystatechange here, this allows us greater control, the browser may/may not fire the function depending on a series of conditions.

Ext.Ajax
view source
timeout : Number

The timeout in milliseconds to be used for requests. (defaults to 30000)

The timeout in milliseconds to be used for requests. (defaults to 30000)

Ext.Ajax
view source
url : String
The default URL to be used for requests to the server. (defaults to undefined) If the server receives all requests th...

The default URL to be used for requests to the server. (defaults to undefined) If the server receives all requests through one URL, setting this once is easier than entering it on every request.

Ext.data.Connection
view source
useDefaultHeader : Boolean

Defined By

### Methods

Ext.data.Connection
view source
abort( Object request) : void

Aborts any outstanding request.

Aborts any outstanding request.

### Parameters

- request : Object

  (Optional) defaults to the last request

### Returns

- void

Ext.util.Observable
view source
addEvents( Object/String o, String ) : void

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

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

### Parameters

- o : Object/String

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

- : String

  [additional] Optional additional event names if multiple event names are being passed as separate parameters. Usage:

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

### Returns

- void

Ext.util.Observable
view source
addListener( String eventName, Function handler, [Object scope], [Object options]) : void

Appends an event handler to this object.

Appends an event handler to this object.

### Parameters

- eventName : String

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

- handler : Function

  The method the event invokes.

- 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. properties. This may contain any of the following properties:

  - scope : Object
    The scope (`this` reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.
  - delay : Number
    The number of milliseconds to delay the invocation of the handler after the event fires.
  - single : Boolean
    True to add a handler to handle just the next firing of the event, and then remove itself.
  - buffer : Number
    Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.
  - target : Observable
    Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.
  - element : String
    This option is only valid for listeners bound to Components. The name of a Component property which references an element to add a listener to.

    This option is useful during Component construction to add DOM event listeners to elements of Components which will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:

        new Ext.panel.Panel({
            title: 'The title',
            listeners: {
                click: this.handlePanelClick,
                element: 'body'
            }
        });

    When added in this way, the options available are the options applicable to Ext.core.Element.addListener

  Combining Options
  Using the options argument, it is possible to combine different types of listeners:
  A delayed, one-time listener.

      myPanel.on('hide', this.handleClick, this, {
      single: true,
      delay: 100
      });

  Attaching multiple handlers in 1 call
  The method also allows for a single argument to be passed which is a config object containing properties which specify multiple events. For example:

      myGridPanel.on({
          cellClick: this.onCellClick,
          mouseover: this.onMouseOver,
          mouseout: this.onMouseOut,
          scope: this // Important. Ensure "this" is correct during handler execution
      });

  .

### Returns

- void

Ext.util.Observable
view source
addManagedListener( Observable/Element item, Object/String ename, Function fn, Object scope, Object opt) : void

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

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

### Parameters

- item : Observable/Element

  The item to which to add a listener/listeners.

- ename : Object/String

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

- fn : Function

  Optional. If the `ename` parameter was an event name, this is the handler function.

- scope : Object

  Optional. If the `ename` parameter was an event name, this is the scope (`this` reference) in which the handler function is executed.

- opt : Object

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

### Returns

- void

Ext.util.Observable
view source
capture( Observable o, Function fn, [Object scope]) : void
Starts capture on the specified Observable. All events will be passed to the supplied function with the event name + ...

Starts capture on the specified Observable. All events will be passed to the supplied function with the event name + standard signature of the event before the event is fired. If the supplied function returns false, the event will not fire.

### Parameters

- o : Observable

  The Observable to capture events from.

- fn : Function

  The function to call when an event is fired.

- scope : Object

  (optional) The scope (`this` reference) in which the function is executed. Defaults to the Observable firing the event.

### Returns

- void

Ext.util.Observable
view source
clearListeners : void

Removes all listeners for this object including the managed listeners

Removes all listeners for this object including the managed listeners

### Returns

- void

Ext.util.Observable
view source
clearManagedListeners : void

Removes all managed listeners for this object.

Removes all managed listeners for this object.

### Returns

- void

Ext.util.Observable
view source
enableBubble( String/Array events) : void
Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if present....

Enables events fired by this Observable to bubble up an owner hierarchy by calling `this.getBubbleTarget()` if present. There is no implementation in the Observable base class.

This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to access the required target more quickly.

Example:

    Ext.override(Ext.form.field.Base, {
    //  Add functionality to Field's initComponent to enable the change event to bubble
    initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {
        this.enableBubble('change');
    }),

    //  We know that we want Field's events to bubble directly to the FormPanel.
    getBubbleTarget : function() {
        if (!this.formPanel) {
            this.formPanel = this.findParentByType('form');
        }
        return this.formPanel;
    }
    });

    var myForm = new Ext.formPanel({
    title: 'User Details',
    items: [{
        ...
    }],
    listeners: {
        change: function() {
            // Title goes red if form has been modified.
            myForm.header.setStyle('color', 'red');
        }
    }
    });

### Parameters

- events : String/Array

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

### Returns

- void

Ext.util.Observable
view source
fireEvent( String eventName, Object... args) : Boolean
Fires the specified event with the passed parameters (minus the event name). An event may be set to bubble up an Ob...

Fires the specified event with the passed parameters (minus the event name).

An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) 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 otherwise it returns true.

Ext.util.Observable
view source
hasListener( String eventName) : Boolean

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

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

### Parameters

- eventName : String

  The name of the event to check for

### Returns

- Boolean

  True if the event is being listened for, else false

Ext.data.Connection
view source
isLoading( Object request) : Boolean

Determine whether this object has a request outstanding.

Determine whether this object has a request outstanding.

### Parameters

- request : Object

  (Optional) defaults to the last transaction

### Returns

- Boolean

  True if there is an outstanding request.

Ext.util.Observable
view source
observe( Function c, Object listeners) : void
Sets observability on the passed class constructor. This makes any event fired on any instance of the passed class a...

Sets observability on the passed class constructor.

This makes any event fired on any instance of the passed class also fire a single event through the class allowing for central handling of events on many instances at once.

Usage:

    Ext.util.Observable.observe(Ext.data.Connection);
    Ext.data.Connection.on('beforerequest', function(con, options) {
        console.log('Ajax request made to ' + options.url);
    });

### Parameters

- c : Function

  The class constructor to make observable.

- listeners : Object

  An object containing a series of listeners to add. See addListener.

### Returns

- void

Ext.util.Observable
view source
on( String eventName, Function handler, [Object scope], [Object options]) : void

Appends an event handler to this object (shorthand for addListener.)

Appends an event handler to this object (shorthand for addListener.)

### Parameters

- eventName : String

  The type of event to listen for

- handler : Function

  The method the event invokes

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

### Returns

- void

Ext.data.Connection
view source
parseStatus( Number status) : Object

Check if the response status was successful

Check if the response status was successful

### Parameters

- status : Number

  The status code

### Returns

- Object

  An object containing success/status state

Ext.util.Observable
view source
relayEvents( Object origin, Array events, Object prefix) : void

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

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

### Parameters

- origin : Object

  The Observable whose events this object is to relay.

- events : Array

  Array of event names to relay.

- prefix : Object

### Returns

- void

Ext.util.Observable
view source
releaseCapture( Observable o) : void

Removes all added captures from the Observable.

Removes all added captures from the Observable.

### Parameters

- o : Observable

  The Observable to release

### Returns

- void

Ext.util.Observable
view source
removeListener( String eventName, Function handler, [Object scope]) : void

Removes an event handler.

Removes an event handler.

### Parameters

- eventName : String

  The type of event the handler was associated with.

- handler : Function

  The handler to remove. This must be a reference to the function passed into the addListener call.

- scope : Object

  (optional) The scope originally specified for the handler.

### Returns

- void

Ext.util.Observable
view source
removeManagedListener( Observable|Element item, Object|String ename, Function fn, Object scope) : void

Removes listeners that were added by the mon method.

Removes listeners that were added by the mon method.

### Parameters

- item : Observable|Element

  The item from which to remove a listener/listeners.

- ename : Object|String

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

- fn : Function

  Optional. If the `ename` parameter was an event name, this is the handler function.

- scope : Object

  Optional. If the `ename` parameter was an event name, this is the scope (`this` reference) in which the handler function is executed.

### Returns

- void

Ext.data.Connection
view source
request( Object options) : Object
Sends an HTTP request to a remote server. Important: Ajax server requests are asynchronous, and this call will retu...

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:

  - url : String/Function (Optional)
    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 (Optional)
    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 (Optional)
    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 that the method name is case-sensitive and should be all caps.
  - callback : Function (Optional)
    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:
    - 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 http://www.w3.org/TR/XMLHttpRequest/ for details about accessing elements of the response.
  - success : Function (Optional)
    The function to be called upon success of the request. The callback is passed the following parameters:
    - response : Object
      The XMLHttpRequest object containing the response data.
    - options : Object
      The parameter to the request call.
  - failure : Function (Optional)
    The function to be called upon failure of the request. The callback is passed the following parameters:
    - response : Object
      The XMLHttpRequest object containing the response data.
    - options : Object
      The parameter to the request call.
  - scope : Object (Optional)
    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.
  - timeout : Number (Optional)
    The timeout in milliseconds to be used for this request. Defaults to 30 seconds.
  - form : Element/HTMLElement/String (Optional)
    The `<form>` Element or the id of the `<form>` to pull parameters from.
  - isUpload : Boolean (Optional)
    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 (Optional)
    Request headers to set for the request.
  - xmlData : Object (Optional)
    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 (Optional)
    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.
  - disableCaching : Boolean (Optional)
    True to add a unique cache-buster param to GET requests.

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

### Returns

- Object

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

Ext.util.Observable
view source
resumeEvents : void
Resume firing events. (see suspendEvents) If events were suspended using the queueSuspended parameter, then all event...

Resume firing events. (see suspendEvents) If events were suspended using the `queueSuspended` parameter, then all events fired during event suspension will be sent to any listeners now.

### Returns

- void

Ext.data.Connection
view source
setOptions( Object options, Object scope) : Object

Set various options such as the url, params for the request

Set 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

Ext.util.Observable
view source
suspendEvents( Boolean queueSuspended) : void

Suspend the firing of all events. (see resumeEvents)

Suspend the firing of all events. (see resumeEvents)

### Parameters

- queueSuspended : Boolean

  Pass as true to queue up suspended events to be fired after the resumeEvents call instead of discarding all suspended events;

### Returns

- void

Ext.util.Observable
view source
un( String eventName, Function handler, [Object scope]) : void

Removes an event handler (shorthand for removeListener.)

Removes an event handler (shorthand for removeListener.)

### Parameters

- eventName : String

  The type of event the handler was associated with.

- handler : Function

  The handler to remove. This must be a reference to the function passed into the addListener call.

- scope : Object

  (optional) The scope originally specified for the handler.

### Returns

- void

Ext.data.Connection
view source
upload( Mixed form, String url, String params, Object options) : void

Upload a form using a hidden iframe.

Upload a form using a hidden iframe.

### Parameters

- form : Mixed

  The form to upload

- url : String

  The url to post to

- params : String

  Any extra parameters to pass

- options : Object

  The initial options

### Returns

- void

Defined By

### Events

Ext.data.Connection
view source
beforerequest( Connection conn, Object options)

Fires before a network request is made to retrieve a data object.

Fires before a network request is made to retrieve a data object.

### Parameters

- conn : Connection

  This Connection object.

- options : Object

  The options config object passed to the request method.

Ext.data.Connection
view source
requestcomplete( Connection conn, Object response, Object options)

Fires if the request was successfully completed.

Fires if the request was successfully completed.

### Parameters

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

Ext.data.Connection
view source
requestexception( Connection conn, Object response, Object options)
Fires if an error HTTP status was returned from the server. See HTTP Status Code Definitions for details of HTTP stat...

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

### Parameters

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