-<div xmlns:ext="http://www.extjs.com" class="body-wrap"><div class="inheritance res-block"><pre class="res-block-inner"><a href="output/Ext.util.Observable.html" ext:member="" ext:cls="Ext.util.Observable">Observable</a> <img src="resources/elbow-end.gif">Connection</pre></div><h1>Class <a href="source/Connection.html#cls-Ext.data.Connection">Ext.data.Connection</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext.data</td></tr><tr><td class="label">Defined In:</td><td class="hd-info">Connection.js</td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/Connection.html#cls-Ext.data.Connection">Connection</a></td></tr><tr><td class="label">Subclasses:</td><td class="hd-info"><a href="output/Ext.Ajax.html" ext:cls="Ext.Ajax">Ajax</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info"><a href="output/Ext.util.Observable.html" ext:cls="Ext.util.Observable" ext:member="">Observable</a></td></tr></table><div class="description"><p>The class encapsulates a connection to the page's originating domain, allowing requests to be made\r
-either to a configured URL, or to a URL specified at request time.</p>\r
-<p>Requests made by this class are asynchronous, and will return immediately. No data from\r
-the server will be available to the statement immediately following the <a href="output/Ext.data.Connection.html#Ext.data.Connection-request" ext:member="request" ext:cls="Ext.data.Connection">request</a> call.\r
-To process returned data, use a\r
-<a href="#request-option-success" ext:member="request-option-success" ext:cls="Ext.data.Connection">success callback</a>\r
-in the request options object,\r
-or an <a href="output/Ext.data.Connection.html#Ext.data.Connection-requestcomplete" ext:member="requestcomplete" ext:cls="Ext.data.Connection">event listener</a>.</p>\r
-<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
-is they are <b>not</b> performed using XMLHttpRequests. Instead the form is submitted in the standard\r
-manner with the DOM <tt><form></tt> element temporarily modified to have its\r
-<a href="http://www.w3.org/TR/REC-html40/present/frames.html#adef-target">target</a> set to refer\r
-to a dynamically generated, hidden <tt><iframe></tt> which is inserted into the document\r
-but removed after the return data has been gathered.</p>\r
-<p>The server response is parsed by the browser to create the document for the IFRAME. If the\r
-server is using JSON to send the return object, then the\r
-<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17">Content-Type</a> header\r
-must be set to "text/html" in order to tell the browser to insert the text unchanged into the document body.</p>\r
-<p>Characters which are significant to an HTML parser must be sent as HTML entities, so encode\r
-"<" as "&lt;", "&" as "&amp;" etc.</p>\r
-<p>The response text is retrieved from the document, and a fake XMLHttpRequest object\r
-is created containing a <tt>responseText</tt> property in order to conform to the\r
-requirements of event handlers and callbacks.</p>\r
-<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
-and some server technologies (notably JEE) may require some custom processing in order to\r
-retrieve parameter names and parameter values from the packet content.</p></div><div class="hr"></div><a id="Ext.data.Connection-configs"></a><h2>Config Options</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Config Options</th><th class="msource-header">Defined By</th></tr><tr class="config-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.data.Connection-autoAbort"></a><b><a href="source/Connection.html#cfg-Ext.data.Connection-autoAbort">autoAbort</a></b> : Boolean<div class="mdesc">Whether this request should abort any pending requests. (defaults to false)</div></td><td class="msource">Connection</td></tr><tr class="config-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.data.Connection-defaultHeaders"></a><b><a href="source/Connection.html#cfg-Ext.data.Connection-defaultHeaders">defaultHeaders</a></b> : Object<div class="mdesc">An object containing request headers which are added\r
-to each request made by this object. (defaults to undefined)</div></td><td class="msource">Connection</td></tr><tr class="config-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.data.Connection-disableCaching"></a><b><a href="source/Connection.html#cfg-Ext.data.Connection-disableCaching">disableCaching</a></b> : Boolean<div class="mdesc">True to add a unique cache-buster param to GET requests. (defaults to true)</div></td><td class="msource">Connection</td></tr><tr class="config-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.data.Connection-disableCachingParam"></a><b><a href="source/Connection.html#cfg-Ext.data.Connection-disableCachingParam">disableCachingParam</a></b> : String<div class="mdesc">Change the parameter which is sent went disabling caching\r
-through a cache buster. Defaults to '_dc'</div></td><td class="msource">Connection</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.data.Connection-extraParams"></a><b><a href="source/Connection.html#cfg-Ext.data.Connection-extraParams">extraParams</a></b> : Object<div class="mdesc"><div class="short">An object containing properties which are used as
-extra parameters to each request made by this object. (defaults to...</div><div class="long">An object containing properties which are used as\r
+<div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.data.Connection-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a> <a class="inner-link" href="#Ext.data.Connection-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a> <a class="inner-link" href="#Ext.data.Connection-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a> <a class="inner-link" href="#Ext.data.Connection-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a> <a class="bookmark" href="../docs/?class=Ext.data.Connection"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a> </div><div class="inheritance res-block"><pre class="res-block-inner"><a href="output/Ext.util.Observable.html" ext:member="" ext:cls="Ext.util.Observable">Observable</a> <img src="resources/elbow-end.gif">Connection</pre></div><h1>Class <a href="source/Connection.html#cls-Ext.data.Connection">Ext.data.Connection</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext.data</td></tr><tr><td class="label">Defined In:</td><td class="hd-info"><a href="source/Connection.html#cls-Ext.data.Connection">Connection.js</a></td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/Connection.html#cls-Ext.data.Connection">Connection</a></td></tr><tr><td class="label">Subclasses:</td><td class="hd-info"><a href="output/Ext.Ajax.html" ext:cls="Ext.Ajax">Ajax</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info"><a href="output/Ext.util.Observable.html" ext:cls="Ext.util.Observable" ext:member="">Observable</a></td></tr></table><div class="description"><p>The class encapsulates a connection to the page's originating domain, allowing requests to be made
+either to a configured URL, or to a URL specified at request time.</p>
+<p>Requests made by this class are asynchronous, and will return immediately. No data from
+the server will be available to the statement immediately following the <a href="output/Ext.data.Connection.html#Ext.data.Connection-request" ext:member="request" ext:cls="Ext.data.Connection">request</a> call.
+To process returned data, use a
+<a href="#request-option-success" ext:member="request-option-success" ext:cls="Ext.data.Connection">success callback</a>
+in the request options object,
+or an <a href="output/Ext.data.Connection.html#Ext.data.Connection-requestcomplete" ext:member="requestcomplete" ext:cls="Ext.data.Connection">event listener</a>.</p>
+<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
+is they are <b>not</b> performed using XMLHttpRequests. Instead the form is submitted in the standard
+manner with the DOM <tt><form></tt> element temporarily modified to have its
+<a href="http://www.w3.org/TR/REC-html40/present/frames.html#adef-target">target</a> set to refer
+to a dynamically generated, hidden <tt><iframe></tt> which is inserted into the document
+but removed after the return data has been gathered.</p>
+<p>The server response is parsed by the browser to create the document for the IFRAME. If the
+server is using JSON to send the return object, then the
+<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17">Content-Type</a> header
+must be set to "text/html" in order to tell the browser to insert the text unchanged into the document body.</p>
+<p>Characters which are significant to an HTML parser must be sent as HTML entities, so encode
+"<" as "&lt;", "&" as "&amp;" etc.</p>
+<p>The response text is retrieved from the document, and a fake XMLHttpRequest object
+is created containing a <tt>responseText</tt> property in order to conform to the
+requirements of event handlers and callbacks.</p>
+<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>
+and some server technologies (notably JEE) may require some custom processing in order to
+retrieve parameter names and parameter values from the packet content.</p></div><div class="hr"></div><a id="Ext.data.Connection-configs"></a><h2>Config Options</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Config Options</th><th class="msource-header">Defined By</th></tr><tr class="config-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.data.Connection-autoAbort"></a><b><a href="source/Connection.html#cfg-Ext.data.Connection-autoAbort">autoAbort</a></b> : Boolean<div class="mdesc">Whether this request should abort any pending requests. (defaults to false)</div></td><td class="msource">Connection</td></tr><tr class="config-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.data.Connection-defaultHeaders"></a><b><a href="source/Connection.html#cfg-Ext.data.Connection-defaultHeaders">defaultHeaders</a></b> : Object<div class="mdesc">An object containing request headers which are added
+to each request made by this object. (defaults to undefined)</div></td><td class="msource">Connection</td></tr><tr class="config-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.data.Connection-disableCaching"></a><b><a href="source/Connection.html#cfg-Ext.data.Connection-disableCaching">disableCaching</a></b> : Boolean<div class="mdesc">True to add a unique cache-buster param to GET requests. (defaults to true)</div></td><td class="msource">Connection</td></tr><tr class="config-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.data.Connection-disableCachingParam"></a><b><a href="source/Connection.html#cfg-Ext.data.Connection-disableCachingParam">disableCachingParam</a></b> : String<div class="mdesc">Change the parameter which is sent went disabling caching
+through a cache buster. Defaults to '_dc'</div></td><td class="msource">Connection</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.data.Connection-extraParams"></a><b><a href="source/Connection.html#cfg-Ext.data.Connection-extraParams">extraParams</a></b> : Object<div class="mdesc"><div class="short">An object containing properties which are used as
+extra parameters to each request made by this object. (defaults to ...</div><div class="long">An object containing properties which are used as
extra parameters to each request made by this object. (defaults to undefined)</div></div></td><td class="msource">Connection</td></tr><tr class="config-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-listeners"></a><b><a href="source/Observable.html#cfg-Ext.util.Observable-listeners">listeners</a></b> : Object<div class="mdesc"><div class="short">A config object containing one or more event handlers to be added to this
object during initialization. This should ...</div><div class="long"><p>A config object containing one or more event handlers to be added to this
object during initialization. This should be a valid listeners config object as specified in the
typeAhead: true,
mode: <em>'local'</em>,
triggerAction: <em>'all'</em>
-});</code></pre></p></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#listeners" ext:member="#listeners" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.data.Connection-method"></a><b><a href="source/Connection.html#cfg-Ext.data.Connection-method">method</a></b> : String<div class="mdesc"><div class="short">The default HTTP method to be used for requests.
-(defaults to undefined; if not set, but request params are present,...</div><div class="long">The default HTTP method to be used for requests.\r
-(defaults to undefined; if not set, but <a href="output/Ext.data.Connection.html#Ext.data.Connection-request" ext:member="request" ext:cls="Ext.data.Connection">request</a> params are present, POST will be used;\r
-otherwise, GET will be used.)</div></div></td><td class="msource">Connection</td></tr><tr class="config-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.data.Connection-timeout"></a><b><a href="source/Connection.html#cfg-Ext.data.Connection-timeout">timeout</a></b> : Number<div class="mdesc">The timeout in milliseconds to be used for requests. (defaults to 30000)</div></td><td class="msource">Connection</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.data.Connection-url"></a><b><a href="source/Connection.html#cfg-Ext.data.Connection-url">url</a></b> : String<div class="mdesc"><div class="short">The default URL to be used for requests to the server. Defaults to undefined.
-The url config may be a function which...</div><div class="long"><p>The default URL to be used for requests to the server. Defaults to undefined.</p>\r
-<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
+});</code></pre></p></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#listeners" ext:member="#listeners" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.data.Connection-method"></a><b><a href="source/Connection.html#cfg-Ext.data.Connection-method">method</a></b> : String<div class="mdesc"><div class="short">The default HTTP method to be used for requests.
+(defaults to undefined; if not set, but request params are present, ...</div><div class="long">The default HTTP method to be used for requests.
+(defaults to undefined; if not set, but <a href="output/Ext.data.Connection.html#Ext.data.Connection-request" ext:member="request" ext:cls="Ext.data.Connection">request</a> params are present, POST will be used;
+otherwise, GET will be used.)</div></div></td><td class="msource">Connection</td></tr><tr class="config-row "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.data.Connection-timeout"></a><b><a href="source/Connection.html#cfg-Ext.data.Connection-timeout">timeout</a></b> : Number<div class="mdesc">The timeout in milliseconds to be used for requests. (defaults to 30000)</div></td><td class="msource">Connection</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.data.Connection-url"></a><b><a href="source/Connection.html#cfg-Ext.data.Connection-url">url</a></b> : String<div class="mdesc"><div class="short">The default URL to be used for requests to the server. Defaults to undefined.
+The url config may be a function which ...</div><div class="long"><p>The default URL to be used for requests to the server. Defaults to undefined.</p>
+<p>The <code>url</code> config may be a function which <i>returns</i> the URL to use for the Ajax request. The scope
(<code><b>this</b></code> reference) of the function is the <code>scope</code> option passed to the <a href="output/Ext.data.Connection.html#Ext.data.Connection-request" ext:member="request" ext:cls="Ext.data.Connection">request</a> method.</p></div></div></td><td class="msource">Connection</td></tr></tbody></table><a id="Ext.data.Connection-props"></a><h2>Public Properties</h2><div class="no-members">This class has no public properties.</div><a id="Ext.data.Connection-methods"></a><h2>Public Methods</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Method</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.data.Connection-Connection"></a><b><a href="source/Connection.html#cls-Ext.data.Connection">Connection</a></b>( <code>Object config</code> )
<div class="mdesc"><div class="short"></div><div class="long"><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>config</code> : Object<div class="sub-desc">a configuration object.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">Connection</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.data.Connection-abort"></a><b><a href="source/Connection.html#method-Ext.data.Connection-abort">abort</a></b>( <span title="Optional" class="optional">[<code>Number transactionId</code>]</span> )
:
scope: this
});</code></pre></div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#addListener" ext:member="#addListener" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-enableBubble"></a><b><a href="source/Observable-more.html#method-Ext.util.Observable-enableBubble">enableBubble</a></b>( <code>String/Array events</code> )
:
- void<div class="mdesc"><div class="short">Enables events fired by this Observable to bubble up an owner hierarchy by calling
-this.getBubbleTarget() if present...</div><div class="long"><p>Enables events fired by this Observable to bubble up an owner hierarchy by calling\r
-<code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>\r
-<p>This is commonly used by Ext.Components to bubble events to owner Containers. See <a href="output/Ext.Component.getBubbleTarget.html" ext:cls="Ext.Component.getBubbleTarget">Ext.Component.getBubbleTarget</a>. The default\r
-implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to\r
-access the required target more quickly.</p>\r
-<p>Example:</p><pre><code>Ext.override(Ext.form.Field, {\r
- <i>// Add functionality to Field's initComponent to enable the change event to bubble\r</i>
- initComponent : Ext.form.Field.prototype.initComponent.createSequence(<b>function</b>() {\r
- this.enableBubble(<em>'change'</em>);\r
- }),\r
-\r
- <i>// We know that we want Field's events to bubble directly to the FormPanel.\r</i>
- getBubbleTarget : <b>function</b>() {\r
- <b>if</b> (!this.formPanel) {\r
- this.formPanel = this.findParentByType(<em>'form'</em>);\r
- }\r
- <b>return</b> this.formPanel;\r
- }\r
-});\r
-\r
-<b>var</b> myForm = <b>new</b> Ext.formPanel({\r
- title: <em>'User Details'</em>,\r
- items: [{\r
- ...\r
- }],\r
- listeners: {\r
- change: <b>function</b>() {\r
- <i>// Title goes red <b>if</b> form has been modified.\r</i>
- myForm.header.setStyle(<em>'color'</em>, <em>'red'</em>);\r
- }\r
- }\r
+ void<div class="mdesc"><div class="short">Enables events fired by this Observable to bubble up an owner hierarchy by calling
+this.getBubbleTarget() if present....</div><div class="long"><p>Enables events fired by this Observable to bubble up an owner hierarchy by calling
+<code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>
+<p>This is commonly used by Ext.Components to bubble events to owner Containers. See <a href="output/Ext.Component.getBubbleTarget.html" ext:cls="Ext.Component.getBubbleTarget">Ext.Component.getBubbleTarget</a>. The default
+implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to
+access the required target more quickly.</p>
+<p>Example:</p><pre><code>Ext.override(Ext.form.Field, {
+ <i>// Add functionality to Field's initComponent to enable the change event to bubble</i>
+ initComponent : Ext.form.Field.prototype.initComponent.createSequence(<b>function</b>() {
+ this.enableBubble(<em>'change'</em>);
+ }),
+
+ <i>// We know that we want Field's events to bubble directly to the FormPanel.</i>
+ getBubbleTarget : <b>function</b>() {
+ <b>if</b> (!this.formPanel) {
+ this.formPanel = this.findParentByType(<em>'form'</em>);
+ }
+ <b>return</b> this.formPanel;
+ }
+});
+
+<b>var</b> myForm = <b>new</b> Ext.formPanel({
+ title: <em>'User Details'</em>,
+ items: [{
+ ...
+ }],
+ listeners: {
+ change: <b>function</b>() {
+ <i>// Title goes red <b>if</b> form has been modified.</i>
+ myForm.header.setStyle(<em>'color'</em>, <em>'red'</em>);
+ }
+ }
});</code></pre><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>events</code> : String/Array<div class="sub-desc">The event name to bubble, or an Array of event names.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#enableBubble" ext:member="#enableBubble" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-fireEvent"></a><b><a href="source/Observable.html#method-Ext.util.Observable-fireEvent">fireEvent</a></b>( <code>String eventName</code>, <code>Object... args</code> )
:
Boolean<div class="mdesc"><div class="short">Fires the specified event with the passed parameters (minus the event name).
:
void<div class="mdesc"><div class="short">Removes an event handler.</div><div class="long">Removes an event handler.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The type of event the handler was associated with.</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove. <b>This must be a reference to the function passed into the <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a> call.</b></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope originally specified for the handler.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#removeListener" ext:member="#removeListener" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.data.Connection-request"></a><b><a href="source/Connection.html#method-Ext.data.Connection-request">request</a></b>( <code>Object options</code> )
:
- Number<div class="mdesc"><div class="short">Sends an HTTP request to a remote server.
-Important: Ajax server requests are asynchronous, and this call will
-retu...</div><div class="long"><p>Sends an HTTP request to a remote server.</p>\r
-<p><b>Important:</b> Ajax server requests are asynchronous, and this call will\r
-return before the response has been received. Process any returned data\r
-in a callback function.</p>\r
-<pre><code>Ext.Ajax.request({\r
- url: <em>'ajax_demo/sample.json'</em>,\r
- success: <b>function</b>(response, opts) {\r
- <b>var</b> obj = Ext.decode(response.responseText);\r
- console.dir(obj);\r
- },\r
- failure: <b>function</b>(response, opts) {\r
- console.log(<em>'server-side failure <b>with</b> status code '</em> + response.status);\r
- }\r
-});</code></pre>\r
-<p>To execute a callback function in the correct scope, use the <tt>scope</tt> option.</p><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>options</code> : Object<div class="sub-desc">An object which may contain the following properties:<ul>\r
-<li><b>url</b> : String/Function (Optional)<div class="sub-desc">The URL to\r
-which to send the request, or a function to call which returns a URL string. The scope of the\r
-function is specified by the <tt>scope</tt> option. Defaults to the configured\r
-<tt><a href="output/Ext.data.Connection.html#Ext.data.Connection-url" ext:member="url" ext:cls="Ext.data.Connection">url</a></tt>.</div></li>\r
-<li><b>params</b> : Object/String/Function (Optional)<div class="sub-desc">\r
-An object containing properties which are used as parameters to the\r
-request, a url encoded string or a function to call to get either. The scope of the function\r
-is specified by the <tt>scope</tt> option.</div></li>\r
-<li><b>method</b> : String (Optional)<div class="sub-desc">The HTTP method to use\r
-for the request. Defaults to the configured method, or if no method was configured,\r
-"GET" if no parameters are being sent, and "POST" if parameters are being sent. Note that\r
-the method name is case-sensitive and should be all caps.</div></li>\r
-<li><b>callback</b> : Function (Optional)<div class="sub-desc">The\r
-function to be called upon receipt of the HTTP response. The callback is\r
-called regardless of success or failure and is passed the following\r
-parameters:<ul>\r
-<li><b>options</b> : Object<div class="sub-desc">The parameter to the request call.</div></li>\r
-<li><b>success</b> : Boolean<div class="sub-desc">True if the request succeeded.</div></li>\r
-<li><b>response</b> : Object<div class="sub-desc">The XMLHttpRequest object containing the response data.\r
-See <a href="http://www.w3.org/TR/XMLHttpRequest/">http://www.w3.org/TR/XMLHttpRequest/</a> for details about\r
-accessing elements of the response.</div></li>\r
-</ul></div></li>\r
-<li><a id="request-option-success"></a><b>success</b> : Function (Optional)<div class="sub-desc">The function\r
-to be called upon success of the request. The callback is passed the following\r
-parameters:<ul>\r
-<li><b>response</b> : Object<div class="sub-desc">The XMLHttpRequest object containing the response data.</div></li>\r
-<li><b>options</b> : Object<div class="sub-desc">The parameter to the request call.</div></li>\r
-</ul></div></li>\r
-<li><b>failure</b> : Function (Optional)<div class="sub-desc">The function\r
-to be called upon failure of the request. The callback is passed the\r
-following parameters:<ul>\r
-<li><b>response</b> : Object<div class="sub-desc">The XMLHttpRequest object containing the response data.</div></li>\r
-<li><b>options</b> : Object<div class="sub-desc">The parameter to the request call.</div></li>\r
-</ul></div></li>\r
-<li><b>scope</b> : Object (Optional)<div class="sub-desc">The scope in\r
-which to execute the callbacks: The "this" object for the callback function. If the <tt>url</tt>, or <tt>params</tt> options were\r
-specified as functions from which to draw values, then this also serves as the scope for those function calls.\r
-Defaults to the browser window.</div></li>\r
-<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
-<li><b>form</b> : Element/HTMLElement/String (Optional)<div class="sub-desc">The <tt><form></tt>\r
-Element or the id of the <tt><form></tt> to pull parameters from.</div></li>\r
-<li><a id="request-option-isUpload"></a><b>isUpload</b> : Boolean (Optional)<div class="sub-desc"><b>Only meaningful when used\r
-with the <tt>form</tt> option</b>.\r
-<p>True if the form object is a file upload (will be set automatically if the form was\r
-configured with <b><tt>enctype</tt></b> "multipart/form-data").</p>\r
-<p>File uploads are not performed using normal "Ajax" techniques, that is they are <b>not</b>\r
-performed using XMLHttpRequests. Instead the form is submitted in the standard manner with the\r
-DOM <tt><form></tt> element temporarily modified to have its\r
-<a href="http://www.w3.org/TR/REC-html40/present/frames.html#adef-target">target</a> set to refer\r
-to a dynamically generated, hidden <tt><iframe></tt> which is inserted into the document\r
-but removed after the return data has been gathered.</p>\r
-<p>The server response is parsed by the browser to create the document for the IFRAME. If the\r
-server is using JSON to send the return object, then the\r
-<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17">Content-Type</a> header\r
-must be set to "text/html" in order to tell the browser to insert the text unchanged into the document body.</p>\r
-<p>The response text is retrieved from the document, and a fake XMLHttpRequest object\r
-is created containing a <tt>responseText</tt> property in order to conform to the\r
-requirements of event handlers and callbacks.</p>\r
-<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
-and some server technologies (notably JEE) may require some custom processing in order to\r
-retrieve parameter names and parameter values from the packet content.</p>\r
-</div></li>\r
-<li><b>headers</b> : Object (Optional)<div class="sub-desc">Request\r
-headers to set for the request.</div></li>\r
-<li><b>xmlData</b> : Object (Optional)<div class="sub-desc">XML document\r
-to use for the post. Note: This will be used instead of params for the post\r
-data. Any params will be appended to the URL.</div></li>\r
-<li><b>jsonData</b> : Object/String (Optional)<div class="sub-desc">JSON\r
-data to use as the post. Note: This will be used instead of params for the post\r
-data. Any params will be appended to the URL.</div></li>\r
-<li><b>disableCaching</b> : Boolean (Optional)<div class="sub-desc">True\r
-to add a unique cache-buster param to GET requests.</div></li>\r
-</ul></p>\r
-<p>The options object may also contain any other property which might be needed to perform\r
-postprocessing in a callback because it is passed to callback functions.</p></div></li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc">transactionId The id of the server transaction. This may be used
+ Number<div class="mdesc"><div class="short">Sends an HTTP request to a remote server.
+Important: Ajax server requests are asynchronous, and this call will
+return...</div><div class="long"><p>Sends an HTTP request to a remote server.</p>
+<p><b>Important:</b> Ajax server requests are asynchronous, and this call will
+return before the response has been received. Process any returned data
+in a callback function.</p>
+<pre><code>Ext.Ajax.request({
+ url: <em>'ajax_demo/sample.json'</em>,
+ success: <b>function</b>(response, opts) {
+ <b>var</b> obj = Ext.decode(response.responseText);
+ console.dir(obj);
+ },
+ failure: <b>function</b>(response, opts) {
+ console.log(<em>'server-side failure <b>with</b> status code '</em> + response.status);
+ }
+});</code></pre>
+<p>To execute a callback function in the correct scope, use the <tt>scope</tt> option.</p><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>options</code> : Object<div class="sub-desc">An object which may contain the following properties:<ul>
+<li><b>url</b> : String/Function (Optional)<div class="sub-desc">The URL to
+which to send the request, or a function to call which returns a URL string. The scope of the
+function is specified by the <tt>scope</tt> option. Defaults to the configured
+<tt><a href="output/Ext.data.Connection.html#Ext.data.Connection-url" ext:member="url" ext:cls="Ext.data.Connection">url</a></tt>.</div></li>
+<li><b>params</b> : Object/String/Function (Optional)<div class="sub-desc">
+An object containing properties which are used as parameters to the
+request, a url encoded string or a function to call to get either. The scope of the function
+is specified by the <tt>scope</tt> option.</div></li>
+<li><b>method</b> : String (Optional)<div class="sub-desc">The HTTP method to use
+for the request. Defaults to the configured method, or if no method was configured,
+"GET" if no parameters are being sent, and "POST" if parameters are being sent. Note that
+the method name is case-sensitive and should be all caps.</div></li>
+<li><b>callback</b> : Function (Optional)<div class="sub-desc">The
+function to be called upon receipt of the HTTP response. The callback is
+called regardless of success or failure and is passed the following
+parameters:<ul>
+<li><b>options</b> : Object<div class="sub-desc">The parameter to the request call.</div></li>
+<li><b>success</b> : Boolean<div class="sub-desc">True if the request succeeded.</div></li>
+<li><b>response</b> : Object<div class="sub-desc">The XMLHttpRequest object containing the response data.
+See <a href="http://www.w3.org/TR/XMLHttpRequest/">http://www.w3.org/TR/XMLHttpRequest/</a> for details about
+accessing elements of the response.</div></li>
+</ul></div></li>
+<li><a id="request-option-success"></a><b>success</b> : Function (Optional)<div class="sub-desc">The function
+to be called upon success of the request. The callback is passed the following
+parameters:<ul>
+<li><b>response</b> : Object<div class="sub-desc">The XMLHttpRequest object containing the response data.</div></li>
+<li><b>options</b> : Object<div class="sub-desc">The parameter to the request call.</div></li>
+</ul></div></li>
+<li><b>failure</b> : Function (Optional)<div class="sub-desc">The function
+to be called upon failure of the request. The callback is passed the
+following parameters:<ul>
+<li><b>response</b> : Object<div class="sub-desc">The XMLHttpRequest object containing the response data.</div></li>
+<li><b>options</b> : Object<div class="sub-desc">The parameter to the request call.</div></li>
+</ul></div></li>
+<li><b>scope</b> : Object (Optional)<div class="sub-desc">The scope in
+which to execute the callbacks: The "this" object for the callback function. If the <tt>url</tt>, or <tt>params</tt> options were
+specified as functions from which to draw values, then this also serves as the scope for those function calls.
+Defaults to the browser window.</div></li>
+<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>
+<li><b>form</b> : Element/HTMLElement/String (Optional)<div class="sub-desc">The <tt><form></tt>
+Element or the id of the <tt><form></tt> to pull parameters from.</div></li>
+<li><a id="request-option-isUpload"></a><b>isUpload</b> : Boolean (Optional)<div class="sub-desc"><b>Only meaningful when used
+with the <tt>form</tt> option</b>.
+<p>True if the form object is a file upload (will be set automatically if the form was
+configured with <b><tt>enctype</tt></b> "multipart/form-data").</p>
+<p>File uploads are not performed using normal "Ajax" techniques, that is they are <b>not</b>
+performed using XMLHttpRequests. Instead the form is submitted in the standard manner with the
+DOM <tt><form></tt> element temporarily modified to have its
+<a href="http://www.w3.org/TR/REC-html40/present/frames.html#adef-target">target</a> set to refer
+to a dynamically generated, hidden <tt><iframe></tt> which is inserted into the document
+but removed after the return data has been gathered.</p>
+<p>The server response is parsed by the browser to create the document for the IFRAME. If the
+server is using JSON to send the return object, then the
+<a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17">Content-Type</a> header
+must be set to "text/html" in order to tell the browser to insert the text unchanged into the document body.</p>
+<p>The response text is retrieved from the document, and a fake XMLHttpRequest object
+is created containing a <tt>responseText</tt> property in order to conform to the
+requirements of event handlers and callbacks.</p>
+<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>
+and some server technologies (notably JEE) may require some custom processing in order to
+retrieve parameter names and parameter values from the packet content.</p>
+</div></li>
+<li><b>headers</b> : Object (Optional)<div class="sub-desc">Request
+headers to set for the request.</div></li>
+<li><b>xmlData</b> : Object (Optional)<div class="sub-desc">XML document
+to use for the post. Note: This will be used instead of params for the post
+data. Any params will be appended to the URL.</div></li>
+<li><b>jsonData</b> : Object/String (Optional)<div class="sub-desc">JSON
+data to use as the post. Note: This will be used instead of params for the post
+data. Any params will be appended to the URL.</div></li>
+<li><b>disableCaching</b> : Boolean (Optional)<div class="sub-desc">True
+to add a unique cache-buster param to GET requests.</div></li>
+</ul></p>
+<p>The options object may also contain any other property which might be needed to perform
+postprocessing in a callback because it is passed to callback functions.</p></div></li></ul><strong>Returns:</strong><ul><li><code>Number</code><div class="sub-desc">transactionId The id of the server transaction. This may be used
to cancel the request.</div></li></ul></div></div></div></td><td class="msource">Connection</td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-resumeEvents"></a><b><a href="source/Observable.html#method-Ext.util.Observable-resumeEvents">resumeEvents</a></b>()
:
void<div class="mdesc"><div class="short">Resume firing events. (see suspendEvents)
( <code>Connection conn</code>, <code>Object options</code> )
<div class="mdesc"><div class="short">Fires before a network request is made to retrieve a data object.</div><div class="long">Fires before a network request is made to retrieve a data object.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>conn</code> : Connection<div class="sub-desc">This Connection object.</div></li><li><code>options</code> : Object<div class="sub-desc">The options config object passed to the <a href="output/Ext.data.Connection.html#Ext.data.Connection-request" ext:member="request" ext:cls="Ext.data.Connection">request</a> method.</div></li></ul></div></div></div></td><td class="msource">Connection</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.data.Connection-requestcomplete"></a><b><a href="source/Connection.html#event-Ext.data.Connection-requestcomplete">requestcomplete</a></b> :
( <code>Connection conn</code>, <code>Object response</code>, <code>Object options</code> )
- <div class="mdesc"><div class="short">Fires if the request was successfully completed.</div><div class="long">Fires if the request was successfully completed.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>conn</code> : Connection<div class="sub-desc">This Connection object.</div></li><li><code>response</code> : Object<div class="sub-desc">The XHR object containing the response data.\r
-See <a href="http://www.w3.org/TR/XMLHttpRequest/">The XMLHttpRequest Object</a>\r
+ <div class="mdesc"><div class="short">Fires if the request was successfully completed.</div><div class="long">Fires if the request was successfully completed.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>conn</code> : Connection<div class="sub-desc">This Connection object.</div></li><li><code>response</code> : Object<div class="sub-desc">The XHR object containing the response data.
+See <a href="http://www.w3.org/TR/XMLHttpRequest/">The XMLHttpRequest Object</a>
for details.</div></li><li><code>options</code> : Object<div class="sub-desc">The options config object passed to the <a href="output/Ext.data.Connection.html#Ext.data.Connection-request" ext:member="request" ext:cls="Ext.data.Connection">request</a> method.</div></li></ul></div></div></div></td><td class="msource">Connection</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.data.Connection-requestexception"></a><b><a href="source/Connection.html#event-Ext.data.Connection-requestexception">requestexception</a></b> :
( <code>Connection conn</code>, <code>Object response</code>, <code>Object options</code> )
- <div class="mdesc"><div class="short">Fires if an error HTTP status was returned from the server.
-See <a href="http://www.w3.org/Protocols/rfc2616/rfc2616...</div><div class="long">Fires if an error HTTP status was returned from the server.\r
-See <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html">HTTP Status Code Definitions</a>\r
-for details of HTTP status codes.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>conn</code> : Connection<div class="sub-desc">This Connection object.</div></li><li><code>response</code> : Object<div class="sub-desc">The XHR object containing the response data.\r
-See <a href="http://www.w3.org/TR/XMLHttpRequest/">The XMLHttpRequest Object</a>\r
+ <div class="mdesc"><div class="short">Fires if an error HTTP status was returned from the server.
+See <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-...</div><div class="long">Fires if an error HTTP status was returned from the server.
+See <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html">HTTP Status Code Definitions</a>
+for details of HTTP status codes.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>conn</code> : Connection<div class="sub-desc">This Connection object.</div></li><li><code>response</code> : Object<div class="sub-desc">The XHR object containing the response data.
+See <a href="http://www.w3.org/TR/XMLHttpRequest/">The XMLHttpRequest Object</a>
for details.</div></li><li><code>options</code> : Object<div class="sub-desc">The options config object passed to the <a href="output/Ext.data.Connection.html#Ext.data.Connection-request" ext:member="request" ext:cls="Ext.data.Connection">request</a> method.</div></li></ul></div></div></div></td><td class="msource">Connection</td></tr></tbody></table></div>
\ No newline at end of file
git.ithinksw.org / extjs.git / blobdiff