docs/api/Ext.data.Connection.html

   1 <!DOCTYPE html><html><head><title>Ext.data.Connection | Ext JS 4.0 Documentation</title><script type="text/javascript" src="../ext-all.js"></script><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../scrollbars.css" type="text/css"><link rel="stylesheet" href="../docs.css" type="text/css"><link id="styleCss" rel="stylesheet" href="../style.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script><link rel="stylesheet" href="../prettify.css" type="text/css"><!-- link(rel: 'stylesheet', href: req.baseURL + '/css/ext4.css', type: 'text/css')--><link rel="shortcut icon" type="image/ico" href="../favicon.ico"><!--[if IE]>
   2 <style type="text/css">.head-band { display: none; }
   3 .header { border: 0; top: 0; left: 0px; background: url(../header.gif) repeat-x; }
   4 .doc-tab .members .member a.more { background-color: #efefef; }
   5 </style><link rel="stylesheet" href="/new/css/ie.css" type="text/css"><![endif]-->
   6 </head><body id="ext-body" class="iScroll"><div id="notice" class="notice">For up to date documentation and features, visit
   7 <a href="http://docs.sencha.com/ext-js/4-0">http://docs.sencha.com/ext-js/4-0</a></div><div class="wrapper"><div class="head-band"></div><div class="header"><h2><a href="../index.html">Sencha Documentation</a></h2></div><div id="search"><form><input type="text" placeholder="Search" id="search-field" autocomplete="off" name="q"></form><div id="search-box"></div></div><div id="treePanel"></div><div id="container"><script type="text/javascript">
   8
   9     req = {
  10         liveURL: '.',
  11         standAloneMode: true,
  12         origDocClass: 'Ext.data.Connection',
  13         docClass: 'Ext.data.Connection',
  14         docReq: 'Ext.data.Connection',
  15         version: '4.0',
  16         baseURL: '.',
  17         baseDocURL: '.',
  18         baseProdURL: '.'
  19     };
  20
  21     clsInfo = {};
  22
  23
  24
  25 </script>
  26
  27 <script type="text/javascript" src="../search.js"></script>
  28 <!--script type="text/javascript" src="/new/javascripts/app/examples.js"></script-->
  29 <script type="text/javascript" src="../class_tree.js"></script>
  30 <script type="text/javascript" src="../class_doc.js"></script>
  31 <script type="text/javascript">
  32     req.source = 'Connection.html#Ext-data.Connection';
  33     clsInfo = {"methods":["abort","addEvents","addListener","addManagedListener","capture","clearListeners","clearManagedListeners","enableBubble","fireEvent","hasListener","isLoading","observe","on","parseStatus","relayEvents","releaseCapture","removeListener","removeManagedListener","request","resumeEvents","setOptions","suspendEvents","un","upload"],"cfgs":["listeners","timeout"],"properties":["disableCaching","disableCachingParam","onreadystatechange","useDefaultHeader"],"events":["beforerequest","requestcomplete","requestexception"],"subclasses":["Ext.Ajax"]};
  34     Ext.onReady(function() {
  35         Ext.create('Docs.classPanel');
  36     });
  37 </script><div id="top-block" class="top-block"><h1 id="clsTitle" class="cls"><a href="../source/Connection.html#Ext-data.Connection" target="_blank">Ext.data.Connection</a></h1></div><div id="docContent"><div id="doc-overview-content"><div class="lft"><pre class="subclasses"><h4>Mixins</h4><div class="mixin"><a href="Ext.util.Observable.html" rel="Ext.util.Observable" class="cls docClass">Ext.util.Observable</a></div></pre><p>The Connection class encapsulates a connection to the page's originating domain, allowing requests to be made either
  38 to a configured URL, or to a URL specified at request time.</p>
  39
  40 <p>Requests made by this class are asynchronous, and will return immediately. No data from the server will be available
  41 to the statement immediately following the <a href="Ext.data.Connection.html#request" rel="Ext.data.Connection#request" class="docClass">request</a> call. To process returned data, use a success callback
  42 in the request options object, or an <a href="Ext.data.Connection.html#requestcomplete" rel="Ext.data.Connection#requestcomplete" class="docClass">event listener</a>.</p>
  43
  44 <p><u>File Uploads</u></p>
  45
  46
  47 <p>File uploads are not performed using normal "Ajax" techniques, that is they are not performed using XMLHttpRequests.
  48 Instead the form is submitted in the standard manner with the DOM &lt;form&gt; element temporarily modified to have its
  49 target set to refer to a dynamically generated, hidden &lt;iframe&gt; which is inserted into the document but removed
  50 after the return data has been gathered.</p>
  51
  52 <p>The server response is parsed by the browser to create the document for the IFRAME. If the server is using JSON to
  53 send the return object, then the Content-Type header must be set to "text/html" in order to tell the browser to
  54 insert the text unchanged into the document body.</p>
  55
  56 <p>Characters which are significant to an HTML parser must be sent as HTML entities, so encode "&lt;" as "&amp;lt;", "&amp;" as
  57 "&amp;amp;" etc.</p>
  58
  59 <p>The response text is retrieved from the document, and a fake XMLHttpRequest object is created containing a
  60 responseText property in order to conform to the requirements of event handlers and callbacks.</p>
  61
  62 <p>Be aware that file upload packets are sent with the content type multipart/form and some server technologies
  63 (notably JEE) may require some custom processing in order to retrieve parameter names and parameter values from the
  64 packet content.</p>
  65
  66 <p>Also note that it's not possible to check the response code of the hidden iframe, so the success handler will ALWAYS fire.</p>
  67 <div class="members"><div class="m-cfgs"><div class="definedBy">Defined By</div><a name="configs"></a><h3 class="cfg p">Config Options</h3><h4 class="cfgGroup">Other Configs</h4><div id="config-listeners" class="member f inherited"><a href="Ext.data.Connection.html#config-listeners" rel="config-listeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-cfg-listeners" class="viewSource">view source</a></div><a name="listeners"></a><a name="config-listeners"></a><a href="Ext.data.Connection.html#" rel="config-listeners" class="cls expand">listeners</a><span> : Object</span></div><div class="description"><div class="short">(optional) A config object containing one or more event handlers to be added to this
  68 object during initialization.  T...</div><div class="long"><p>(optional) <p>A config object containing one or more event handlers to be added to this
  69 object during initialization.  This should be a valid listeners config object as specified in the
  70 <a href="Ext.data.Connection.html#addListener" rel="Ext.data.Connection#addListener" class="docClass">addListener</a> example for attaching multiple handlers at once.</p></p>
  71
  72 <br><p><b><u>DOM events from ExtJs <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a></u></b></p>
  73
  74
  75 <br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
  76
  77
  78 <p>is usually only done when extra value can be added. For example the <a href="Ext.view.View.html" rel="Ext.view.View" class="docClass">DataView</a>'s
  79 <b><code><a href="Ext.view.View.html#click" rel="Ext.view.View#click" class="docClass">click</a></code></b> event passing the node clicked on. To access DOM
  80 events directly from a child element of a Component, we need to specify the <code>element</code> option to
  81 identify the Component property to add a DOM listener to:</p>
  82
  83 <pre><code>new Ext.panel.Panel({
  84     width: 400,
  85     height: 200,
  86     dockedItems: [{
  87         xtype: 'toolbar'
  88     }],
  89     listeners: {
  90         click: {
  91             element: 'el', //bind to the underlying el property on the panel
  92             fn: function(){ console.log('click el'); }
  93         },
  94         dblclick: {
  95             element: 'body', //bind to the underlying body property on the panel
  96             fn: function(){ console.log('dblclick body'); }
  97         }
  98     }
  99 });
 100 </code></pre>
 101
 102
 103 <p></p></p>
 104 </div></div></div><div id="config-timeout" class="member ni"><a href="Ext.data.Connection.html#config-timeout" rel="config-timeout" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Connection.html" class="definedIn docClass">Ext.data.Connection</a><br/><a href="../source/Connection.html#Ext-data.Connection-cfg-timeout" class="viewSource">view source</a></div><a name="timeout"></a><a name="config-timeout"></a><a href="Ext.data.Connection.html#" rel="config-timeout" class="cls expand">timeout</a><span> : Number</span></div><div class="description"><div class="short"><p>(Optional) The timeout in milliseconds to be used for requests. (defaults to 30000)</p>
 105 </div><div class="long"><p>(Optional) The timeout in milliseconds to be used for requests. (defaults to 30000)</p>
 106 </div></div></div></div><div class="m-properties"><a name="properties"></a><div class="definedBy">Defined By</div><h3 class="prp p">Properties</h3><div id="property-disableCaching" class="member f ni"><a href="Ext.data.Connection.html#property-disableCaching" rel="property-disableCaching" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Connection.html" class="definedIn docClass">Ext.data.Connection</a><br/><a href="../source/Connection.html#Ext-data.Connection-property-disableCaching" class="viewSource">view source</a></div><a name="disableCaching"></a><a name="property-disableCaching"></a><a href="Ext.data.Connection.html#" rel="property-disableCaching" class="cls expand">disableCaching</a><span> : Boolean</span></div><div class="description"><div class="short"><p>(Optional) True to add a unique cache-buster param to GET requests. (defaults to true)</p>
 107 </div><div class="long"><p>(Optional) True to add a unique cache-buster param to GET requests. (defaults to true)</p>
 108 </div></div></div><div id="property-disableCachingParam" class="member ni"><a href="Ext.data.Connection.html#property-disableCachingParam" rel="property-disableCachingParam" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Connection.html" class="definedIn docClass">Ext.data.Connection</a><br/><a href="../source/Connection.html#Ext-data.Connection-property-disableCachingParam" class="viewSource">view source</a></div><a name="disableCachingParam"></a><a name="property-disableCachingParam"></a><a href="Ext.data.Connection.html#" rel="property-disableCachingParam" class="cls expand">disableCachingParam</a><span> : String</span></div><div class="description"><div class="short"><p>(Optional) Change the parameter which is sent went disabling caching
 109 through a cache buster. Defaults to '_dc'</p>
 110 </div><div class="long"><p>(Optional) Change the parameter which is sent went disabling caching
 111 through a cache buster. Defaults to '_dc'</p>
 112 </div></div></div><div id="property-onreadystatechange" class="member ni"><a href="Ext.data.Connection.html#property-onreadystatechange" rel="property-onreadystatechange" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Connection.html" class="definedIn docClass">Ext.data.Connection</a><br/><a href="../source/Connection.html#Ext-data.Connection-property-onreadystatechange" class="viewSource">view source</a></div><a name="onreadystatechange"></a><a name="property-onreadystatechange"></a><a href="Ext.data.Connection.html#" rel="property-onreadystatechange" class="cls expand">onreadystatechange</a><span> : Object</span></div><div class="description"><div class="short">Clear out the onreadystatechange here, this allows us
 113 greater control, the browser may/may not fire the function
 114 depe...</div><div class="long"><p>Clear out the onreadystatechange here, this allows us
 115 greater control, the browser may/may not fire the function
 116 depending on a series of conditions.</p>
 117 </div></div></div><div id="property-useDefaultHeader" class="member ni"><a href="Ext.data.Connection.html#property-useDefaultHeader" rel="property-useDefaultHeader" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Connection.html" class="definedIn docClass">Ext.data.Connection</a><br/><a href="../source/Connection.html#Ext-data.Connection-property-useDefaultHeader" class="viewSource">view source</a></div><a name="useDefaultHeader"></a><a name="property-useDefaultHeader"></a><a href="Ext.data.Connection.html#" rel="property-useDefaultHeader" class="cls expand">useDefaultHeader</a><span> : Boolean</span></div><div class="description"><div class="short"><p>&nbsp;</p></div><div class="long">
 118 </div></div></div></div><div class="m-methods"><a name="methods"></a><div class="definedBy">Defined By</div><h3 class="mth p">Methods</h3><div id="method-abort" class="member f ni"><a href="Ext.data.Connection.html#method-abort" rel="method-abort" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Connection.html" class="definedIn docClass">Ext.data.Connection</a><br/><a href="../source/Connection.html#Ext-data.Connection-method-abort" class="viewSource">view source</a></div><a name="abort"></a><a name="method-abort"></a><a href="Ext.data.Connection.html#" rel="method-abort" class="cls expand">abort</a>(
 119 <span class="pre">Object request</span>)
 120  : void</div><div class="description"><div class="short"><p>Aborts any outstanding request.</p>
 121 </div><div class="long"><p>Aborts any outstanding request.</p>
 122 <h3 class="pa">Parameters</h3><ul><li><span class="pre">request</span> : Object<div class="sub-desc"><p>(Optional) defaults to the last request</p>
 123 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 124 </li></ul></div></div></div><div id="method-addEvents" class="member inherited"><a href="Ext.data.Connection.html#method-addEvents" rel="method-addEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addEvents" class="viewSource">view source</a></div><a name="addEvents"></a><a name="method-addEvents"></a><a href="Ext.data.Connection.html#" rel="method-addEvents" class="cls expand">addEvents</a>(
 125 <span class="pre">Object/String o, String </span>)
 126  : void</div><div class="description"><div class="short"><p>Adds the specified events to the list of events which this Observable may fire.</p>
 127 </div><div class="long"><p>Adds the specified events to the list of events which this Observable may fire.</p>
 128 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Object/String<div class="sub-desc"><p>Either an object with event names as properties with a value of <code>true</code>
 129 or the first event name string if multiple event names are being passed as separate parameters.</p>
 130 </div></li><li><span class="pre"></span> : String<div class="sub-desc"><p>[additional] Optional additional event names if multiple event names are being passed as separate parameters.
 131 Usage:</p>
 132
 133 <pre><code>this.addEvents('storeloaded', 'storecleared');
 134 </code></pre>
 135
 136 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 137 </li></ul></div></div></div><div id="method-addListener" class="member inherited"><a href="Ext.data.Connection.html#method-addListener" rel="method-addListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addListener" class="viewSource">view source</a></div><a name="addListener"></a><a name="method-addListener"></a><a href="Ext.data.Connection.html#" rel="method-addListener" class="cls expand">addListener</a>(
 138 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
 139  : void</div><div class="description"><div class="short"><p>Appends an event handler to this object.</p>
 140 </div><div class="long"><p>Appends an event handler to this object.</p>
 141 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to listen for. May also be an object who's property names are event names. See</p>
 142 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes.</p>
 143 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
 144 <b>If omitted, defaults to the object which fired the event.</b></p>
 145 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.
 146 properties. This may contain any of the following properties:<ul>
 147 <li><b>scope</b> : Object<div class="sub-desc">The scope (<code><b>this</b></code> reference) in which the handler function is executed.
 148 <b>If omitted, defaults to the object which fired the event.</b></div></li>
 149 <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>
 150 <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>
 151 <li><b>buffer</b> : Number<div class="sub-desc">Causes the handler to be scheduled to run in an <a href="Ext.util.DelayedTask.html" rel="Ext.util.DelayedTask" class="docClass">Ext.util.DelayedTask</a> delayed
 152 by the specified number of milliseconds. If the event fires again within that time, the original
 153 handler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>
 154 <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>
 155 if the event was bubbled up from a child Observable.</div></li>
 156 <li><b>element</b> : String<div class="sub-desc"><b>This option is only valid for listeners bound to <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a>.</b>
 157 The name of a Component property which references an element to add a listener to.</p>
 158
 159 <p>This option is useful during Component construction to add DOM event listeners to elements of <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Components</a> which
 160 will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:
 161 <pre><code>new Ext.panel.Panel({
 162     title: 'The title',
 163     listeners: {
 164         click: this.handlePanelClick,
 165         element: 'body'
 166     }
 167 });
 168 </code></pre></p>
 169
 170
 171 <p>When added in this way, the options available are the options applicable to <a href="Ext.core.Element.html#addListener" rel="Ext.core.Element#addListener" class="docClass">Ext.core.Element.addListener</a></p>
 172
 173
 174 <p></div></li>
 175 </ul><br></p>
 176
 177 <p>
 178 <b>Combining Options</b><br>
 179 Using the options argument, it is possible to combine different types of listeners:<br>
 180 <br>
 181 A delayed, one-time listener.
 182 <pre><code>myPanel.on('hide', this.handleClick, this, {
 183 single: true,
 184 delay: 100
 185 });</code></pre>
 186 <p>
 187 <b>Attaching multiple handlers in 1 call</b><br>
 188 The method also allows for a single argument to be passed which is a config object containing properties
 189 which specify multiple events. For example:
 190 <pre><code>myGridPanel.on({
 191     cellClick: this.onCellClick,
 192     mouseover: this.onMouseOver,
 193     mouseout: this.onMouseOut,
 194     scope: this // Important. Ensure "this" is correct during handler execution
 195 });
 196 </code></pre>.
 197 <p>
 198
 199 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 200 </li></ul></div></div></div><div id="method-addManagedListener" class="member inherited"><a href="Ext.data.Connection.html#method-addManagedListener" rel="method-addManagedListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-addManagedListener" class="viewSource">view source</a></div><a name="addManagedListener"></a><a name="method-addManagedListener"></a><a href="Ext.data.Connection.html#" rel="method-addManagedListener" class="cls expand">addManagedListener</a>(
 201 <span class="pre">Observable/Element item, Object/String ename, Function fn, Object scope, Object opt</span>)
 202  : void</div><div class="description"><div class="short"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
 203 is destroyed.
 204
 205 </div><div class="long"><p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component
 206 is destroyed.
 207
 208 <h3 class="pa">Parameters</h3><ul><li><span class="pre">item</span> : Observable/Element<div class="sub-desc"><p>The item to which to add a listener/listeners.</p>
 209 </div></li><li><span class="pre">ename</span> : Object/String<div class="sub-desc"><p>The event name, or an object containing event name properties.</p>
 210 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
 211 is the handler function.</p>
 212 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
 213 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
 214 </div></li><li><span class="pre">opt</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
 215 is the <a href="Ext.util.Observable.html#addListener" rel="Ext.util.Observable#addListener" class="docClass">addListener</a> options.</p>
 216 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 217 </li></ul></div></div></div><div id="method-capture" class="member inherited"><a href="Ext.data.Connection.html#method-capture" rel="method-capture" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-capture" class="viewSource">view source</a></div><a name="capture"></a><a name="method-capture"></a><a href="Ext.data.Connection.html#" rel="method-capture" class="cls expand">capture</a>(
 218 <span class="pre">Observable o, Function fn, [Object scope]</span>)
 219  : void</div><div class="description"><div class="short">Starts capture on the specified Observable. All events will be passed
 220 to the supplied function with the event name + ...</div><div class="long"><p>Starts capture on the specified Observable. All events will be passed
 221 to the supplied function with the event name + standard signature of the event
 222 <b>before</b> the event is fired. If the supplied function returns false,
 223 the event will not fire.</p>
 224 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Observable<div class="sub-desc"><p>The Observable to capture events from.</p>
 225 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>The function to call when an event is fired.</p>
 226 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the Observable firing the event.</p>
 227 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 228 </li></ul></div></div></div><div id="method-clearListeners" class="member inherited"><a href="Ext.data.Connection.html#method-clearListeners" rel="method-clearListeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-clearListeners" class="viewSource">view source</a></div><a name="clearListeners"></a><a name="method-clearListeners"></a><a href="Ext.data.Connection.html#" rel="method-clearListeners" class="cls expand">clearListeners</a> : void</div><div class="description"><div class="short"><p>Removes all listeners for this object including the managed listeners</p>
 229 </div><div class="long"><p>Removes all listeners for this object including the managed listeners</p>
 230 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 231 </li></ul></div></div></div><div id="method-clearManagedListeners" class="member inherited"><a href="Ext.data.Connection.html#method-clearManagedListeners" rel="method-clearManagedListeners" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-clearManagedListeners" class="viewSource">view source</a></div><a name="clearManagedListeners"></a><a name="method-clearManagedListeners"></a><a href="Ext.data.Connection.html#" rel="method-clearManagedListeners" class="cls expand">clearManagedListeners</a> : void</div><div class="description"><div class="short"><p>Removes all managed listeners for this object.</p>
 232 </div><div class="long"><p>Removes all managed listeners for this object.</p>
 233 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 234 </li></ul></div></div></div><div id="method-enableBubble" class="member inherited"><a href="Ext.data.Connection.html#method-enableBubble" rel="method-enableBubble" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-enableBubble" class="viewSource">view source</a></div><a name="enableBubble"></a><a name="method-enableBubble"></a><a href="Ext.data.Connection.html#" rel="method-enableBubble" class="cls expand">enableBubble</a>(
 235 <span class="pre">String/Array events</span>)
 236  : void</div><div class="description"><div class="short">Enables events fired by this Observable to bubble up an owner hierarchy by calling
 237 this.getBubbleTarget() if present....</div><div class="long"><p>Enables events fired by this Observable to bubble up an owner hierarchy by calling
 238 <code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>
 239
 240
 241 <p>This is commonly used by Ext.Components to bubble events to owner Containers. See <a href="Ext.Component.html#getBubbleTarget" rel="Ext.Component#getBubbleTarget" class="docClass">Ext.Component.getBubbleTarget</a>. The default
 242 implementation in <a href="Ext.Component.html" rel="Ext.Component" class="docClass">Ext.Component</a> returns the Component's immediate owner. But if a known target is required, this can be overridden to
 243 access the required target more quickly.</p>
 244
 245
 246 <p>Example:</p>
 247
 248
 249 <pre><code>Ext.override(Ext.form.field.Base, {
 250 //  Add functionality to Field&#39;s initComponent to enable the change event to bubble
 251 initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {
 252     this.enableBubble('change');
 253 }),
 254
 255 //  We know that we want Field&#39;s events to bubble directly to the FormPanel.
 256 getBubbleTarget : function() {
 257     if (!this.formPanel) {
 258         this.formPanel = this.findParentByType('form');
 259     }
 260     return this.formPanel;
 261 }
 262 });
 263
 264 var myForm = new Ext.formPanel({
 265 title: 'User Details',
 266 items: [{
 267     ...
 268 }],
 269 listeners: {
 270     change: function() {
 271         // Title goes red if form has been modified.
 272         myForm.header.setStyle('color', 'red');
 273     }
 274 }
 275 });
 276 </code></pre>
 277
 278 <h3 class="pa">Parameters</h3><ul><li><span class="pre">events</span> : String/Array<div class="sub-desc"><p>The event name to bubble, or an Array of event names.</p>
 279 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 280 </li></ul></div></div></div><div id="method-fireEvent" class="member inherited"><a href="Ext.data.Connection.html#method-fireEvent" rel="method-fireEvent" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-fireEvent" class="viewSource">view source</a></div><a name="fireEvent"></a><a name="method-fireEvent"></a><a href="Ext.data.Connection.html#" rel="method-fireEvent" class="cls expand">fireEvent</a>(
 281 <span class="pre">String eventName, Object... args</span>)
 282  : Boolean</div><div class="description"><div class="short">Fires the specified event with the passed parameters (minus the event name).
 283
 284
 285 An event may be set to bubble up an Ob...</div><div class="long"><p>Fires the specified event with the passed parameters (minus the event name).</p>
 286
 287
 288 <p>An event may be set to bubble up an Observable parent hierarchy (See <a href="Ext.Component.html#getBubbleTarget" rel="Ext.Component#getBubbleTarget" class="docClass">Ext.Component.getBubbleTarget</a>)
 289 by calling <a href="Ext.data.Connection.html#enableBubble" rel="Ext.data.Connection#enableBubble" class="docClass">enableBubble</a>.</p>
 290
 291 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to fire.</p>
 292 </div></li><li><span class="pre">args</span> : Object...<div class="sub-desc"><p>Variable number of parameters are passed to handlers.</p>
 293 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>returns false if any of the handlers return false otherwise it returns true.</p>
 294 </li></ul></div></div></div><div id="method-hasListener" class="member inherited"><a href="Ext.data.Connection.html#method-hasListener" rel="method-hasListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-hasListener" class="viewSource">view source</a></div><a name="hasListener"></a><a name="method-hasListener"></a><a href="Ext.data.Connection.html#" rel="method-hasListener" class="cls expand">hasListener</a>(
 295 <span class="pre">String eventName</span>)
 296  : Boolean</div><div class="description"><div class="short"><p>Checks to see if this object has any listeners for a specified event</p>
 297 </div><div class="long"><p>Checks to see if this object has any listeners for a specified event</p>
 298 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The name of the event to check for</p>
 299 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>True if the event is being listened for, else false</p>
 300 </li></ul></div></div></div><div id="method-isLoading" class="member ni"><a href="Ext.data.Connection.html#method-isLoading" rel="method-isLoading" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Connection.html" class="definedIn docClass">Ext.data.Connection</a><br/><a href="../source/Connection.html#Ext-data.Connection-method-isLoading" class="viewSource">view source</a></div><a name="isLoading"></a><a name="method-isLoading"></a><a href="Ext.data.Connection.html#" rel="method-isLoading" class="cls expand">isLoading</a>(
 301 <span class="pre">Object request</span>)
 302  : Boolean</div><div class="description"><div class="short"><p>Determine whether this object has a request outstanding.</p>
 303 </div><div class="long"><p>Determine whether this object has a request outstanding.</p>
 304 <h3 class="pa">Parameters</h3><ul><li><span class="pre">request</span> : Object<div class="sub-desc"><p>(Optional) defaults to the last transaction</p>
 305 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Boolean</span>&nbsp; &nbsp;<p>True if there is an outstanding request.</p>
 306 </li></ul></div></div></div><div id="method-observe" class="member inherited"><a href="Ext.data.Connection.html#method-observe" rel="method-observe" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-observe" class="viewSource">view source</a></div><a name="observe"></a><a name="method-observe"></a><a href="Ext.data.Connection.html#" rel="method-observe" class="cls expand">observe</a>(
 307 <span class="pre">Function c, Object listeners</span>)
 308  : void</div><div class="description"><div class="short">Sets observability on the passed class constructor.
 309
 310 This makes any event fired on any instance of the passed class a...</div><div class="long"><p>Sets observability on the passed class constructor.</p>
 311
 312 <p>This makes any event fired on any instance of the passed class also fire a single event through
 313 the <strong>class</strong> allowing for central handling of events on many instances at once.</p>
 314
 315 <p>Usage:</p>
 316
 317 <pre><code>Ext.util.Observable.observe(Ext.data.Connection);
 318 Ext.data.Connection.on('beforerequest', function(con, options) {
 319     console.log('Ajax request made to ' + options.url);
 320 });
 321 </code></pre>
 322 <h3 class="pa">Parameters</h3><ul><li><span class="pre">c</span> : Function<div class="sub-desc"><p>The class constructor to make observable.</p>
 323 </div></li><li><span class="pre">listeners</span> : Object<div class="sub-desc"><p>An object containing a series of listeners to add. See <a href="Ext.data.Connection.html#addListener" rel="Ext.data.Connection#addListener" class="docClass">addListener</a>.</p>
 324 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 325 </li></ul></div></div></div><div id="method-on" class="member inherited"><a href="Ext.data.Connection.html#method-on" rel="method-on" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-on" class="viewSource">view source</a></div><a name="on"></a><a name="method-on"></a><a href="Ext.data.Connection.html#" rel="method-on" class="cls expand">on</a>(
 326 <span class="pre">String eventName, Function handler, [Object scope], [Object options]</span>)
 327  : void</div><div class="description"><div class="short"><p>Appends an event handler to this object (shorthand for <a href="Ext.data.Connection.html#addListener" rel="Ext.data.Connection#addListener" class="docClass">addListener</a>.)</p>
 328 </div><div class="long"><p>Appends an event handler to this object (shorthand for <a href="Ext.data.Connection.html#addListener" rel="Ext.data.Connection#addListener" class="docClass">addListener</a>.)</p>
 329 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event to listen for</p>
 330 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The method the event invokes</p>
 331 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.
 332 <b>If omitted, defaults to the object which fired the event.</b></p>
 333 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>(optional) An object containing handler configuration.</p>
 334 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 335 </li></ul></div></div></div><div id="method-parseStatus" class="member ni"><a href="Ext.data.Connection.html#method-parseStatus" rel="method-parseStatus" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Connection.html" class="definedIn docClass">Ext.data.Connection</a><br/><a href="../source/Connection.html#Ext-data.Connection-method-parseStatus" class="viewSource">view source</a></div><a name="parseStatus"></a><a name="method-parseStatus"></a><a href="Ext.data.Connection.html#" rel="method-parseStatus" class="cls expand">parseStatus</a>(
 336 <span class="pre">Number status</span>)
 337  : Object</div><div class="description"><div class="short"><p>Check if the response status was successful</p>
 338 </div><div class="long"><p>Check if the response status was successful</p>
 339 <h3 class="pa">Parameters</h3><ul><li><span class="pre">status</span> : Number<div class="sub-desc"><p>The status code</p>
 340 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Object</span>&nbsp; &nbsp;<p>An object containing success/status state</p>
 341 </li></ul></div></div></div><div id="method-relayEvents" class="member inherited"><a href="Ext.data.Connection.html#method-relayEvents" rel="method-relayEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-relayEvents" class="viewSource">view source</a></div><a name="relayEvents"></a><a name="method-relayEvents"></a><a href="Ext.data.Connection.html#" rel="method-relayEvents" class="cls expand">relayEvents</a>(
 342 <span class="pre">Object origin, Array events, Object prefix</span>)
 343  : void</div><div class="description"><div class="short"><p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>
 344 </div><div class="long"><p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>
 345 <h3 class="pa">Parameters</h3><ul><li><span class="pre">origin</span> : Object<div class="sub-desc"><p>The Observable whose events this object is to relay.</p>
 346 </div></li><li><span class="pre">events</span> : Array<div class="sub-desc"><p>Array of event names to relay.</p>
 347 </div></li><li><span class="pre">prefix</span> : Object<div class="sub-desc">
 348 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 349 </li></ul></div></div></div><div id="method-releaseCapture" class="member inherited"><a href="Ext.data.Connection.html#method-releaseCapture" rel="method-releaseCapture" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-releaseCapture" class="viewSource">view source</a></div><a name="releaseCapture"></a><a name="method-releaseCapture"></a><a href="Ext.data.Connection.html#" rel="method-releaseCapture" class="cls expand">releaseCapture</a>(
 350 <span class="pre">Observable o</span>)
 351  : void</div><div class="description"><div class="short"><p>Removes <b>all</b> added captures from the Observable.</p>
 352 </div><div class="long"><p>Removes <b>all</b> added captures from the Observable.</p>
 353 <h3 class="pa">Parameters</h3><ul><li><span class="pre">o</span> : Observable<div class="sub-desc"><p>The Observable to release</p>
 354 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 355 </li></ul></div></div></div><div id="method-removeListener" class="member inherited"><a href="Ext.data.Connection.html#method-removeListener" rel="method-removeListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-removeListener" class="viewSource">view source</a></div><a name="removeListener"></a><a name="method-removeListener"></a><a href="Ext.data.Connection.html#" rel="method-removeListener" class="cls expand">removeListener</a>(
 356 <span class="pre">String eventName, Function handler, [Object scope]</span>)
 357  : void</div><div class="description"><div class="short"><p>Removes an event handler.</p>
 358 </div><div class="long"><p>Removes an event handler.</p>
 359 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event the handler was associated with.</p>
 360 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The handler to remove. <b>This must be a reference to the function passed into the <a href="Ext.data.Connection.html#addListener" rel="Ext.data.Connection#addListener" class="docClass">addListener</a> call.</b></p>
 361 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
 362 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 363 </li></ul></div></div></div><div id="method-removeManagedListener" class="member inherited"><a href="Ext.data.Connection.html#method-removeManagedListener" rel="method-removeManagedListener" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-removeManagedListener" class="viewSource">view source</a></div><a name="removeManagedListener"></a><a name="method-removeManagedListener"></a><a href="Ext.data.Connection.html#" rel="method-removeManagedListener" class="cls expand">removeManagedListener</a>(
 364 <span class="pre">Observable|Element item, Object|String ename, Function fn, Object scope</span>)
 365  : void</div><div class="description"><div class="short"><p>Removes listeners that were added by the <a href="Ext.data.Connection.html#mon" rel="Ext.data.Connection#mon" class="docClass">mon</a> method.</p>
 366 </div><div class="long"><p>Removes listeners that were added by the <a href="Ext.data.Connection.html#mon" rel="Ext.data.Connection#mon" class="docClass">mon</a> method.</p>
 367 <h3 class="pa">Parameters</h3><ul><li><span class="pre">item</span> : Observable|Element<div class="sub-desc"><p>The item from which to remove a listener/listeners.</p>
 368 </div></li><li><span class="pre">ename</span> : Object|String<div class="sub-desc"><p>The event name, or an object containing event name properties.</p>
 369 </div></li><li><span class="pre">fn</span> : Function<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
 370 is the handler function.</p>
 371 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>Optional. If the <code>ename</code> parameter was an event name, this
 372 is the scope (<code>this</code> reference) in which the handler function is executed.</p>
 373 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 374 </li></ul></div></div></div><div id="method-request" class="member ni"><a href="Ext.data.Connection.html#method-request" rel="method-request" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Connection.html" class="definedIn docClass">Ext.data.Connection</a><br/><a href="../source/Connection.html#Ext-data.Connection-method-request" class="viewSource">view source</a></div><a name="request"></a><a name="method-request"></a><a href="Ext.data.Connection.html#" rel="method-request" class="cls expand">request</a>(
 375 <span class="pre">Object options</span>)
 376  : Object</div><div class="description"><div class="short">Sends an HTTP request to a remote server.
 377
 378
 379 Important: Ajax server requests are asynchronous, and this call will
 380 retu...</div><div class="long"><p>Sends an HTTP request to a remote server.</p>
 381
 382
 383 <p><b>Important:</b> Ajax server requests are asynchronous, and this call will
 384 return before the response has been received. Process any returned data
 385 in a callback function.</p>
 386
 387
 388 <pre><code>Ext.Ajax.request({
 389 url: 'ajax_demo/sample.json',
 390 success: function(response, opts) {
 391   var obj = Ext.decode(response.responseText);
 392   console.dir(obj);
 393 },
 394 failure: function(response, opts) {
 395   console.log('server-side failure with status code ' + response.status);
 396 }
 397 });
 398 </code></pre>
 399
 400
 401 <p>To execute a callback function in the correct scope, use the <tt>scope</tt> option.</p>
 402
 403 <h3 class="pa">Parameters</h3><ul><li><span class="pre">options</span> : Object<div class="sub-desc"><p>An object which may contain the following properties:<ul>
 404 <li><b>url</b> : String/Function (Optional)<div class="sub-desc">The URL to
 405 which to send the request, or a function to call which returns a URL string. The scope of the
 406 function is specified by the <tt>scope</tt> option. Defaults to the configured
 407 <tt><a href="Ext.data.Connection.html#url" rel="Ext.data.Connection#url" class="docClass">url</a></tt>.</div></li>
 408 <li><b>params</b> : Object/String/Function (Optional)<div class="sub-desc">
 409 An object containing properties which are used as parameters to the
 410 request, a url encoded string or a function to call to get either. The scope of the function
 411 is specified by the <tt>scope</tt> option.</div></li>
 412 <li><b>method</b> : String (Optional)<div class="sub-desc">The HTTP method to use
 413 for the request. Defaults to the configured method, or if no method was configured,
 414 "GET" if no parameters are being sent, and "POST" if parameters are being sent.  Note that
 415 the method name is case-sensitive and should be all caps.</div></li>
 416 <li><b>callback</b> : Function (Optional)<div class="sub-desc">The
 417 function to be called upon receipt of the HTTP response. The callback is
 418 called regardless of success or failure and is passed the following
 419 parameters:<ul>
 420 <li><b>options</b> : Object<div class="sub-desc">The parameter to the request call.</div></li>
 421 <li><b>success</b> : Boolean<div class="sub-desc">True if the request succeeded.</div></li>
 422 <li><b>response</b> : Object<div class="sub-desc">The XMLHttpRequest object containing the response data.
 423 See <a href="http://www.w3.org/TR/XMLHttpRequest/">http://www.w3.org/TR/XMLHttpRequest/</a> for details about
 424 accessing elements of the response.</div></li>
 425 </ul></div></li>
 426 <li><a id="request-option-success"></a><b>success</b> : Function (Optional)<div class="sub-desc">The function
 427 to be called upon success of the request. The callback is passed the following
 428 parameters:<ul>
 429 <li><b>response</b> : Object<div class="sub-desc">The XMLHttpRequest object containing the response data.</div></li>
 430 <li><b>options</b> : Object<div class="sub-desc">The parameter to the request call.</div></li>
 431 </ul></div></li>
 432 <li><b>failure</b> : Function (Optional)<div class="sub-desc">The function
 433 to be called upon failure of the request. The callback is passed the
 434 following parameters:<ul>
 435 <li><b>response</b> : Object<div class="sub-desc">The XMLHttpRequest object containing the response data.</div></li>
 436 <li><b>options</b> : Object<div class="sub-desc">The parameter to the request call.</div></li>
 437 </ul></div></li>
 438 <li><b>scope</b> : Object (Optional)<div class="sub-desc">The scope in
 439 which to execute the callbacks: The "this" object for the callback function. If the <tt>url</tt>, or <tt>params</tt> options were
 440 specified as functions from which to draw values, then this also serves as the scope for those function calls.
 441 Defaults to the browser window.</div></li>
 442 <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>
 443 <li><b>form</b> : Element/HTMLElement/String (Optional)<div class="sub-desc">The <tt>&lt;form&gt;</tt>
 444 Element or the id of the <tt>&lt;form&gt;</tt> to pull parameters from.</div></li>
 445 <li><a id="request-option-isUpload"></a><b>isUpload</b> : Boolean (Optional)<div class="sub-desc"><b>Only meaningful when used
 446 with the <tt>form</tt> option</b>.</p>
 447
 448 <p>True if the form object is a file upload (will be set automatically if the form was
 449 configured with <b><tt>enctype</tt></b> "multipart/form-data").</p>
 450
 451
 452 <p>File uploads are not performed using normal "Ajax" techniques, that is they are <b>not</b>
 453 performed using XMLHttpRequests. Instead the form is submitted in the standard manner with the
 454 DOM <tt>&lt;form></tt> element temporarily modified to have its
 455 <a href="http://www.w3.org/TR/REC-html40/present/frames.html#adef-target">target</a> set to refer
 456 to a dynamically generated, hidden <tt>&lt;iframe></tt> which is inserted into the document
 457 but removed after the return data has been gathered.</p>
 458
 459
 460 <p>The server response is parsed by the browser to create the document for the IFRAME. If the
 461 server is using JSON to send the return object, then the
 462 <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17">Content-Type</a> header
 463 must be set to "text/html" in order to tell the browser to insert the text unchanged into the document body.</p>
 464
 465
 466 <p>The response text is retrieved from the document, and a fake XMLHttpRequest object
 467 is created containing a <tt>responseText</tt> property in order to conform to the
 468 requirements of event handlers and callbacks.</p>
 469
 470
 471 <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>
 472 and some server technologies (notably JEE) may require some custom processing in order to
 473 retrieve parameter names and parameter values from the packet content.</p>
 474
 475
 476 <p></div></li>
 477 <li><b>headers</b> : Object (Optional)<div class="sub-desc">Request
 478 headers to set for the request.</div></li>
 479 <li><b>xmlData</b> : Object (Optional)<div class="sub-desc">XML document
 480 to use for the post. Note: This will be used instead of params for the post
 481 data. Any params will be appended to the URL.</div></li>
 482 <li><b>jsonData</b> : Object/String (Optional)<div class="sub-desc">JSON
 483 data to use as the post. Note: This will be used instead of params for the post
 484 data. Any params will be appended to the URL.</div></li>
 485 <li><b>disableCaching</b> : Boolean (Optional)<div class="sub-desc">True
 486 to add a unique cache-buster param to GET requests.</div></li>
 487 </ul></p></p>
 488
 489 <p>The options object may also contain any other property which might be needed to perform
 490 postprocessing in a callback because it is passed to callback functions.</p>
 491
 492 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Object</span>&nbsp; &nbsp;<p>request The request object. This may be used
 493 to cancel the request.</p>
 494 </li></ul></div></div></div><div id="method-resumeEvents" class="member inherited"><a href="Ext.data.Connection.html#method-resumeEvents" rel="method-resumeEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-resumeEvents" class="viewSource">view source</a></div><a name="resumeEvents"></a><a name="method-resumeEvents"></a><a href="Ext.data.Connection.html#" rel="method-resumeEvents" class="cls expand">resumeEvents</a> : void</div><div class="description"><div class="short">Resume firing events. (see suspendEvents)
 495 If events were suspended using the queueSuspended parameter, then all
 496 event...</div><div class="long"><p>Resume firing events. (see <a href="Ext.data.Connection.html#suspendEvents" rel="Ext.data.Connection#suspendEvents" class="docClass">suspendEvents</a>)
 497 If events were suspended using the <code><b>queueSuspended</b></code> parameter, then all
 498 events fired during event suspension will be sent to any listeners now.</p>
 499 <h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 500 </li></ul></div></div></div><div id="method-setOptions" class="member ni"><a href="Ext.data.Connection.html#method-setOptions" rel="method-setOptions" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Connection.html" class="definedIn docClass">Ext.data.Connection</a><br/><a href="../source/Connection.html#Ext-data.Connection-method-setOptions" class="viewSource">view source</a></div><a name="setOptions"></a><a name="method-setOptions"></a><a href="Ext.data.Connection.html#" rel="method-setOptions" class="cls expand">setOptions</a>(
 501 <span class="pre">Object options, Object scope</span>)
 502  : Object</div><div class="description"><div class="short"><p>Set various options such as the url, params for the request</p>
 503 </div><div class="long"><p>Set various options such as the url, params for the request</p>
 504 <h3 class="pa">Parameters</h3><ul><li><span class="pre">options</span> : Object<div class="sub-desc"><p>The initial options</p>
 505 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>The scope to execute in</p>
 506 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">Object</span>&nbsp; &nbsp;<p>The params for the request</p>
 507 </li></ul></div></div></div><div id="method-suspendEvents" class="member inherited"><a href="Ext.data.Connection.html#method-suspendEvents" rel="method-suspendEvents" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-suspendEvents" class="viewSource">view source</a></div><a name="suspendEvents"></a><a name="method-suspendEvents"></a><a href="Ext.data.Connection.html#" rel="method-suspendEvents" class="cls expand">suspendEvents</a>(
 508 <span class="pre">Boolean queueSuspended</span>)
 509  : void</div><div class="description"><div class="short"><p>Suspend the firing of all events. (see <a href="Ext.data.Connection.html#resumeEvents" rel="Ext.data.Connection#resumeEvents" class="docClass">resumeEvents</a>)</p>
 510 </div><div class="long"><p>Suspend the firing of all events. (see <a href="Ext.data.Connection.html#resumeEvents" rel="Ext.data.Connection#resumeEvents" class="docClass">resumeEvents</a>)</p>
 511 <h3 class="pa">Parameters</h3><ul><li><span class="pre">queueSuspended</span> : Boolean<div class="sub-desc"><p>Pass as true to queue up suspended events to be fired
 512 after the <a href="Ext.data.Connection.html#resumeEvents" rel="Ext.data.Connection#resumeEvents" class="docClass">resumeEvents</a> call instead of discarding all suspended events;</p>
 513 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 514 </li></ul></div></div></div><div id="method-un" class="member inherited"><a href="Ext.data.Connection.html#method-un" rel="method-un" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.util.Observable.html" class="definedIn docClass">Ext.util.Observable</a><br/><a href="../source/Observable.html#Ext-util.Observable-method-un" class="viewSource">view source</a></div><a name="un"></a><a name="method-un"></a><a href="Ext.data.Connection.html#" rel="method-un" class="cls expand">un</a>(
 515 <span class="pre">String eventName, Function handler, [Object scope]</span>)
 516  : void</div><div class="description"><div class="short"><p>Removes an event handler (shorthand for <a href="Ext.data.Connection.html#removeListener" rel="Ext.data.Connection#removeListener" class="docClass">removeListener</a>.)</p>
 517 </div><div class="long"><p>Removes an event handler (shorthand for <a href="Ext.data.Connection.html#removeListener" rel="Ext.data.Connection#removeListener" class="docClass">removeListener</a>.)</p>
 518 <h3 class="pa">Parameters</h3><ul><li><span class="pre">eventName</span> : String<div class="sub-desc"><p>The type of event the handler was associated with.</p>
 519 </div></li><li><span class="pre">handler</span> : Function<div class="sub-desc"><p>The handler to remove. <b>This must be a reference to the function passed into the <a href="Ext.data.Connection.html#addListener" rel="Ext.data.Connection#addListener" class="docClass">addListener</a> call.</b></p>
 520 </div></li><li><span class="pre">scope</span> : Object<div class="sub-desc"><p>(optional) The scope originally specified for the handler.</p>
 521 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 522 </li></ul></div></div></div><div id="method-upload" class="member ni"><a href="Ext.data.Connection.html#method-upload" rel="method-upload" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Connection.html" class="definedIn docClass">Ext.data.Connection</a><br/><a href="../source/Connection.html#Ext-data.Connection-method-upload" class="viewSource">view source</a></div><a name="upload"></a><a name="method-upload"></a><a href="Ext.data.Connection.html#" rel="method-upload" class="cls expand">upload</a>(
 523 <span class="pre">Mixed form, String url, String params, Object options</span>)
 524  : void</div><div class="description"><div class="short"><p>Upload a form using a hidden iframe.</p>
 525 </div><div class="long"><p>Upload a form using a hidden iframe.</p>
 526 <h3 class="pa">Parameters</h3><ul><li><span class="pre">form</span> : Mixed<div class="sub-desc"><p>The form to upload</p>
 527 </div></li><li><span class="pre">url</span> : String<div class="sub-desc"><p>The url to post to</p>
 528 </div></li><li><span class="pre">params</span> : String<div class="sub-desc"><p>Any extra parameters to pass</p>
 529 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>The initial options</p>
 530 </div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
 531 </li></ul></div></div></div></div><div class="m-events"><a name="events"></a><div class="definedBy">Defined By</div><h3 class="evt p">Events</h3><div id="event-beforerequest" class="member f ni"><a href="Ext.data.Connection.html#event-beforerequest" rel="event-beforerequest" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Connection.html" class="definedIn docClass">Ext.data.Connection</a><br/><a href="../source/Connection.html#Ext-data.Connection-event-beforerequest" class="viewSource">view source</a></div><a name="beforerequest"></a><a name="event-beforerequest"></a><a href="Ext.data.Connection.html#" rel="event-beforerequest" class="cls expand">beforerequest</a>(
 532 <span class="pre">Connection conn, Object options</span>)
 533 </div><div class="description"><div class="short"><p>Fires before a network request is made to retrieve a data object.</p>
 534 </div><div class="long"><p>Fires before a network request is made to retrieve a data object.</p>
 535 <h3 class="pa">Parameters</h3><ul><li><span class="pre">conn</span> : Connection<div class="sub-desc"><p>This Connection object.</p>
 536 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>The options config object passed to the <a href="Ext.data.Connection.html#request" rel="Ext.data.Connection#request" class="docClass">request</a> method.</p>
 537 </div></li></ul></div></div></div><div id="event-requestcomplete" class="member ni"><a href="Ext.data.Connection.html#event-requestcomplete" rel="event-requestcomplete" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Connection.html" class="definedIn docClass">Ext.data.Connection</a><br/><a href="../source/Connection.html#Ext-data.Connection-event-requestcomplete" class="viewSource">view source</a></div><a name="requestcomplete"></a><a name="event-requestcomplete"></a><a href="Ext.data.Connection.html#" rel="event-requestcomplete" class="cls expand">requestcomplete</a>(
 538 <span class="pre">Connection conn, Object response, Object options</span>)
 539 </div><div class="description"><div class="short"><p>Fires if the request was successfully completed.</p>
 540 </div><div class="long"><p>Fires if the request was successfully completed.</p>
 541 <h3 class="pa">Parameters</h3><ul><li><span class="pre">conn</span> : Connection<div class="sub-desc"><p>This Connection object.</p>
 542 </div></li><li><span class="pre">response</span> : Object<div class="sub-desc"><p>The XHR object containing the response data.
 543 See <a href="http://www.w3.org/TR/XMLHttpRequest/">The XMLHttpRequest Object</a>
 544 for details.</p>
 545 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>The options config object passed to the <a href="Ext.data.Connection.html#request" rel="Ext.data.Connection#request" class="docClass">request</a> method.</p>
 546 </div></li></ul></div></div></div><div id="event-requestexception" class="member ni"><a href="Ext.data.Connection.html#event-requestexception" rel="event-requestexception" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.data.Connection.html" class="definedIn docClass">Ext.data.Connection</a><br/><a href="../source/Connection.html#Ext-data.Connection-event-requestexception" class="viewSource">view source</a></div><a name="requestexception"></a><a name="event-requestexception"></a><a href="Ext.data.Connection.html#" rel="event-requestexception" class="cls expand">requestexception</a>(
 547 <span class="pre">Connection conn, Object response, Object options</span>)
 548 </div><div class="description"><div class="short">Fires if an error HTTP status was returned from the server.
 549 See HTTP Status Code Definitions
 550 for details of HTTP stat...</div><div class="long"><p>Fires if an error HTTP status was returned from the server.
 551 See <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html">HTTP Status Code Definitions</a>
 552 for details of HTTP status codes.</p>
 553 <h3 class="pa">Parameters</h3><ul><li><span class="pre">conn</span> : Connection<div class="sub-desc"><p>This Connection object.</p>
 554 </div></li><li><span class="pre">response</span> : Object<div class="sub-desc"><p>The XHR object containing the response data.
 555 See <a href="http://www.w3.org/TR/XMLHttpRequest/">The XMLHttpRequest Object</a>
 556 for details.</p>
 557 </div></li><li><span class="pre">options</span> : Object<div class="sub-desc"><p>The options config object passed to the <a href="Ext.data.Connection.html#request" rel="Ext.data.Connection#request" class="docClass">request</a> method.</p>
 558 </div></li></ul></div></div></div></div></div></div></div><div id="pageContent"></div></div></div></div></body></html>