docs/output/Ext.data.Connection.html

   1 <div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.data.Connection-props"><img src="resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>&#13;<a class="inner-link" href="#Ext.data.Connection-methods"><img src="resources/images/default/s.gif" class="item-icon icon-method">Methods</a>&#13;<a class="inner-link" href="#Ext.data.Connection-events"><img src="resources/images/default/s.gif" class="item-icon icon-event">Events</a>&#13;<a class="inner-link" href="#Ext.data.Connection-configs"><img src="resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>&#13;<a class="bookmark" href="../docs/?class=Ext.data.Connection"><img src="resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>&#13;</div><div class="inheritance res-block"><pre class="res-block-inner"><a href="output/Ext.util.Observable.html" ext:member="" ext:cls="Ext.util.Observable">Observable</a>&#13;&nbsp;&nbsp;<img src="resources/elbow-end.gif">Connection</pre></div><h1>Class <a href="source/Connection.html#cls-Ext.data.Connection">Ext.data.Connection</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext.data</td></tr><tr><td class="label">Defined In:</td><td class="hd-info">Connection.js</td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/Connection.html#cls-Ext.data.Connection">Connection</a></td></tr><tr><td class="label">Subclasses:</td><td class="hd-info"><a href="output/Ext.Ajax.html" ext:cls="Ext.Ajax">Ajax</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info"><a href="output/Ext.util.Observable.html" ext:cls="Ext.util.Observable" ext:member="">Observable</a></td></tr></table><div class="description"><p>The class encapsulates a connection to the page's originating domain, allowing requests to be made\r
   2 either to a configured URL, or to a URL specified at request time.</p>\r
   3 <p>Requests made by this class are asynchronous, and will return immediately. No data from\r
   4 the server will be available to the statement immediately following the <a href="output/Ext.data.Connection.html#Ext.data.Connection-request" ext:member="request" ext:cls="Ext.data.Connection">request</a> call.\r
   5 To process returned data, use a\r
   6 <a href="#request-option-success" ext:member="request-option-success" ext:cls="Ext.data.Connection">success callback</a>\r
   7 in the request options object,\r
   8 or an <a href="output/Ext.data.Connection.html#Ext.data.Connection-requestcomplete" ext:member="requestcomplete" ext:cls="Ext.data.Connection">event listener</a>.</p>\r
   9 <p><h3>File Uploads</h3><a href="#request-option-isUpload" ext:member="request-option-isUpload" ext:cls="Ext.data.Connection">File uploads</a> are not performed using normal "Ajax" techniques, that\r
  10 is they are <b>not</b> performed using XMLHttpRequests. Instead the form is submitted in the standard\r
  11 manner with the DOM <tt>&lt;form></tt> element temporarily modified to have its\r
  12 <a href="http://www.w3.org/TR/REC-html40/present/frames.html#adef-target">target</a> set to refer\r
  13 to a dynamically generated, hidden <tt>&lt;iframe></tt> which is inserted into the document\r
  14 but removed after the return data has been gathered.</p>\r
  15 <p>The server response is parsed by the browser to create the document for the IFRAME. If the\r
  16 server is using JSON to send the return object, then the\r
  17 <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17">Content-Type</a> header\r
  18 must be set to "text/html" in order to tell the browser to insert the text unchanged into the document body.</p>\r
  19 <p>Characters which are significant to an HTML parser must be sent as HTML entities, so encode\r
  20 "&lt;" as "&amp;lt;", "&amp;" as "&amp;amp;" etc.</p>\r
  21 <p>The response text is retrieved from the document, and a fake XMLHttpRequest object\r
  22 is created containing a <tt>responseText</tt> property in order to conform to the\r
  23 requirements of event handlers and callbacks.</p>\r
  24 <p>Be aware that file upload packets are sent with the content type <a href="http://www.faqs.org/rfcs/rfc2388.html">multipart/form</a>\r
  25 and some server technologies (notably JEE) may require some custom processing in order to\r
  26 retrieve parameter names and parameter values from the packet content.</p></div><div class="hr"></div><a id="Ext.data.Connection-configs"></a><h2>Config Options</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Config Options</th><th class="msource-header">Defined By</th></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Connection-autoAbort"></a><b><a href="source/Connection.html#cfg-Ext.data.Connection-autoAbort">autoAbort</a></b> : Boolean<div class="mdesc">Whether this request should abort any pending requests. (defaults to false)</div></td><td class="msource">Connection</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Connection-defaultHeaders"></a><b><a href="source/Connection.html#cfg-Ext.data.Connection-defaultHeaders">defaultHeaders</a></b> : Object<div class="mdesc">An object containing request headers which are added\r
  27 to each request made by this object. (defaults to undefined)</div></td><td class="msource">Connection</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Connection-disableCaching"></a><b><a href="source/Connection.html#cfg-Ext.data.Connection-disableCaching">disableCaching</a></b> : Boolean<div class="mdesc">True to add a unique cache-buster param to GET requests. (defaults to true)</div></td><td class="msource">Connection</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Connection-disableCachingParam"></a><b><a href="source/Connection.html#cfg-Ext.data.Connection-disableCachingParam">disableCachingParam</a></b> : String<div class="mdesc">Change the parameter which is sent went disabling caching\r
  28 through a cache buster. Defaults to '_dc'</div></td><td class="msource">Connection</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Connection-extraParams"></a><b><a href="source/Connection.html#cfg-Ext.data.Connection-extraParams">extraParams</a></b> : Object<div class="mdesc"><div class="short">An object containing properties which are used as&#13;
  29 extra parameters to each request made by this object. (defaults to...</div><div class="long">An object containing properties which are used as\r
  30 extra parameters to each request made by this object. (defaults to undefined)</div></div></td><td class="msource">Connection</td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-listeners"></a><b><a href="source/Observable.html#cfg-Ext.util.Observable-listeners">listeners</a></b> : Object<div class="mdesc"><div class="short">A config object containing one or more event handlers to be added to this
  31 object during initialization.  This should ...</div><div class="long"><p>A config object containing one or more event handlers to be added to this
  32 object during initialization.  This should be a valid listeners config object as specified in the
  33 <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a> example for attaching multiple handlers at once.</p>
  34 <br><p><b><u>DOM events from ExtJs <a href="output/Ext.Component.html" ext:cls="Ext.Component">Components</a></u></b></p>
  35 <br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
  36 is usually only done when extra value can be added. For example the <a href="output/Ext.DataView.html" ext:cls="Ext.DataView">DataView</a>'s
  37 <b><code><a href="output/Ext.DataView.html#Ext.DataView-click" ext:member="click" ext:cls="Ext.DataView">click</a></code></b> event passing the node clicked on. To access DOM
  38 events directly from a Component's HTMLElement, listeners must be added to the <i><a href="output/Ext.Component.html#Ext.Component-getEl" ext:member="getEl" ext:cls="Ext.Component">Element</a></i> after the Component
  39 has been rendered. A plugin can simplify this step:<pre><code><i>// Plugin is configured <b>with</b> a listeners config object.</i>
  40 <i>// The Component is appended to the argument list of all handler functions.</i>
  41 Ext.DomObserver = Ext.extend(Object, {
  42     constructor: <b>function</b>(config) {
  43         this.listeners = config.listeners ? config.listeners : config;
  44     },
  45
  46     <i>// Component passes itself into plugin&#39;s init method</i>
  47     init: <b>function</b>(c) {
  48         <b>var</b> p, l = this.listeners;
  49         <b>for</b> (p <b>in</b> l) {
  50             <b>if</b> (Ext.isFunction(l[p])) {
  51                 l[p] = this.createHandler(l[p], c);
  52             } <b>else</b> {
  53                 l[p].fn = this.createHandler(l[p].fn, c);
  54             }
  55         }
  56
  57         <i>// Add the listeners to the Element immediately following the render call</i>
  58         c.render = c.render.<a href="output/Function.html#Function-createSequence" ext:member="createSequence" ext:cls="Function">createSequence</a>(<b>function</b>() {
  59             <b>var</b> e = c.getEl();
  60             <b>if</b> (e) {
  61                 e.on(l);
  62             }
  63         });
  64     },
  65
  66     createHandler: <b>function</b>(fn, c) {
  67         <b>return</b> <b>function</b>(e) {
  68             fn.call(this, e, c);
  69         };
  70     }
  71 });
  72
  73 <b>var</b> combo = <b>new</b> Ext.form.ComboBox({
  74
  75     <i>// Collapse combo when its element is clicked on</i>
  76     plugins: [ <b>new</b> Ext.DomObserver({
  77         click: <b>function</b>(evt, comp) {
  78             comp.collapse();
  79         }
  80     })],
  81     store: myStore,
  82     typeAhead: true,
  83     mode: <em>'local'</em>,
  84     triggerAction: <em>'all'</em>
  85 });</code></pre></p></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#listeners" ext:member="#listeners" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Connection-method"></a><b><a href="source/Connection.html#cfg-Ext.data.Connection-method">method</a></b> : String<div class="mdesc"><div class="short">The default HTTP method to be used for requests.&#13;
  86 (defaults to undefined; if not set, but request params are present,...</div><div class="long">The default HTTP method to be used for requests.\r
  87 (defaults to undefined; if not set, but <a href="output/Ext.data.Connection.html#Ext.data.Connection-request" ext:member="request" ext:cls="Ext.data.Connection">request</a> params are present, POST will be used;\r
  88 otherwise, GET will be used.)</div></div></td><td class="msource">Connection</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Connection-timeout"></a><b><a href="source/Connection.html#cfg-Ext.data.Connection-timeout">timeout</a></b> : Number<div class="mdesc">The timeout in milliseconds to be used for requests. (defaults to 30000)</div></td><td class="msource">Connection</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Connection-url"></a><b><a href="source/Connection.html#cfg-Ext.data.Connection-url">url</a></b> : String<div class="mdesc"><div class="short">The default URL to be used for requests to the server. Defaults to undefined.&#13;
  89 The url config may be a function which...</div><div class="long"><p>The default URL to be used for requests to the server. Defaults to undefined.</p>\r
  90 <p>The <code>url</code> config may be a function which <i>returns</i> the URL to use for the Ajax request. The scope\r
  91 (<code><b>this</b></code> reference) of the function is the <code>scope</code> option passed to the <a href="output/Ext.data.Connection.html#Ext.data.Connection-request" ext:member="request" ext:cls="Ext.data.Connection">request</a> method.</p></div></div></td><td class="msource">Connection</td></tr></tbody></table><a id="Ext.data.Connection-props"></a><h2>Public Properties</h2><div class="no-members">This class has no public properties.</div><a id="Ext.data.Connection-methods"></a><h2>Public Methods</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Method</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Connection-Connection"></a><b><a href="source/Connection.html#cls-Ext.data.Connection">Connection</a></b>(&nbsp;<code>Object&nbsp;config</code>&nbsp;)
  92     <div class="mdesc"><div class="short"></div><div class="long"><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>config</code> : Object<div class="sub-desc">a configuration object.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">Connection</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Connection-abort"></a><b><a href="source/Connection.html#method-Ext.data.Connection-abort">abort</a></b>(&nbsp;<span title="Optional" class="optional">[<code>Number&nbsp;transactionId</code>]</span>&nbsp;)
  93     :
  94                                         void<div class="mdesc"><div class="short">Aborts any outstanding request.</div><div class="long">Aborts any outstanding request.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>transactionId</code> : Number<div class="sub-desc">(Optional) defaults to the last transaction</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">Connection</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-addEvents"></a><b><a href="source/Observable.html#method-Ext.util.Observable-addEvents">addEvents</a></b>(&nbsp;<code>Object&nbsp;object</code>&nbsp;)
  95     :
  96                                         void<div class="mdesc"><div class="short">Used to define events on this Observable</div><div class="long">Used to define events on this Observable<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>object</code> : Object<div class="sub-desc">The object with the events defined</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#addEvents" ext:member="#addEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-addListener"></a><b><a href="source/Observable.html#method-Ext.util.Observable-addListener">addListener</a></b>(&nbsp;<code>String&nbsp;eventName</code>,&nbsp;<code>Function&nbsp;handler</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;options</code>]</span>&nbsp;)
  97     :
  98                                         void<div class="mdesc"><div class="short">Appends an event handler to this object.</div><div class="long">Appends an event handler to this object.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to listen for.</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes.</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
  99 <b>If omitted, defaults to the object which fired the event.</b></div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration.
 100 properties. This may contain any of the following properties:<ul>
 101 <li><b>scope</b> : Object<div class="sub-desc">The scope (<code><b>this</b></code> reference) in which the handler function is executed.
 102 <b>If omitted, defaults to the object which fired the event.</b></div></li>
 103 <li><b>delay</b> : Number<div class="sub-desc">The number of milliseconds to delay the invocation of the handler after the event fires.</div></li>
 104 <li><b>single</b> : Boolean<div class="sub-desc">True to add a handler to handle just the next firing of the event, and then remove itself.</div></li>
 105 <li><b>buffer</b> : Number<div class="sub-desc">Causes the handler to be scheduled to run in an <a href="output/Ext.util.DelayedTask.html" ext:cls="Ext.util.DelayedTask">Ext.util.DelayedTask</a> delayed
 106 by the specified number of milliseconds. If the event fires again within that time, the original
 107 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>
 108 <li><b>target</b> : Observable<div class="sub-desc">Only call the handler if the event was fired on the target Observable, <i>not</i>
 109 if the event was bubbled up from a child Observable.</div></li>
 110 </ul><br>
 111 <p>
 112 <b>Combining Options</b><br>
 113 Using the options argument, it is possible to combine different types of listeners:<br>
 114 <br>
 115 A delayed, one-time listener.
 116 <pre><code>myDataView.on(<em>'click'</em>, this.onClick, this, {
 117     single: true,
 118     delay: 100
 119 });</code></pre>
 120 <p>
 121 <b>Attaching multiple handlers in 1 call</b><br>
 122 The method also allows for a single argument to be passed which is a config object containing properties
 123 which specify multiple handlers.
 124 <p>
 125 <pre><code>myGridPanel.on({
 126     <em>'click'</em> : {
 127         fn: this.onClick,
 128         scope: this,
 129         delay: 100
 130     },
 131     <em>'mouseover'</em> : {
 132         fn: this.onMouseOver,
 133         scope: this
 134     },
 135     <em>'mouseout'</em> : {
 136         fn: this.onMouseOut,
 137         scope: this
 138     }
 139 });</code></pre>
 140 <p>
 141 Or a shorthand syntax:<br>
 142 <pre><code>myGridPanel.on({
 143     <em>'click'</em> : this.onClick,
 144     <em>'mouseover'</em> : this.onMouseOver,
 145     <em>'mouseout'</em> : this.onMouseOut,
 146      scope: this
 147 });</code></pre></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#addListener" ext:member="#addListener" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-enableBubble"></a><b><a href="source/Observable-more.html#method-Ext.util.Observable-enableBubble">enableBubble</a></b>(&nbsp;<code>Object&nbsp;events</code>&nbsp;)
 148     :
 149                                         void<div class="mdesc"><div class="short">Used to enable bubbling of events</div><div class="long">Used to enable bubbling of events<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>events</code> : Object<div class="sub-desc"></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#enableBubble" ext:member="#enableBubble" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-fireEvent"></a><b><a href="source/Observable.html#method-Ext.util.Observable-fireEvent">fireEvent</a></b>(&nbsp;<code>String&nbsp;eventName</code>,&nbsp;<code>Object...&nbsp;args</code>&nbsp;)
 150     :
 151                                         Boolean<div class="mdesc"><div class="short">Fires the specified event with the passed parameters (minus the event name).
 152 An event may be set to bubble up an Obse...</div><div class="long"><p>Fires the specified event with the passed parameters (minus the event name).</p>
 153 <p>An event may be set to bubble up an Observable parent hierarchy (See <a href="output/Ext.Component.html#Ext.Component-getBubbleTarget" ext:member="getBubbleTarget" ext:cls="Ext.Component">Ext.Component.getBubbleTarget</a>)
 154 by calling <a href="output/Ext.util.Observable.html#Ext.util.Observable-enableBubble" ext:member="enableBubble" ext:cls="Ext.util.Observable">enableBubble</a>.</p><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to fire.</div></li><li><code>args</code> : Object...<div class="sub-desc">Variable number of parameters are passed to handlers.</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#fireEvent" ext:member="#fireEvent" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-hasListener"></a><b><a href="source/Observable.html#method-Ext.util.Observable-hasListener">hasListener</a></b>(&nbsp;<code>String&nbsp;eventName</code>&nbsp;)
 155     :
 156                                         Boolean<div class="mdesc"><div class="short">Checks to see if this object has any listeners for a specified event</div><div class="long">Checks to see if this object has any listeners for a specified event<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The name of the event to check for</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">True if the event is being listened for, else false</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#hasListener" ext:member="#hasListener" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Connection-isLoading"></a><b><a href="source/Connection.html#method-Ext.data.Connection-isLoading">isLoading</a></b>(&nbsp;<span title="Optional" class="optional">[<code>Number&nbsp;transactionId</code>]</span>&nbsp;)
 157     :
 158                                         Boolean<div class="mdesc"><div class="short">Determine whether this object has a request outstanding.</div><div class="long">Determine whether this object has a request outstanding.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>transactionId</code> : Number<div class="sub-desc">(Optional) defaults to the last transaction</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">True if there is an outstanding request.</div></li></ul></div></div></div></td><td class="msource">Connection</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-on"></a><b><a href="source/Observable.html#method-Ext.util.Observable-on">on</a></b>(&nbsp;<code>String&nbsp;eventName</code>,&nbsp;<code>Function&nbsp;handler</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;options</code>]</span>&nbsp;)
 159     :
 160                                         void<div class="mdesc"><div class="short">Appends an event handler to this object (shorthand for addListener.)</div><div class="long">Appends an event handler to this object (shorthand for <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a>.)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
 161 <b>If omitted, defaults to the object which fired the event.</b></div></li><li><code>options</code> : Object<div class="sub-desc">(optional) An object containing handler configuration.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#on" ext:member="#on" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-purgeListeners"></a><b><a href="source/Observable.html#method-Ext.util.Observable-purgeListeners">purgeListeners</a></b>()
 162     :
 163                                         void<div class="mdesc"><div class="short">Removes all listeners for this object</div><div class="long">Removes all listeners for this object<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#purgeListeners" ext:member="#purgeListeners" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-relayEvents"></a><b><a href="source/Observable-more.html#method-Ext.util.Observable-relayEvents">relayEvents</a></b>(&nbsp;<code>Object&nbsp;o</code>,&nbsp;<code>Array&nbsp;events</code>&nbsp;)
 164     :
 165                                         void<div class="mdesc"><div class="short">Relays selected events from the specified Observable as if the events were fired by this.</div><div class="long">Relays selected events from the specified Observable as if the events were fired by <tt><b>this</b></tt>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>o</code> : Object<div class="sub-desc">The Observable whose events this object is to relay.</div></li><li><code>events</code> : Array<div class="sub-desc">Array of event names to relay.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#relayEvents" ext:member="#relayEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-removeListener"></a><b><a href="source/Observable.html#method-Ext.util.Observable-removeListener">removeListener</a></b>(&nbsp;<code>String&nbsp;eventName</code>,&nbsp;<code>Function&nbsp;handler</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>&nbsp;)
 166     :
 167                                         void<div class="mdesc"><div class="short">Removes an event handler.</div><div class="long">Removes an event handler.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The type of event the handler was associated with.</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove. <b>This must be a reference to the function passed into the <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a> call.</b></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope originally specified for the handler.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#removeListener" ext:member="#removeListener" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Connection-request"></a><b><a href="source/Connection.html#method-Ext.data.Connection-request">request</a></b>(&nbsp;<code>Object&nbsp;options</code>&nbsp;)
 168     :
 169                                         Number<div class="mdesc"><div class="short">Sends an HTTP request to a remote server.&#13;
 170 Important: Ajax server requests are asynchronous, and this call will&#13;
 171 retu...</div><div class="long"><p>Sends an HTTP request to a remote server.</p>\r
 172 <p><b>Important:</b> Ajax server requests are asynchronous, and this call will\r
 173 return before the response has been received. Process any returned data\r
 174 in a callback function.</p>\r
 175 <pre><code>Ext.Ajax.request({\r
 176    url: <em>'ajax_demo/sample.json'</em>,\r
 177    success: <b>function</b>(response, opts) {\r
 178       <b>var</b> obj = Ext.decode(response.responseText);\r
 179       console.dir(obj);\r
 180    },\r
 181    failure: <b>function</b>(response, opts) {\r
 182       console.log(<em>'server-side failure <b>with</b> status code '</em> + response.status);\r
 183    }\r
 184 });</code></pre>\r
 185 <p>To execute a callback function in the correct scope, use the <tt>scope</tt> option.</p><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>options</code> : Object<div class="sub-desc">An object which may contain the following properties:<ul>\r
 186 <li><b>url</b> : String/Function (Optional)<div class="sub-desc">The URL to\r
 187 which to send the request, or a function to call which returns a URL string. The scope of the\r
 188 function is specified by the <tt>scope</tt> option. Defaults to the configured\r
 189 <tt><a href="output/Ext.data.Connection.html#Ext.data.Connection-url" ext:member="url" ext:cls="Ext.data.Connection">url</a></tt>.</div></li>\r
 190 <li><b>params</b> : Object/String/Function (Optional)<div class="sub-desc">\r
 191 An object containing properties which are used as parameters to the\r
 192 request, a url encoded string or a function to call to get either. The scope of the function\r
 193 is specified by the <tt>scope</tt> option.</div></li>\r
 194 <li><b>method</b> : String (Optional)<div class="sub-desc">The HTTP method to use\r
 195 for the request. Defaults to the configured method, or if no method was configured,\r
 196 "GET" if no parameters are being sent, and "POST" if parameters are being sent.  Note that\r
 197 the method name is case-sensitive and should be all caps.</div></li>\r
 198 <li><b>callback</b> : Function (Optional)<div class="sub-desc">The\r
 199 function to be called upon receipt of the HTTP response. The callback is\r
 200 called regardless of success or failure and is passed the following\r
 201 parameters:<ul>\r
 202 <li><b>options</b> : Object<div class="sub-desc">The parameter to the request call.</div></li>\r
 203 <li><b>success</b> : Boolean<div class="sub-desc">True if the request succeeded.</div></li>\r
 204 <li><b>response</b> : Object<div class="sub-desc">The XMLHttpRequest object containing the response data. \r
 205 See <a href="http://www.w3.org/TR/XMLHttpRequest/">http://www.w3.org/TR/XMLHttpRequest/</a> for details about \r
 206 accessing elements of the response.</div></li>\r
 207 </ul></div></li>\r
 208 <li><a id="request-option-success"></a><b>success</b> : Function (Optional)<div class="sub-desc">The function\r
 209 to be called upon success of the request. The callback is passed the following\r
 210 parameters:<ul>\r
 211 <li><b>response</b> : Object<div class="sub-desc">The XMLHttpRequest object containing the response data.</div></li>\r
 212 <li><b>options</b> : Object<div class="sub-desc">The parameter to the request call.</div></li>\r
 213 </ul></div></li>\r
 214 <li><b>failure</b> : Function (Optional)<div class="sub-desc">The function\r
 215 to be called upon failure of the request. The callback is passed the\r
 216 following parameters:<ul>\r
 217 <li><b>response</b> : Object<div class="sub-desc">The XMLHttpRequest object containing the response data.</div></li>\r
 218 <li><b>options</b> : Object<div class="sub-desc">The parameter to the request call.</div></li>\r
 219 </ul></div></li>\r
 220 <li><b>scope</b> : Object (Optional)<div class="sub-desc">The scope in\r
 221 which to execute the callbacks: The "this" object for the callback function. If the <tt>url</tt>, or <tt>params</tt> options were\r
 222 specified as functions from which to draw values, then this also serves as the scope for those function calls.\r
 223 Defaults to the browser window.</div></li>\r
 224 <li><b>timeout</b> : Number (Optional)<div class="sub-desc">The timeout in milliseconds to be used for this request. Defaults to 30 seconds.</div></li>\r
 225 <li><b>form</b> : Element/HTMLElement/String (Optional)<div class="sub-desc">The <tt>&lt;form&gt;</tt>\r
 226 Element or the id of the <tt>&lt;form&gt;</tt> to pull parameters from.</div></li>\r
 227 <li><a id="request-option-isUpload"></a><b>isUpload</b> : Boolean (Optional)<div class="sub-desc"><b>Only meaningful when used \r
 228 with the <tt>form</tt> option</b>.\r
 229 <p>True if the form object is a file upload (will be set automatically if the form was\r
 230 configured with <b><tt>enctype</tt></b> "multipart/form-data").</p>\r
 231 <p>File uploads are not performed using normal "Ajax" techniques, that is they are <b>not</b>\r
 232 performed using XMLHttpRequests. Instead the form is submitted in the standard manner with the\r
 233 DOM <tt>&lt;form></tt> element temporarily modified to have its\r
 234 <a href="http://www.w3.org/TR/REC-html40/present/frames.html#adef-target">target</a> set to refer\r
 235 to a dynamically generated, hidden <tt>&lt;iframe></tt> which is inserted into the document\r
 236 but removed after the return data has been gathered.</p>\r
 237 <p>The server response is parsed by the browser to create the document for the IFRAME. If the\r
 238 server is using JSON to send the return object, then the\r
 239 <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17">Content-Type</a> header\r
 240 must be set to "text/html" in order to tell the browser to insert the text unchanged into the document body.</p>\r
 241 <p>The response text is retrieved from the document, and a fake XMLHttpRequest object\r
 242 is created containing a <tt>responseText</tt> property in order to conform to the\r
 243 requirements of event handlers and callbacks.</p>\r
 244 <p>Be aware that file upload packets are sent with the content type <a href="http://www.faqs.org/rfcs/rfc2388.html">multipart/form</a>\r
 245 and some server technologies (notably JEE) may require some custom processing in order to\r
 246 retrieve parameter names and parameter values from the packet content.</p>\r
 247 </div></li>\r
 248 <li><b>headers</b> : Object (Optional)<div class="sub-desc">Request\r
 249 headers to set for the request.</div></li>\r
 250 <li><b>xmlData</b> : Object (Optional)<div class="sub-desc">XML document\r
 251 to use for the post. Note: This will be used instead of params for the post\r
 252 data. Any params will be appended to the URL.</div></li>\r
 253 <li><b>jsonData</b> : Object/String (Optional)<div class="sub-desc">JSON\r
 254 data to use as the post. Note: This will be used instead of params for the post\r
 255 data. Any params will be appended to the URL.</div></li>\r
 256 <li><b>disableCaching</b> : Boolean (Optional)<div class="sub-desc">True\r
 257 to add a unique cache-buster param to GET requests.</div></li>\r
 258 </ul></p>\r
 259 <p>The options object may also contain any other property which might be needed to perform\r
 260 postprocessing in a callback because it is passed to callback functions.</p></div></li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc">transactionId The id of the server transaction. This may be used&#13;
 261 to cancel the request.</div></li></ul></div></div></div></td><td class="msource">Connection</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-resumeEvents"></a><b><a href="source/Observable.html#method-Ext.util.Observable-resumeEvents">resumeEvents</a></b>()
 262     :
 263                                         void<div class="mdesc"><div class="short">Resume firing events. (see suspendEvents)
 264 If events were suspended using the queueSuspended parameter, then all
 265 event...</div><div class="long">Resume firing events. (see <a href="output/Ext.util.Observable.html#Ext.util.Observable-suspendEvents" ext:member="suspendEvents" ext:cls="Ext.util.Observable">suspendEvents</a>)
 266 If events were suspended using the <tt><b>queueSuspended</b></tt> parameter, then all
 267 events fired during event suspension will be sent to any listeners now.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#resumeEvents" ext:member="#resumeEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-suspendEvents"></a><b><a href="source/Observable.html#method-Ext.util.Observable-suspendEvents">suspendEvents</a></b>(&nbsp;<code>Boolean&nbsp;queueSuspended</code>&nbsp;)
 268     :
 269                                         void<div class="mdesc"><div class="short">Suspend the firing of all events. (see resumeEvents)</div><div class="long">Suspend the firing of all events. (see <a href="output/Ext.util.Observable.html#Ext.util.Observable-resumeEvents" ext:member="resumeEvents" ext:cls="Ext.util.Observable">resumeEvents</a>)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>queueSuspended</code> : Boolean<div class="sub-desc">Pass as true to queue up suspended events to be fired
 270 after the <a href="output/Ext.util.Observable.html#Ext.util.Observable-resumeEvents" ext:member="resumeEvents" ext:cls="Ext.util.Observable">resumeEvents</a> call instead of discarding all suspended events;</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#suspendEvents" ext:member="#suspendEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.util.Observable-un"></a><b><a href="source/Observable.html#method-Ext.util.Observable-un">un</a></b>(&nbsp;<code>String&nbsp;eventName</code>,&nbsp;<code>Function&nbsp;handler</code>,&nbsp;<span title="Optional" class="optional">[<code>Object&nbsp;scope</code>]</span>&nbsp;)
 271     :
 272                                         void<div class="mdesc"><div class="short">Removes an event handler (shorthand for removeListener.)</div><div class="long">Removes an event handler (shorthand for <a href="output/Ext.util.Observable.html#Ext.util.Observable-removeListener" ext:member="removeListener" ext:cls="Ext.util.Observable">removeListener</a>.)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The type of event the handler was associated with.</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove. <b>This must be a reference to the function passed into the <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a> call.</b></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope originally specified for the handler.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#un" ext:member="#un" ext:cls="Ext.util.Observable">Observable</a></td></tr></tbody></table><a id="Ext.data.Connection-events"></a><h2>Public Events</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Event</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Connection-beforerequest"></a><b><a href="source/Connection.html#event-Ext.data.Connection-beforerequest">beforerequest</a></b> :
 273                                       (&nbsp;<code>Connection&nbsp;conn</code>,&nbsp;<code>Object&nbsp;options</code>&nbsp;)
 274     <div class="mdesc"><div class="short">Fires before a network request is made to retrieve a data object.</div><div class="long">Fires before a network request is made to retrieve a data object.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>conn</code> : Connection<div class="sub-desc">This Connection object.</div></li><li><code>options</code> : Object<div class="sub-desc">The options config object passed to the <a href="output/Ext.data.Connection.html#Ext.data.Connection-request" ext:member="request" ext:cls="Ext.data.Connection">request</a> method.</div></li></ul></div></div></div></td><td class="msource">Connection</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Connection-requestcomplete"></a><b><a href="source/Connection.html#event-Ext.data.Connection-requestcomplete">requestcomplete</a></b> :
 275                                       (&nbsp;<code>Connection&nbsp;conn</code>,&nbsp;<code>Object&nbsp;response</code>,&nbsp;<code>Object&nbsp;options</code>&nbsp;)
 276     <div class="mdesc"><div class="short">Fires if the request was successfully completed.</div><div class="long">Fires if the request was successfully completed.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>conn</code> : Connection<div class="sub-desc">This Connection object.</div></li><li><code>response</code> : Object<div class="sub-desc">The XHR object containing the response data.\r
 277 See <a href="http://www.w3.org/TR/XMLHttpRequest/">The XMLHttpRequest Object</a>\r
 278 for details.</div></li><li><code>options</code> : Object<div class="sub-desc">The options config object passed to the <a href="output/Ext.data.Connection.html#Ext.data.Connection-request" ext:member="request" ext:cls="Ext.data.Connection">request</a> method.</div></li></ul></div></div></div></td><td class="msource">Connection</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.data.Connection-requestexception"></a><b><a href="source/Connection.html#event-Ext.data.Connection-requestexception">requestexception</a></b> :
 279                                       (&nbsp;<code>Connection&nbsp;conn</code>,&nbsp;<code>Object&nbsp;response</code>,&nbsp;<code>Object&nbsp;options</code>&nbsp;)
 280     <div class="mdesc"><div class="short">Fires if an error HTTP status was returned from the server.&#13;
 281 See &lt;a href="http://www.w3.org/Protocols/rfc2616/rfc2616...</div><div class="long">Fires if an error HTTP status was returned from the server.\r
 282 See <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html">HTTP Status Code Definitions</a>\r
 283 for details of HTTP status codes.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>conn</code> : Connection<div class="sub-desc">This Connection object.</div></li><li><code>response</code> : Object<div class="sub-desc">The XHR object containing the response data.\r
 284 See <a href="http://www.w3.org/TR/XMLHttpRequest/">The XMLHttpRequest Object</a>\r
 285 for details.</div></li><li><code>options</code> : Object<div class="sub-desc">The options config object passed to the <a href="output/Ext.data.Connection.html#Ext.data.Connection-request" ext:member="request" ext:cls="Ext.data.Connection">request</a> method.</div></li></ul></div></div></div></td><td class="msource">Connection</td></tr></tbody></table></div>