docs/source/Connection.html

   1 <html>\r
   2 <head>\r
   3   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />    \r
   4   <title>The source code</title>\r
   5     <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />\r
   6     <script type="text/javascript" src="../resources/prettify/prettify.js"></script>\r
   7 </head>\r
   8 <body  onload="prettyPrint();">\r
   9     <pre class="prettyprint lang-js">(function(){\r
  10     var BEFOREREQUEST = "beforerequest",\r
  11         REQUESTCOMPLETE = "requestcomplete",\r
  12         REQUESTEXCEPTION = "requestexception",\r
  13         UNDEFINED = undefined,\r
  14         LOAD = 'load',\r
  15         POST = 'POST',\r
  16         GET = 'GET',\r
  17         WINDOW = window;\r
  18     \r
  19     <div id="cls-Ext.data.Connection"></div>/**\r
  20      * @class Ext.data.Connection\r
  21      * @extends Ext.util.Observable\r
  22      * <p>The class encapsulates a connection to the page's originating domain, allowing requests to be made\r
  23      * either to a configured URL, or to a URL specified at request time.</p>\r
  24      * <p>Requests made by this class are asynchronous, and will return immediately. No data from\r
  25      * the server will be available to the statement immediately following the {@link #request} call.\r
  26      * To process returned data, use a\r
  27      * <a href="#request-option-success" ext:member="request-option-success" ext:cls="Ext.data.Connection">success callback</a>\r
  28      * in the request options object,\r
  29      * or an {@link #requestcomplete event listener}.</p>\r
  30      * <p><h3>File Uploads</h3><a href="#request-option-isUpload" ext:member="request-option-isUpload" ext:cls="Ext.data.Connection">File uploads</a> are not performed using normal "Ajax" techniques, that\r
  31      * is they are <b>not</b> performed using XMLHttpRequests. Instead the form is submitted in the standard\r
  32      * manner with the DOM <tt>&lt;form></tt> element temporarily modified to have its\r
  33      * <a href="http://www.w3.org/TR/REC-html40/present/frames.html#adef-target">target</a> set to refer\r
  34      * to a dynamically generated, hidden <tt>&lt;iframe></tt> which is inserted into the document\r
  35      * but removed after the return data has been gathered.</p>\r
  36      * <p>The server response is parsed by the browser to create the document for the IFRAME. If the\r
  37      * server is using JSON to send the return object, then the\r
  38      * <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17">Content-Type</a> header\r
  39      * must be set to "text/html" in order to tell the browser to insert the text unchanged into the document body.</p>\r
  40      * <p>Characters which are significant to an HTML parser must be sent as HTML entities, so encode\r
  41      * "&lt;" as "&amp;lt;", "&amp;" as "&amp;amp;" etc.</p>\r
  42      * <p>The response text is retrieved from the document, and a fake XMLHttpRequest object\r
  43      * is created containing a <tt>responseText</tt> property in order to conform to the\r
  44      * requirements of event handlers and callbacks.</p>\r
  45      * <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
  46      * and some server technologies (notably JEE) may require some custom processing in order to\r
  47      * retrieve parameter names and parameter values from the packet content.</p>\r
  48      * @constructor\r
  49      * @param {Object} config a configuration object.\r
  50      */\r
  51     Ext.data.Connection = function(config){    \r
  52         Ext.apply(this, config);\r
  53         this.addEvents(\r
  54             <div id="event-Ext.data.Connection-beforerequest"></div>/**\r
  55              * @event beforerequest\r
  56              * Fires before a network request is made to retrieve a data object.\r
  57              * @param {Connection} conn This Connection object.\r
  58              * @param {Object} options The options config object passed to the {@link #request} method.\r
  59              */\r
  60             BEFOREREQUEST,\r
  61             <div id="event-Ext.data.Connection-requestcomplete"></div>/**\r
  62              * @event requestcomplete\r
  63              * Fires if the request was successfully completed.\r
  64              * @param {Connection} conn This Connection object.\r
  65              * @param {Object} response The XHR object containing the response data.\r
  66              * See <a href="http://www.w3.org/TR/XMLHttpRequest/">The XMLHttpRequest Object</a>\r
  67              * for details.\r
  68              * @param {Object} options The options config object passed to the {@link #request} method.\r
  69              */\r
  70             REQUESTCOMPLETE,\r
  71             <div id="event-Ext.data.Connection-requestexception"></div>/**\r
  72              * @event requestexception\r
  73              * Fires if an error HTTP status was returned from the server.\r
  74              * See <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html">HTTP Status Code Definitions</a>\r
  75              * for details of HTTP status codes.\r
  76              * @param {Connection} conn This Connection object.\r
  77              * @param {Object} response The XHR object containing the response data.\r
  78              * See <a href="http://www.w3.org/TR/XMLHttpRequest/">The XMLHttpRequest Object</a>\r
  79              * for details.\r
  80              * @param {Object} options The options config object passed to the {@link #request} method.\r
  81              */\r
  82             REQUESTEXCEPTION\r
  83         );\r
  84         Ext.data.Connection.superclass.constructor.call(this);\r
  85     };\r
  86 \r
  87     Ext.extend(Ext.data.Connection, Ext.util.Observable, {\r
  88         <div id="cfg-Ext.data.Connection-url"></div>/**\r
  89          * @cfg {String} url (Optional) <p>The default URL to be used for requests to the server. Defaults to undefined.</p>\r
  90          * <p>The <code>url</code> config may be a function which <i>returns</i> the URL to use for the Ajax request. The scope\r
  91          * (<code><b>this</b></code> reference) of the function is the <code>scope</code> option passed to the {@link #request} method.</p>\r
  92          */\r
  93         <div id="cfg-Ext.data.Connection-extraParams"></div>/**\r
  94          * @cfg {Object} extraParams (Optional) An object containing properties which are used as\r
  95          * extra parameters to each request made by this object. (defaults to undefined)\r
  96          */\r
  97         <div id="cfg-Ext.data.Connection-defaultHeaders"></div>/**\r
  98          * @cfg {Object} defaultHeaders (Optional) An object containing request headers which are added\r
  99          *  to each request made by this object. (defaults to undefined)\r
 100          */\r
 101         <div id="cfg-Ext.data.Connection-method"></div>/**\r
 102          * @cfg {String} method (Optional) The default HTTP method to be used for requests.\r
 103          * (defaults to undefined; if not set, but {@link #request} params are present, POST will be used;\r
 104          * otherwise, GET will be used.)\r
 105          */\r
 106         <div id="cfg-Ext.data.Connection-timeout"></div>/**\r
 107          * @cfg {Number} timeout (Optional) The timeout in milliseconds to be used for requests. (defaults to 30000)\r
 108          */\r
 109         timeout : 30000,\r
 110         <div id="cfg-Ext.data.Connection-autoAbort"></div>/**\r
 111          * @cfg {Boolean} autoAbort (Optional) Whether this request should abort any pending requests. (defaults to false)\r
 112          * @type Boolean\r
 113          */\r
 114         autoAbort:false,\r
 115     \r
 116         <div id="cfg-Ext.data.Connection-disableCaching"></div>/**\r
 117          * @cfg {Boolean} disableCaching (Optional) True to add a unique cache-buster param to GET requests. (defaults to true)\r
 118          * @type Boolean\r
 119          */\r
 120         disableCaching: true,\r
 121         \r
 122         <div id="cfg-Ext.data.Connection-disableCachingParam"></div>/**\r
 123          * @cfg {String} disableCachingParam (Optional) Change the parameter which is sent went disabling caching\r
 124          * through a cache buster. Defaults to '_dc'\r
 125          * @type String\r
 126          */\r
 127         disableCachingParam: '_dc',\r
 128         \r
 129         <div id="method-Ext.data.Connection-request"></div>/**\r
 130          * <p>Sends an HTTP request to a remote server.</p>\r
 131          * <p><b>Important:</b> Ajax server requests are asynchronous, and this call will\r
 132          * return before the response has been received. Process any returned data\r
 133          * in a callback function.</p>\r
 134          * <pre><code>\r
 135 Ext.Ajax.request({\r
 136    url: 'ajax_demo/sample.json',\r
 137    success: function(response, opts) {\r
 138       var obj = Ext.decode(response.responseText);\r
 139       console.dir(obj);\r
 140    },\r
 141    failure: function(response, opts) {\r
 142       console.log('server-side failure with status code ' + response.status);\r
 143    }\r
 144 });\r
 145          * </code></pre>\r
 146          * <p>To execute a callback function in the correct scope, use the <tt>scope</tt> option.</p>\r
 147          * @param {Object} options An object which may contain the following properties:<ul>\r
 148          * <li><b>url</b> : String/Function (Optional)<div class="sub-desc">The URL to\r
 149          * which to send the request, or a function to call which returns a URL string. The scope of the\r
 150          * function is specified by the <tt>scope</tt> option. Defaults to the configured\r
 151          * <tt>{@link #url}</tt>.</div></li>\r
 152          * <li><b>params</b> : Object/String/Function (Optional)<div class="sub-desc">\r
 153          * An object containing properties which are used as parameters to the\r
 154          * request, a url encoded string or a function to call to get either. The scope of the function\r
 155          * is specified by the <tt>scope</tt> option.</div></li>\r
 156          * <li><b>method</b> : String (Optional)<div class="sub-desc">The HTTP method to use\r
 157          * for the request. Defaults to the configured method, or if no method was configured,\r
 158          * "GET" if no parameters are being sent, and "POST" if parameters are being sent.  Note that\r
 159          * the method name is case-sensitive and should be all caps.</div></li>\r
 160          * <li><b>callback</b> : Function (Optional)<div class="sub-desc">The\r
 161          * function to be called upon receipt of the HTTP response. The callback is\r
 162          * called regardless of success or failure and is passed the following\r
 163          * parameters:<ul>\r
 164          * <li><b>options</b> : Object<div class="sub-desc">The parameter to the request call.</div></li>\r
 165          * <li><b>success</b> : Boolean<div class="sub-desc">True if the request succeeded.</div></li>\r
 166          * <li><b>response</b> : Object<div class="sub-desc">The XMLHttpRequest object containing the response data. \r
 167          * See <a href="http://www.w3.org/TR/XMLHttpRequest/">http://www.w3.org/TR/XMLHttpRequest/</a> for details about \r
 168          * accessing elements of the response.</div></li>\r
 169          * </ul></div></li>\r
 170          * <li><a id="request-option-success"></a><b>success</b> : Function (Optional)<div class="sub-desc">The function\r
 171          * to be called upon success of the request. The callback is passed the following\r
 172          * parameters:<ul>\r
 173          * <li><b>response</b> : Object<div class="sub-desc">The XMLHttpRequest object containing the response data.</div></li>\r
 174          * <li><b>options</b> : Object<div class="sub-desc">The parameter to the request call.</div></li>\r
 175          * </ul></div></li>\r
 176          * <li><b>failure</b> : Function (Optional)<div class="sub-desc">The function\r
 177          * to be called upon failure of the request. The callback is passed the\r
 178          * following parameters:<ul>\r
 179          * <li><b>response</b> : Object<div class="sub-desc">The XMLHttpRequest object containing the response data.</div></li>\r
 180          * <li><b>options</b> : Object<div class="sub-desc">The parameter to the request call.</div></li>\r
 181          * </ul></div></li>\r
 182          * <li><b>scope</b> : Object (Optional)<div class="sub-desc">The scope in\r
 183          * which to execute the callbacks: The "this" object for the callback function. If the <tt>url</tt>, or <tt>params</tt> options were\r
 184          * specified as functions from which to draw values, then this also serves as the scope for those function calls.\r
 185          * Defaults to the browser window.</div></li>\r
 186          * <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
 187          * <li><b>form</b> : Element/HTMLElement/String (Optional)<div class="sub-desc">The <tt>&lt;form&gt;</tt>\r
 188          * Element or the id of the <tt>&lt;form&gt;</tt> to pull parameters from.</div></li>\r
 189          * <li><a id="request-option-isUpload"></a><b>isUpload</b> : Boolean (Optional)<div class="sub-desc"><b>Only meaningful when used \r
 190          * with the <tt>form</tt> option</b>.\r
 191          * <p>True if the form object is a file upload (will be set automatically if the form was\r
 192          * configured with <b><tt>enctype</tt></b> "multipart/form-data").</p>\r
 193          * <p>File uploads are not performed using normal "Ajax" techniques, that is they are <b>not</b>\r
 194          * performed using XMLHttpRequests. Instead the form is submitted in the standard manner with the\r
 195          * DOM <tt>&lt;form></tt> element temporarily modified to have its\r
 196          * <a href="http://www.w3.org/TR/REC-html40/present/frames.html#adef-target">target</a> set to refer\r
 197          * to a dynamically generated, hidden <tt>&lt;iframe></tt> which is inserted into the document\r
 198          * but removed after the return data has been gathered.</p>\r
 199          * <p>The server response is parsed by the browser to create the document for the IFRAME. If the\r
 200          * server is using JSON to send the return object, then the\r
 201          * <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17">Content-Type</a> header\r
 202          * must be set to "text/html" in order to tell the browser to insert the text unchanged into the document body.</p>\r
 203          * <p>The response text is retrieved from the document, and a fake XMLHttpRequest object\r
 204          * is created containing a <tt>responseText</tt> property in order to conform to the\r
 205          * requirements of event handlers and callbacks.</p>\r
 206          * <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
 207          * and some server technologies (notably JEE) may require some custom processing in order to\r
 208          * retrieve parameter names and parameter values from the packet content.</p>\r
 209          * </div></li>\r
 210          * <li><b>headers</b> : Object (Optional)<div class="sub-desc">Request\r
 211          * headers to set for the request.</div></li>\r
 212          * <li><b>xmlData</b> : Object (Optional)<div class="sub-desc">XML document\r
 213          * to use for the post. Note: This will be used instead of params for the post\r
 214          * data. Any params will be appended to the URL.</div></li>\r
 215          * <li><b>jsonData</b> : Object/String (Optional)<div class="sub-desc">JSON\r
 216          * data to use as the post. Note: This will be used instead of params for the post\r
 217          * data. Any params will be appended to the URL.</div></li>\r
 218          * <li><b>disableCaching</b> : Boolean (Optional)<div class="sub-desc">True\r
 219          * to add a unique cache-buster param to GET requests.</div></li>\r
 220          * </ul></p>\r
 221          * <p>The options object may also contain any other property which might be needed to perform\r
 222          * postprocessing in a callback because it is passed to callback functions.</p>\r
 223          * @return {Number} transactionId The id of the server transaction. This may be used\r
 224          * to cancel the request.\r
 225          */\r
 226         request : function(o){\r
 227             var me = this;\r
 228             if(me.fireEvent(BEFOREREQUEST, me, o)){\r
 229                 if (o.el) {\r
 230                     if(!Ext.isEmpty(o.indicatorText)){\r
 231                         me.indicatorText = '<div class="loading-indicator">'+o.indicatorText+"</div>";\r
 232                     }\r
 233                     if(me.indicatorText) {\r
 234                         Ext.getDom(o.el).innerHTML = me.indicatorText;                        \r
 235                     }\r
 236                     o.success = (Ext.isFunction(o.success) ? o.success : function(){}).createInterceptor(function(response) {\r
 237                         Ext.getDom(o.el).innerHTML = response.responseText;\r
 238                     });\r
 239                 }\r
 240                 \r
 241                 var p = o.params,\r
 242                     url = o.url || me.url,                \r
 243                     method,\r
 244                     cb = {success: me.handleResponse,\r
 245                           failure: me.handleFailure,\r
 246                           scope: me,\r
 247                           argument: {options: o},\r
 248                           timeout : o.timeout || me.timeout\r
 249                     },\r
 250                     form,                    \r
 251                     serForm;                    \r
 252                   \r
 253                      \r
 254                 if (Ext.isFunction(p)) {\r
 255                     p = p.call(o.scope||WINDOW, o);\r
 256                 }\r
 257                                                            \r
 258                 p = Ext.urlEncode(me.extraParams, Ext.isObject(p) ? Ext.urlEncode(p) : p);    \r
 259                 \r
 260                 if (Ext.isFunction(url)) {\r
 261                     url = url.call(o.scope || WINDOW, o);\r
 262                 }\r
 263     \r
 264                 if((form = Ext.getDom(o.form))){\r
 265                     url = url || form.action;\r
 266                      if(o.isUpload || /multipart\/form-data/i.test(form.getAttribute("enctype"))) { \r
 267                          return me.doFormUpload.call(me, o, p, url);\r
 268                      }\r
 269                     serForm = Ext.lib.Ajax.serializeForm(form);                    \r
 270                     p = p ? (p + '&' + serForm) : serForm;\r
 271                 }\r
 272                 \r
 273                 method = o.method || me.method || ((p || o.xmlData || o.jsonData) ? POST : GET);\r
 274                 \r
 275                 if(method === GET && (me.disableCaching && o.disableCaching !== false) || o.disableCaching === true){\r
 276                     var dcp = o.disableCachingParam || me.disableCachingParam;\r
 277                     url = Ext.urlAppend(url, dcp + '=' + (new Date().getTime()));\r
 278                 }\r
 279                 \r
 280                 o.headers = Ext.apply(o.headers || {}, me.defaultHeaders || {});\r
 281                 \r
 282                 if(o.autoAbort === true || me.autoAbort) {\r
 283                     me.abort();\r
 284                 }\r
 285                  \r
 286                 if((method == GET || o.xmlData || o.jsonData) && p){\r
 287                     url = Ext.urlAppend(url, p);  \r
 288                     p = '';\r
 289                 }\r
 290                 return (me.transId = Ext.lib.Ajax.request(method, url, cb, p, o));\r
 291             }else{                \r
 292                 return o.callback ? o.callback.apply(o.scope, [o,UNDEFINED,UNDEFINED]) : null;\r
 293             }\r
 294         },\r
 295     \r
 296         <div id="method-Ext.data.Connection-isLoading"></div>/**\r
 297          * Determine whether this object has a request outstanding.\r
 298          * @param {Number} transactionId (Optional) defaults to the last transaction\r
 299          * @return {Boolean} True if there is an outstanding request.\r
 300          */\r
 301         isLoading : function(transId){\r
 302             return transId ? Ext.lib.Ajax.isCallInProgress(transId) : !! this.transId;            \r
 303         },\r
 304     \r
 305         <div id="method-Ext.data.Connection-abort"></div>/**\r
 306          * Aborts any outstanding request.\r
 307          * @param {Number} transactionId (Optional) defaults to the last transaction\r
 308          */\r
 309         abort : function(transId){\r
 310             if(transId || this.isLoading()){\r
 311                 Ext.lib.Ajax.abort(transId || this.transId);\r
 312             }\r
 313         },\r
 314 \r
 315         // private\r
 316         handleResponse : function(response){\r
 317             this.transId = false;\r
 318             var options = response.argument.options;\r
 319             response.argument = options ? options.argument : null;\r
 320             this.fireEvent(REQUESTCOMPLETE, this, response, options);\r
 321             if(options.success){\r
 322                 options.success.call(options.scope, response, options);\r
 323             }\r
 324             if(options.callback){\r
 325                 options.callback.call(options.scope, options, true, response);\r
 326             }\r
 327         },\r
 328 \r
 329         // private\r
 330         handleFailure : function(response, e){\r
 331             this.transId = false;\r
 332             var options = response.argument.options;\r
 333             response.argument = options ? options.argument : null;\r
 334             this.fireEvent(REQUESTEXCEPTION, this, response, options, e);\r
 335             if(options.failure){\r
 336                 options.failure.call(options.scope, response, options);\r
 337             }\r
 338             if(options.callback){\r
 339                 options.callback.call(options.scope, options, false, response);\r
 340             }\r
 341         },\r
 342 \r
 343         // private\r
 344         doFormUpload : function(o, ps, url){\r
 345             var id = Ext.id(),\r
 346                 doc = document,\r
 347                 frame = doc.createElement('iframe'),\r
 348                 form = Ext.getDom(o.form),\r
 349                 hiddens = [],\r
 350                 hd,\r
 351                 encoding = 'multipart/form-data',\r
 352                 buf = {\r
 353                     target: form.target,\r
 354                     method: form.method,\r
 355                     encoding: form.encoding,\r
 356                     enctype: form.enctype,\r
 357                     action: form.action\r
 358                 };\r
 359 \r
 360             Ext.fly(frame).set({\r
 361                 id: id,\r
 362                 name: id,\r
 363                 cls: 'x-hidden',\r
 364                 src: Ext.SSL_SECURE_URL // for IE\r
 365             });\r
 366             doc.body.appendChild(frame);\r
 367 \r
 368             // This is required so that IE doesn't pop the response up in a new window.\r
 369             if(Ext.isIE){\r
 370                document.frames[id].name = id;\r
 371             }\r
 372 \r
 373             Ext.fly(form).set({\r
 374                 target: id,\r
 375                 method: POST,\r
 376                 enctype: encoding,\r
 377                 encoding: encoding,\r
 378                 action: url || buf.action\r
 379             });\r
 380 \r
 381             // add dynamic params\r
 382             Ext.iterate(Ext.urlDecode(ps, false), function(k, v){\r
 383                 hd = doc.createElement('input');\r
 384                 Ext.fly(hd).set({\r
 385                     type: 'hidden',\r
 386                     value: v,\r
 387                     name: k\r
 388                 });\r
 389                 form.appendChild(hd);\r
 390                 hiddens.push(hd);\r
 391             });\r
 392 \r
 393             function cb(){\r
 394                 var me = this,\r
 395                     // bogus response object\r
 396                     r = {responseText : '',\r
 397                          responseXML : null,\r
 398                          argument : o.argument},\r
 399                     doc,\r
 400                     firstChild;\r
 401 \r
 402                 try{\r
 403                     doc = frame.contentWindow.document || frame.contentDocument || WINDOW.frames[id].document;\r
 404                     if(doc){\r
 405                         if(doc.body){\r
 406                             if(/textarea/i.test((firstChild = doc.body.firstChild || {}).tagName)){ // json response wrapped in textarea\r
 407                                 r.responseText = firstChild.value;\r
 408                             }else{\r
 409                                 r.responseText = doc.body.innerHTML;\r
 410                             }\r
 411                         }\r
 412                         //in IE the document may still have a body even if returns XML.\r
 413                         r.responseXML = doc.XMLDocument || doc;\r
 414                     }\r
 415                 }\r
 416                 catch(e) {}\r
 417 \r
 418                 Ext.EventManager.removeListener(frame, LOAD, cb, me);\r
 419 \r
 420                 me.fireEvent(REQUESTCOMPLETE, me, r, o);\r
 421 \r
 422                 function runCallback(fn, scope, args){\r
 423                     if(Ext.isFunction(fn)){\r
 424                         fn.apply(scope, args);\r
 425                     }\r
 426                 }\r
 427 \r
 428                 runCallback(o.success, o.scope, [r, o]);\r
 429                 runCallback(o.callback, o.scope, [o, true, r]);\r
 430 \r
 431                 if(!me.debugUploads){\r
 432                     setTimeout(function(){Ext.removeNode(frame);}, 100);\r
 433                 }\r
 434             }\r
 435 \r
 436             Ext.EventManager.on(frame, LOAD, cb, this);\r
 437             form.submit();\r
 438 \r
 439             Ext.fly(form).set(buf);\r
 440             Ext.each(hiddens, function(h) {\r
 441                 Ext.removeNode(h);\r
 442             });\r
 443         }\r
 444     });\r
 445 })();\r
 446 \r
 447 <div id="cls-Ext.Ajax"></div>/**\r
 448  * @class Ext.Ajax\r
 449  * @extends Ext.data.Connection\r
 450  * <p>The global Ajax request class that provides a simple way to make Ajax requests\r
 451  * with maximum flexibility.</p>\r
 452  * <p>Since Ext.Ajax is a singleton, you can set common properties/events for it once\r
 453  * and override them at the request function level only if necessary.</p>\r
 454  * <p>Common <b>Properties</b> you may want to set are:<div class="mdetail-params"><ul>\r
 455  * <li><b><tt>{@link #method}</tt></b><p class="sub-desc"></p></li>\r
 456  * <li><b><tt>{@link #extraParams}</tt></b><p class="sub-desc"></p></li>\r
 457  * <li><b><tt>{@link #url}</tt></b><p class="sub-desc"></p></li>\r
 458  * </ul></div>\r
 459  * <pre><code>\r
 460 // Default headers to pass in every request\r
 461 Ext.Ajax.defaultHeaders = {\r
 462     'Powered-By': 'Ext'\r
 463 };\r
 464  * </code></pre> \r
 465  * </p>\r
 466  * <p>Common <b>Events</b> you may want to set are:<div class="mdetail-params"><ul>\r
 467  * <li><b><tt>{@link Ext.data.Connection#beforerequest beforerequest}</tt></b><p class="sub-desc"></p></li>\r
 468  * <li><b><tt>{@link Ext.data.Connection#requestcomplete requestcomplete}</tt></b><p class="sub-desc"></p></li>\r
 469  * <li><b><tt>{@link Ext.data.Connection#requestexception requestexception}</tt></b><p class="sub-desc"></p></li>\r
 470  * </ul></div>\r
 471  * <pre><code>\r
 472 // Example: show a spinner during all Ajax requests\r
 473 Ext.Ajax.on('beforerequest', this.showSpinner, this);\r
 474 Ext.Ajax.on('requestcomplete', this.hideSpinner, this);\r
 475 Ext.Ajax.on('requestexception', this.hideSpinner, this);\r
 476  * </code></pre> \r
 477  * </p>\r
 478  * <p>An example request:</p>\r
 479  * <pre><code>\r
 480 // Basic request\r
 481 Ext.Ajax.{@link Ext.data.Connection#request request}({\r
 482    url: 'foo.php',\r
 483    success: someFn,\r
 484    failure: otherFn,\r
 485    headers: {\r
 486        'my-header': 'foo'\r
 487    },\r
 488    params: { foo: 'bar' }\r
 489 });\r
 490 \r
 491 // Simple ajax form submission\r
 492 Ext.Ajax.{@link Ext.data.Connection#request request}({\r
 493     form: 'some-form',\r
 494     params: 'foo=bar'\r
 495 });\r
 496  * </code></pre> \r
 497  * </p>\r
 498  * @singleton\r
 499  */\r
 500 Ext.Ajax = new Ext.data.Connection({\r
 501     <div id="cfg-Ext.Ajax-url"></div>/**\r
 502      * @cfg {String} url @hide\r
 503      */\r
 504     <div id="cfg-Ext.Ajax-extraParams"></div>/**\r
 505      * @cfg {Object} extraParams @hide\r
 506      */\r
 507     <div id="cfg-Ext.Ajax-defaultHeaders"></div>/**\r
 508      * @cfg {Object} defaultHeaders @hide\r
 509      */\r
 510     <div id="cfg-Ext.Ajax-method"></div>/**\r
 511      * @cfg {String} method (Optional) @hide\r
 512      */\r
 513     <div id="cfg-Ext.Ajax-timeout"></div>/**\r
 514      * @cfg {Number} timeout (Optional) @hide\r
 515      */\r
 516     <div id="cfg-Ext.Ajax-autoAbort"></div>/**\r
 517      * @cfg {Boolean} autoAbort (Optional) @hide\r
 518      */\r
 519 \r
 520     <div id="cfg-Ext.Ajax-disableCaching"></div>/**\r
 521      * @cfg {Boolean} disableCaching (Optional) @hide\r
 522      */\r
 523 \r
 524     <div id="prop-Ext.Ajax-disableCaching"></div>/**\r
 525      * @property  disableCaching\r
 526      * True to add a unique cache-buster param to GET requests. (defaults to true)\r
 527      * @type Boolean\r
 528      */\r
 529     <div id="prop-Ext.Ajax-url"></div>/**\r
 530      * @property  url\r
 531      * The default URL to be used for requests to the server. (defaults to undefined)\r
 532      * If the server receives all requests through one URL, setting this once is easier than\r
 533      * entering it on every request.\r
 534      * @type String\r
 535      */\r
 536     <div id="prop-Ext.Ajax-extraParams"></div>/**\r
 537      * @property  extraParams\r
 538      * An object containing properties which are used as extra parameters to each request made\r
 539      * by this object (defaults to undefined). Session information and other data that you need\r
 540      * to pass with each request are commonly put here.\r
 541      * @type Object\r
 542      */\r
 543     <div id="prop-Ext.Ajax-defaultHeaders"></div>/**\r
 544      * @property  defaultHeaders\r
 545      * An object containing request headers which are added to each request made by this object\r
 546      * (defaults to undefined).\r
 547      * @type Object\r
 548      */\r
 549     <div id="prop-Ext.Ajax-method"></div>/**\r
 550      * @property  method\r
 551      * The default HTTP method to be used for requests. Note that this is case-sensitive and\r
 552      * should be all caps (defaults to undefined; if not set but params are present will use\r
 553      * <tt>"POST"</tt>, otherwise will use <tt>"GET"</tt>.)\r
 554      * @type String\r
 555      */\r
 556     <div id="prop-Ext.Ajax-timeout"></div>/**\r
 557      * @property  timeout\r
 558      * The timeout in milliseconds to be used for requests. (defaults to 30000)\r
 559      * @type Number\r
 560      */\r
 561 \r
 562     <div id="prop-Ext.Ajax-autoAbort"></div>/**\r
 563      * @property  autoAbort\r
 564      * Whether a new request should abort any pending requests. (defaults to false)\r
 565      * @type Boolean\r
 566      */\r
 567     autoAbort : false,\r
 568 \r
 569     <div id="method-Ext.Ajax-serializeForm"></div>/**\r
 570      * Serialize the passed form into a url encoded string\r
 571      * @param {String/HTMLElement} form\r
 572      * @return {String}\r
 573      */\r
 574     serializeForm : function(form){\r
 575         return Ext.lib.Ajax.serializeForm(form);\r
 576     }\r
 577 });\r
 578 </pre>    \r
 579 </body>\r
 580 </html>