docs/output/Ext.Ajax.html

   1 <div xmlns:ext="http://www.extjs.com" class="body-wrap"><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"><a href="output/Ext.data.Connection.html" ext:member="" ext:cls="Ext.data.Connection">Connection</a>&#13;&nbsp;&nbsp;&nbsp;&nbsp;<img src="resources/elbow-end.gif">Ajax</pre></div><h1>Class <a href="source/Connection.html#cls-Ext.Ajax">Ext.Ajax</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext</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.Ajax">Ajax</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info"><a href="output/Ext.data.Connection.html" ext:cls="Ext.data.Connection" ext:member="">Connection</a></td></tr></table><div class="description"><p>The global Ajax request class that provides a simple way to make Ajax requests\r
   2 with maximum flexibility.</p>\r
   3 <p>Since Ext.Ajax is a singleton, you can set common properties/events for it once\r
   4 and override them at the request function level only if necessary.</p>\r
   5 <p>Common <b>Properties</b> you may want to set are:<div class="mdetail-params"><ul>\r
   6 <li><b><tt><a href="output/Ext.Ajax.html#Ext.Ajax-method" ext:member="method" ext:cls="Ext.Ajax">method</a></tt></b><p class="sub-desc"></p></li>\r
   7 <li><b><tt><a href="output/Ext.Ajax.html#Ext.Ajax-extraParams" ext:member="extraParams" ext:cls="Ext.Ajax">extraParams</a></tt></b><p class="sub-desc"></p></li>\r
   8 <li><b><tt><a href="output/Ext.Ajax.html#Ext.Ajax-url" ext:member="url" ext:cls="Ext.Ajax">url</a></tt></b><p class="sub-desc"></p></li>\r
   9 </ul></div>\r
  10 <pre><code><i>// Default headers to pass <b>in</b> every request\r</i>
  11 Ext.Ajax.defaultHeaders = {\r
  12     <em>'Powered-By'</em>: <em>'Ext'</em>\r
  13 };</code></pre>\r
  14 </p>\r
  15 <p>Common <b>Events</b> you may want to set are:<div class="mdetail-params"><ul>\r
  16 <li><b><tt><a href="output/Ext.data.Connection.html#Ext.data.Connection-beforerequest" ext:member="beforerequest" ext:cls="Ext.data.Connection">beforerequest</a></tt></b><p class="sub-desc"></p></li>\r
  17 <li><b><tt><a href="output/Ext.data.Connection.html#Ext.data.Connection-requestcomplete" ext:member="requestcomplete" ext:cls="Ext.data.Connection">requestcomplete</a></tt></b><p class="sub-desc"></p></li>\r
  18 <li><b><tt><a href="output/Ext.data.Connection.html#Ext.data.Connection-requestexception" ext:member="requestexception" ext:cls="Ext.data.Connection">requestexception</a></tt></b><p class="sub-desc"></p></li>\r
  19 </ul></div>\r
  20 <pre><code><i>// Example: show a spinner during all Ajax requests\r</i>
  21 Ext.Ajax.on(<em>'beforerequest'</em>, this.showSpinner, this);\r
  22 Ext.Ajax.on(<em>'requestcomplete'</em>, this.hideSpinner, this);\r
  23 Ext.Ajax.on(<em>'requestexception'</em>, this.hideSpinner, this);</code></pre>\r
  24 </p>\r
  25 <p>An example request:</p>\r
  26 <pre><code><i>// Basic request\r</i>
  27 Ext.Ajax.<a href="output/Ext.data.Connection.html#Ext.data.Connection-request" ext:member="request" ext:cls="Ext.data.Connection">request</a>({\r
  28    url: <em>'foo.php'</em>,\r
  29    success: someFn,\r
  30    failure: otherFn,\r
  31    headers: {\r
  32        <em>'my-header'</em>: <em>'foo'</em>\r
  33    },\r
  34    params: { foo: <em>'bar'</em> }\r
  35 });\r
  36 \r
  37 <i>// Simple ajax form submission\r</i>
  38 Ext.Ajax.<a href="output/Ext.data.Connection.html#Ext.data.Connection-request" ext:member="request" ext:cls="Ext.data.Connection">request</a>({\r
  39     form: <em>'some-form'</em>,\r
  40     params: <em>'foo=bar'</em>\r
  41 });</code></pre>\r
  42 </p><br><br><i>This class is a singleton and cannot be created directly.</i></div><div class="hr"></div><a id="Ext.Ajax-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  inherited"><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
  43 through a cache buster. Defaults to '_dc'</div></td><td class="msource"><a href="output/Ext.data.Connection.html#disableCachingParam" ext:member="#disableCachingParam" ext:cls="Ext.data.Connection">Connection</a></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
  44 object during initialization.  This should ...</div><div class="long"><p>A config object containing one or more event handlers to be added to this
  45 object during initialization.  This should be a valid listeners config object as specified in the
  46 <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>
  47 <br><p><b><u>DOM events from ExtJs <a href="output/Ext.Component.html" ext:cls="Ext.Component">Components</a></u></b></p>
  48 <br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
  49 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
  50 <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
  51 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
  52 has been rendered. A plugin can simplify this step:<pre><code><i>// Plugin is configured <b>with</b> a listeners config object.</i>
  53 <i>// The Component is appended to the argument list of all handler functions.</i>
  54 Ext.DomObserver = Ext.extend(Object, {
  55     constructor: <b>function</b>(config) {
  56         this.listeners = config.listeners ? config.listeners : config;
  57     },
  58
  59     <i>// Component passes itself into plugin&#39;s init method</i>
  60     init: <b>function</b>(c) {
  61         <b>var</b> p, l = this.listeners;
  62         <b>for</b> (p <b>in</b> l) {
  63             <b>if</b> (Ext.isFunction(l[p])) {
  64                 l[p] = this.createHandler(l[p], c);
  65             } <b>else</b> {
  66                 l[p].fn = this.createHandler(l[p].fn, c);
  67             }
  68         }
  69
  70         <i>// Add the listeners to the Element immediately following the render call</i>
  71         c.render = c.render.<a href="output/Function.html#Function-createSequence" ext:member="createSequence" ext:cls="Function">createSequence</a>(<b>function</b>() {
  72             <b>var</b> e = c.getEl();
  73             <b>if</b> (e) {
  74                 e.on(l);
  75             }
  76         });
  77     },
  78
  79     createHandler: <b>function</b>(fn, c) {
  80         <b>return</b> <b>function</b>(e) {
  81             fn.call(this, e, c);
  82         };
  83     }
  84 });
  85
  86 <b>var</b> combo = <b>new</b> Ext.form.ComboBox({
  87
  88     <i>// Collapse combo when its element is clicked on</i>
  89     plugins: [ <b>new</b> Ext.DomObserver({
  90         click: <b>function</b>(evt, comp) {
  91             comp.collapse();
  92         }
  93     })],
  94     store: myStore,
  95     typeAhead: true,
  96     mode: <em>'local'</em>,
  97     triggerAction: <em>'all'</em>
  98 });</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></tbody></table><a id="Ext.Ajax-props"></a><h2>Public Properties</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Property</th><th class="msource-header">Defined By</th></tr><tr class="property-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Ajax-autoAbort"></a><b><a href="source/Connection.html#prop-Ext.Ajax-autoAbort">autoAbort</a></b> : Boolean<div class="mdesc">Whether a new request should abort any pending requests. (defaults to false)</div></td><td class="msource">Ajax</td></tr><tr class="property-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Ajax-defaultHeaders"></a><b><a href="source/Connection.html#prop-Ext.Ajax-defaultHeaders">defaultHeaders</a></b> : Object<div class="mdesc">An object containing request headers which are added to each request made by this object\r
  99 (defaults to undefined).</div></td><td class="msource">Ajax</td></tr><tr class="property-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Ajax-disableCaching"></a><b><a href="source/Connection.html#prop-Ext.Ajax-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">Ajax</td></tr><tr class="property-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Ajax-extraParams"></a><b><a href="source/Connection.html#prop-Ext.Ajax-extraParams">extraParams</a></b> : Object<div class="mdesc"><div class="short">An object containing properties which are used as extra parameters to each request made&#13;
 100 by this object (defaults to ...</div><div class="long">An object containing properties which are used as extra parameters to each request made\r
 101 by this object (defaults to undefined). Session information and other data that you need\r
 102 to pass with each request are commonly put here.</div></div></td><td class="msource">Ajax</td></tr><tr class="property-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Ajax-method"></a><b><a href="source/Connection.html#prop-Ext.Ajax-method">method</a></b> : String<div class="mdesc"><div class="short">The default HTTP method to be used for requests. Note that this is case-sensitive and&#13;
 103 should be all caps (defaults t...</div><div class="long">The default HTTP method to be used for requests. Note that this is case-sensitive and\r
 104 should be all caps (defaults to undefined; if not set but params are present will use\r
 105 <tt>"POST"</tt>, otherwise will use <tt>"GET"</tt>.)</div></div></td><td class="msource">Ajax</td></tr><tr class="property-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Ajax-timeout"></a><b><a href="source/Connection.html#prop-Ext.Ajax-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">Ajax</td></tr><tr class="property-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Ajax-url"></a><b><a href="source/Connection.html#prop-Ext.Ajax-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;
 106 If the server receives all requests t...</div><div class="long">The default URL to be used for requests to the server. (defaults to undefined)\r
 107 If the server receives all requests through one URL, setting this once is easier than\r
 108 entering it on every request.</div></div></td><td class="msource">Ajax</td></tr></tbody></table><a id="Ext.Ajax-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 inherited"><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;)
 109     :
 110                                         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"><a href="output/Ext.data.Connection.html#abort" ext:member="#abort" ext:cls="Ext.data.Connection">Connection</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-addEvents"></a><b><a href="source/Observable.html#method-Ext.util.Observable-addEvents">addEvents</a></b>(&nbsp;<code>Object|String&nbsp;o</code>,&nbsp;<code>string&nbsp;Optional.</code>&nbsp;)
 111     :
 112                                         void<div class="mdesc"><div class="short">Adds the specified events to the list of events which this Observable may fire.</div><div class="long">Adds the specified events to the list of events which this Observable may fire.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>o</code> : Object|String<div class="sub-desc">Either an object with event names as properties with a value of <code>true</code>
 113 or the first event name string if multiple event names are being passed as separate parameters.</div></li><li><code>Optional.</code> : string<div class="sub-desc">Event name if multiple event names are being passed as separate parameters.
 114 Usage:<pre><code>this.addEvents(<em>'storeloaded'</em>, <em>'storecleared'</em>);</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#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;)
 115     :
 116                                         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.
 117 <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.
 118 properties. This may contain any of the following properties:<ul>
 119 <li><b>scope</b> : Object<div class="sub-desc">The scope (<code><b>this</b></code> reference) in which the handler function is executed.
 120 <b>If omitted, defaults to the object which fired the event.</b></div></li>
 121 <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>
 122 <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>
 123 <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
 124 by the specified number of milliseconds. If the event fires again within that time, the original
 125 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>
 126 <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>
 127 if the event was bubbled up from a child Observable.</div></li>
 128 </ul><br>
 129 <p>
 130 <b>Combining Options</b><br>
 131 Using the options argument, it is possible to combine different types of listeners:<br>
 132 <br>
 133 A delayed, one-time listener.
 134 <pre><code>myDataView.on(<em>'click'</em>, this.onClick, this, {
 135 single: true,
 136 delay: 100
 137 });</code></pre>
 138 <p>
 139 <b>Attaching multiple handlers in 1 call</b><br>
 140 The method also allows for a single argument to be passed which is a config object containing properties
 141 which specify multiple handlers.
 142 <p>
 143 <pre><code>myGridPanel.on({
 144 <em>'click'</em> : {
 145     fn: this.onClick,
 146     scope: this,
 147     delay: 100
 148 },
 149 <em>'mouseover'</em> : {
 150     fn: this.onMouseOver,
 151     scope: this
 152 },
 153 <em>'mouseout'</em> : {
 154     fn: this.onMouseOut,
 155     scope: this
 156 }
 157 });</code></pre>
 158 <p>
 159 Or a shorthand syntax:<br>
 160 <pre><code>myGridPanel.on({
 161 <em>'click'</em> : this.onClick,
 162 <em>'mouseover'</em> : this.onMouseOver,
 163 <em>'mouseout'</em> : this.onMouseOut,
 164  scope: this
 165 });</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>String/Array&nbsp;events</code>&nbsp;)
 166     :
 167                                         void<div class="mdesc"><div class="short">Enables events fired by this Observable to bubble up an owner hierarchy by calling&#13;
 168 this.getBubbleTarget() if present...</div><div class="long"><p>Enables events fired by this Observable to bubble up an owner hierarchy by calling\r
 169 <code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>\r
 170 <p>This is commonly used by Ext.Components to bubble events to owner Containers. See <a href="output/Ext.Component.getBubbleTarget.html" ext:cls="Ext.Component.getBubbleTarget">Ext.Component.getBubbleTarget</a>. The default\r
 171 implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to\r
 172 access the required target more quickly.</p>\r
 173 <p>Example:</p><pre><code>Ext.override(Ext.form.Field, {\r
 174     <i>//  Add functionality to Field&#39;s initComponent to enable the change event to bubble\r</i>
 175     initComponent : Ext.form.Field.prototype.initComponent.createSequence(<b>function</b>() {\r
 176         this.enableBubble(<em>'change'</em>);\r
 177     }),\r
 178 \r
 179     <i>//  We know that we want Field&#39;s events to bubble directly to the FormPanel.\r</i>
 180     getBubbleTarget : <b>function</b>() {\r
 181         <b>if</b> (!this.formPanel) {\r
 182             this.formPanel = this.findParentByType(<em>'form'</em>);\r
 183         }\r
 184         <b>return</b> this.formPanel;\r
 185     }\r
 186 });\r
 187 \r
 188 <b>var</b> myForm = <b>new</b> Ext.formPanel({\r
 189     title: <em>'User Details'</em>,\r
 190     items: [{\r
 191         ...\r
 192     }],\r
 193     listeners: {\r
 194         change: <b>function</b>() {\r
 195             <i>// Title goes red <b>if</b> form has been modified.\r</i>
 196             myForm.header.setStyle(<em>'color'</em>, <em>'red'</em>);\r
 197         }\r
 198     }\r
 199 });</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>events</code> : String/Array<div class="sub-desc">The event name to bubble, or an Array of event names.</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;)
 200     :
 201                                         Boolean<div class="mdesc"><div class="short">Fires the specified event with the passed parameters (minus the event name).
 202 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>
 203 <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>)
 204 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;)
 205     :
 206                                         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 inherited"><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;)
 207     :
 208                                         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"><a href="output/Ext.data.Connection.html#isLoading" ext:member="#isLoading" ext:cls="Ext.data.Connection">Connection</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-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;)
 209     :
 210                                         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.
 211 <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>()
 212     :
 213                                         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;)
 214     :
 215                                         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;)
 216     :
 217                                         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 inherited"><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;)
 218     :
 219                                         Number<div class="mdesc"><div class="short">Sends an HTTP request to a remote server.&#13;
 220 Important: Ajax server requests are asynchronous, and this call will&#13;
 221 retu...</div><div class="long"><p>Sends an HTTP request to a remote server.</p>\r
 222 <p><b>Important:</b> Ajax server requests are asynchronous, and this call will\r
 223 return before the response has been received. Process any returned data\r
 224 in a callback function.</p>\r
 225 <pre><code>Ext.Ajax.request({\r
 226    url: <em>'ajax_demo/sample.json'</em>,\r
 227    success: <b>function</b>(response, opts) {\r
 228       <b>var</b> obj = Ext.decode(response.responseText);\r
 229       console.dir(obj);\r
 230    },\r
 231    failure: <b>function</b>(response, opts) {\r
 232       console.log(<em>'server-side failure <b>with</b> status code '</em> + response.status);\r
 233    }\r
 234 });</code></pre>\r
 235 <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
 236 <li><b>url</b> : String/Function (Optional)<div class="sub-desc">The URL to\r
 237 which to send the request, or a function to call which returns a URL string. The scope of the\r
 238 function is specified by the <tt>scope</tt> option. Defaults to the configured\r
 239 <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
 240 <li><b>params</b> : Object/String/Function (Optional)<div class="sub-desc">\r
 241 An object containing properties which are used as parameters to the\r
 242 request, a url encoded string or a function to call to get either. The scope of the function\r
 243 is specified by the <tt>scope</tt> option.</div></li>\r
 244 <li><b>method</b> : String (Optional)<div class="sub-desc">The HTTP method to use\r
 245 for the request. Defaults to the configured method, or if no method was configured,\r
 246 "GET" if no parameters are being sent, and "POST" if parameters are being sent.  Note that\r
 247 the method name is case-sensitive and should be all caps.</div></li>\r
 248 <li><b>callback</b> : Function (Optional)<div class="sub-desc">The\r
 249 function to be called upon receipt of the HTTP response. The callback is\r
 250 called regardless of success or failure and is passed the following\r
 251 parameters:<ul>\r
 252 <li><b>options</b> : Object<div class="sub-desc">The parameter to the request call.</div></li>\r
 253 <li><b>success</b> : Boolean<div class="sub-desc">True if the request succeeded.</div></li>\r
 254 <li><b>response</b> : Object<div class="sub-desc">The XMLHttpRequest object containing the response data.\r
 255 See <a href="http://www.w3.org/TR/XMLHttpRequest/">http://www.w3.org/TR/XMLHttpRequest/</a> for details about\r
 256 accessing elements of the response.</div></li>\r
 257 </ul></div></li>\r
 258 <li><a id="request-option-success"></a><b>success</b> : Function (Optional)<div class="sub-desc">The function\r
 259 to be called upon success of the request. The callback is passed the following\r
 260 parameters:<ul>\r
 261 <li><b>response</b> : Object<div class="sub-desc">The XMLHttpRequest object containing the response data.</div></li>\r
 262 <li><b>options</b> : Object<div class="sub-desc">The parameter to the request call.</div></li>\r
 263 </ul></div></li>\r
 264 <li><b>failure</b> : Function (Optional)<div class="sub-desc">The function\r
 265 to be called upon failure of the request. The callback is passed the\r
 266 following parameters:<ul>\r
 267 <li><b>response</b> : Object<div class="sub-desc">The XMLHttpRequest object containing the response data.</div></li>\r
 268 <li><b>options</b> : Object<div class="sub-desc">The parameter to the request call.</div></li>\r
 269 </ul></div></li>\r
 270 <li><b>scope</b> : Object (Optional)<div class="sub-desc">The scope in\r
 271 which to execute the callbacks: The "this" object for the callback function. If the <tt>url</tt>, or <tt>params</tt> options were\r
 272 specified as functions from which to draw values, then this also serves as the scope for those function calls.\r
 273 Defaults to the browser window.</div></li>\r
 274 <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
 275 <li><b>form</b> : Element/HTMLElement/String (Optional)<div class="sub-desc">The <tt>&lt;form&gt;</tt>\r
 276 Element or the id of the <tt>&lt;form&gt;</tt> to pull parameters from.</div></li>\r
 277 <li><a id="request-option-isUpload"></a><b>isUpload</b> : Boolean (Optional)<div class="sub-desc"><b>Only meaningful when used\r
 278 with the <tt>form</tt> option</b>.\r
 279 <p>True if the form object is a file upload (will be set automatically if the form was\r
 280 configured with <b><tt>enctype</tt></b> "multipart/form-data").</p>\r
 281 <p>File uploads are not performed using normal "Ajax" techniques, that is they are <b>not</b>\r
 282 performed using XMLHttpRequests. Instead the form is submitted in the standard manner with the\r
 283 DOM <tt>&lt;form></tt> element temporarily modified to have its\r
 284 <a href="http://www.w3.org/TR/REC-html40/present/frames.html#adef-target">target</a> set to refer\r
 285 to a dynamically generated, hidden <tt>&lt;iframe></tt> which is inserted into the document\r
 286 but removed after the return data has been gathered.</p>\r
 287 <p>The server response is parsed by the browser to create the document for the IFRAME. If the\r
 288 server is using JSON to send the return object, then the\r
 289 <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17">Content-Type</a> header\r
 290 must be set to "text/html" in order to tell the browser to insert the text unchanged into the document body.</p>\r
 291 <p>The response text is retrieved from the document, and a fake XMLHttpRequest object\r
 292 is created containing a <tt>responseText</tt> property in order to conform to the\r
 293 requirements of event handlers and callbacks.</p>\r
 294 <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
 295 and some server technologies (notably JEE) may require some custom processing in order to\r
 296 retrieve parameter names and parameter values from the packet content.</p>\r
 297 </div></li>\r
 298 <li><b>headers</b> : Object (Optional)<div class="sub-desc">Request\r
 299 headers to set for the request.</div></li>\r
 300 <li><b>xmlData</b> : Object (Optional)<div class="sub-desc">XML document\r
 301 to use for the post. Note: This will be used instead of params for the post\r
 302 data. Any params will be appended to the URL.</div></li>\r
 303 <li><b>jsonData</b> : Object/String (Optional)<div class="sub-desc">JSON\r
 304 data to use as the post. Note: This will be used instead of params for the post\r
 305 data. Any params will be appended to the URL.</div></li>\r
 306 <li><b>disableCaching</b> : Boolean (Optional)<div class="sub-desc">True\r
 307 to add a unique cache-buster param to GET requests.</div></li>\r
 308 </ul></p>\r
 309 <p>The options object may also contain any other property which might be needed to perform\r
 310 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;
 311 to cancel the request.</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.data.Connection.html#request" ext:member="#request" ext:cls="Ext.data.Connection">Connection</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-resumeEvents"></a><b><a href="source/Observable.html#method-Ext.util.Observable-resumeEvents">resumeEvents</a></b>()
 312     :
 313                                         void<div class="mdesc"><div class="short">Resume firing events. (see suspendEvents)
 314 If events were suspended using the queueSuspended parameter, then all
 315 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>)
 316 If events were suspended using the <tt><b>queueSuspended</b></tt> parameter, then all
 317 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 "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.Ajax-serializeForm"></a><b><a href="source/Connection.html#method-Ext.Ajax-serializeForm">serializeForm</a></b>(&nbsp;<code>String/HTMLElement&nbsp;form</code>&nbsp;)
 318     :
 319                                         String<div class="mdesc"><div class="short">Serialize the passed form into a url encoded string</div><div class="long">Serialize the passed form into a url encoded string<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>form</code> : String/HTMLElement<div class="sub-desc"></div></li></ul><strong>Returns:</strong><ul><li><code>String</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">Ajax</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;)
 320     :
 321                                         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
 322 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;)
 323     :
 324                                         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.Ajax-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 inherited"><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> :
 325                                       (&nbsp;<code>Connection&nbsp;conn</code>,&nbsp;<code>Object&nbsp;options</code>&nbsp;)
 326     <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"><a href="output/Ext.data.Connection.html#beforerequest" ext:member="#beforerequest" ext:cls="Ext.data.Connection">Connection</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.data.Connection-requestcomplete"></a><b><a href="source/Connection.html#event-Ext.data.Connection-requestcomplete">requestcomplete</a></b> :
 327                                       (&nbsp;<code>Connection&nbsp;conn</code>,&nbsp;<code>Object&nbsp;response</code>,&nbsp;<code>Object&nbsp;options</code>&nbsp;)
 328     <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
 329 See <a href="http://www.w3.org/TR/XMLHttpRequest/">The XMLHttpRequest Object</a>\r
 330 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"><a href="output/Ext.data.Connection.html#requestcomplete" ext:member="#requestcomplete" ext:cls="Ext.data.Connection">Connection</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.data.Connection-requestexception"></a><b><a href="source/Connection.html#event-Ext.data.Connection-requestexception">requestexception</a></b> :
 331                                       (&nbsp;<code>Connection&nbsp;conn</code>,&nbsp;<code>Object&nbsp;response</code>,&nbsp;<code>Object&nbsp;options</code>&nbsp;)
 332     <div class="mdesc"><div class="short">Fires if an error HTTP status was returned from the server.&#13;
 333 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
 334 See <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html">HTTP Status Code Definitions</a>\r
 335 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
 336 See <a href="http://www.w3.org/TR/XMLHttpRequest/">The XMLHttpRequest Object</a>\r
 337 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"><a href="output/Ext.data.Connection.html#requestexception" ext:member="#requestexception" ext:cls="Ext.data.Connection">Connection</a></td></tr></tbody></table></div>