1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <meta http-equiv="content-type" content="text/html; charset=undefined" />
8 <meta name="generator" content="JsDoc Toolkit" />
11 <title>JsDoc Reference - Roo.Ajax</title>
14 <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
15 <link rel="stylesheet" type="text/css" href="../default.css" />
18 <script type="text/javascript" src="../page.js">
25 <body onload="RooDocsPage.onload();">
28 <div class="body-wrap">
30 <!-- ============================== links to methods. ================================= -->
32 <div class="top-tools">
34 <a class="inner-link" href="#Roo.Ajax-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.Ajax-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.Ajax-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.Ajax-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
38 <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
43 <!-- ============================== inheritance Block. ================================= -->
45 <div class="inheritance res-block">
46 <pre class="res-block-inner"><a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
47 <img src="../../images/default/s.gif" height="1" width="20"/><img src="../../images/default/tree/elbow-end.gif" class="elbow"/><a href="./Roo.data.Connection.html#constructor" roo:cls="Roo.data.Connection.html#constructor">Roo.data.Connection</a>
48 <img src="../../images/default/s.gif" height="1" width="40"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.Ajax
53 <!-- ============================== class title / details ============================ -->
56 <h1 class="classTitle">
61 <table cellspacing="0" class="class-summary-table">
63 <tr><td class="label">Package:</td><td class="hd-info">Roo</td></tr>
65 <tr><td class="label">Defined In:</td><td class="hd-info">
67 <a href="./src/Roo_data_Connection.js.html">Roo/data/Connection.js</a>.
70 <tr><td class="label">Class:</td><td class="hd-info">Ajax</td></tr>
75 <tr><td class="label">Extends:</td><td class="hd-info">
76 <a href="./Roo.data.Connection.html#constructor" roo:cls="Roo.data.Connection.html#constructor">Roo.data.Connection</a>
84 <!-- ============================== class summary ========================== -->
85 <div class="description">
86 Global Ajax request class.
90 <!-- ============================== Class comment block... ========================== -->
92 <div class="comments">
93 <b>Class Comments / Notes</B> =>
94 <u onclick="parent.CommentDialog.showCommentId = 'Roo.Ajax';">[Add Your comment/notes about this class]</u>
96 <iframe frameborder="0" id="comments-Roo" style="border: none;width:100%;"
97 src="/blog.php/GtkDjsComments/Roo.Ajax.html"></iframe>
102 <!-- ============================== config options ========================== -->
107 <div class="hr"></div>
108 <a id="Roo.Ajax-configs"></a>
112 <table cellspacing="0" class="member-table">
113 <caption class="Empty">Config Options - Has None</caption>
127 <!-- ============================== public properties ==================== -->
131 <a id="Roo.Ajax-props"></a>
139 <table cellspacing="0" class="member-table">
140 <caption>Public Properties </caption>
142 <th class="sig-header" colspan="2">Property</th>
143 <th class="sig-header">Description</th>
144 <th class="msource-header">Defined By</th>
154 <tr class="property-row config-row-alt0 notInherited">
156 <a class="exi" href="#expand"> </a>
159 <a id="Roo.Ajax-prop-autoAbort" name=".autoAbort"></a>
160 <div class="fixedFont">
161 <span class="attributes">Roo.Ajax.</span><b class="itemname">autoAbort</b> :
162 <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
170 Whether a new request should abort any pending requests.
178 Whether a new request should abort any pending requests. (defaults to false)
193 <tr class="property-row config-row-alt1 notInherited">
195 <a class="exi" href="#expand"> </a>
198 <a id="Roo.Ajax-prop-defaultHeaders" name=".defaultHeaders"></a>
199 <div class="fixedFont">
200 <span class="attributes">Roo.Ajax.</span><b class="itemname">defaultHeaders</b> :
201 <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>
209 An object containing request headers which are added to each request made by this object.
217 An object containing request headers which are added to each request made by this object. (defaults to undefined)
232 <tr class="property-row config-row-alt0 notInherited">
234 <a class="exi" href="#expand"> </a>
237 <a id="Roo.Ajax-prop-disableCaching" name=".disableCaching"></a>
238 <div class="fixedFont">
239 <span class="attributes">Roo.Ajax.</span><b class="itemname">disableCaching</b> :
240 <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>
248 True to add a unique cache-buster param to GET requests.
256 True to add a unique cache-buster param to GET requests. (defaults to true)
271 <tr class="property-row config-row-alt1 notInherited">
273 <a class="exi" href="#expand"> </a>
276 <a id="Roo.Ajax-prop-extraParams" name=".extraParams"></a>
277 <div class="fixedFont">
278 <span class="attributes">Roo.Ajax.</span><b class="itemname">extraParams</b> :
279 <span type="etype"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>
287 An object containing properties which are used as<br/>extra parameters to each request made by this object.
295 An object containing properties which are used as<br/>extra parameters to each request made by this object. (defaults to undefined)
310 <tr class="property-row config-row-alt0 notInherited">
312 <a class="exi" href="#expand"> </a>
315 <a id="Roo.Ajax-prop-method" name=".method"></a>
316 <div class="fixedFont">
317 <span class="attributes">Roo.Ajax.</span><b class="itemname">method</b> :
318 <span type="etype"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>
326 The default HTTP method to be used for requests.
334 The default HTTP method to be used for requests. (defaults to undefined; if not set but parms are present will use POST, otherwise GET)
349 <tr class="property-row config-row-alt1 notInherited">
351 <a class="exi" href="#expand"> </a>
354 <a id="Roo.Ajax-prop-timeout" name=".timeout"></a>
355 <div class="fixedFont">
356 <span class="attributes">Roo.Ajax.</span><b class="itemname">timeout</b> :
357 <span type="etype"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>
365 The timeout in milliseconds to be used for requests.
373 The timeout in milliseconds to be used for requests. (defaults to 30000)
388 <tr class="property-row config-row-alt0 notInherited">
390 <a class="exi" href="#expand"> </a>
393 <a id="Roo.Ajax-prop-url" name=".url"></a>
394 <div class="fixedFont">
395 <span class="attributes">Roo.Ajax.</span><b class="itemname">url</b> :
396 <span type="etype"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>
404 The default URL to be used for requests to the server.
412 The default URL to be used for requests to the server. (defaults to undefined)
428 <!-- TODO: implement this alt row. also notice non-linked "Defined by" when property is a part of this class.
429 <tr class="property-row alt">
436 <!-- ============================== methods summary / details ======================== -->
439 <a id="Roo.Ajax-methods"></a>
440 <!-- constructor?? -->
447 <!-- then dynamics first -->
454 <table cellspacing="0" class="member-table">
455 <caption>Public Methods</caption>
457 <th class="sig-header" colspan="2">Method</th>
458 <th class="msource-header">Defined By</th>
468 <tr class="method-row config-row-alt0 expandable">
469 <td class="micon"><a class="exi" href="#expand"> </a></td>
473 <a id="Roo.data.Connection-method-abort" name=".abort"></a>
474 <div class="fixedFont">
475 <span class="attributes">Roo.Ajax.</span><b class="itemname">abort</b>
477 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>transactionId</i></B>)
484 <div class="short">Aborts any outstanding request.</div>
490 Aborts any outstanding request.
497 <dl class="detailList">
498 <dt class="heading">Parameters:</dt>
501 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>transactionId</b>
504 <dd>(Optional) defaults to the last transaction</dd>
524 <a href="./Roo.data.Connection.html#constructor" roo:cls="Roo.data.Connection.html#constructor">Roo.data.Connection</a>
530 <tr class="method-row config-row-alt1 expandable">
531 <td class="micon"><a class="exi" href="#expand"> </a></td>
535 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
536 <div class="fixedFont">
537 <span class="attributes">Roo.Ajax.</span><b class="itemname">addEvents</b>
539 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
546 <div class="short">Used to define events on this Observable</div>
552 Used to define events on this Observable
559 <dl class="detailList">
560 <dt class="heading">Parameters:</dt>
563 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>object</b>
566 <dd>The object with the events defined</dd>
586 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
592 <tr class="method-row config-row-alt0 expandable">
593 <td class="micon"><a class="exi" href="#expand"> </a></td>
597 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
598 <div class="fixedFont">
599 <span class="attributes">Roo.Ajax.</span><b class="itemname">addListener</b>
601 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
608 <div class="short">Appends an event handler to this component</div>
614 Appends an event handler to this component
621 <dl class="detailList">
622 <dt class="heading">Parameters:</dt>
625 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
628 <dd>The type of event to listen for</dd>
631 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
634 <dd>The method the event invokes</dd>
637 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
640 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
643 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>options</b>
646 <dd>(optional) An object containing handler configuration<br/>properties. This may contain any of the following properties:<ul><br/><li>scope {Object} The scope in which to execute the handler function. The handler function's "this" context.</li><br/><li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li><br/><li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li><br/><li>buffer {Number} Causes the handler to be scheduled to run in an {<b>link</b> Roo.util.DelayedTask} delayed<br/>by the specified number of milliseconds. If the event fires again within that time, the original<br/>handler is <em>not</em> invoked, but the new handler is scheduled in its place.</li><br/></ul><br><br/><p><br/><b>Combining Options</b><br><br/>Using the options argument, it is possible to combine different types of listeners:<br><br/><br><br/>A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)<br/> <pre><code><br/> el.on('click', this.onClick, this, {<br/> single: true,<br/> delay: 100,<br/> forumId: 4<br/> });<br/> </code></pre><br/><p><br/><b>Attaching multiple handlers in 1 call</b><br><br/>The method also allows for a single argument to be passed which is a config object containing properties<br/>which specify multiple handlers.<br/><pre><code><br/> el.on({<br/> 'click': {<br/> fn: this.onClick,<br/> scope: this,<br/> delay: 100<br/> }, <br/> 'mouseover': {<br/> fn: this.onMouseOver,<br/> scope: this<br/> },<br/> 'mouseout': {<br/> fn: this.onMouseOut,<br/> scope: this<br/> }<br/> });<br/> </code></pre><br/><p><br/>Or a shorthand syntax which passes the same scope object to all handlers:<br/> <pre><code><br/> el.on({<br/> 'click': this.onClick,<br/> 'mouseover': this.onMouseOver,<br/> 'mouseout': this.onMouseOut,<br/> scope: this<br/> });<br/> </code></pre></dd>
666 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
672 <tr class="method-row config-row-alt1 expandable">
673 <td class="micon"><a class="exi" href="#expand"> </a></td>
677 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
678 <div class="fixedFont">
679 <span class="attributes">Roo.Ajax.</span><b class="itemname">fireEvent</b>
681 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a> <B><i>args</i></B>)
687 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
696 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
702 Fires the specified event with the passed parameters (minus the event name).
709 <dl class="detailList">
710 <dt class="heading">Parameters:</dt>
713 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
719 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a></span> <b>args</b>
722 <dd>Variable number of parameters are passed to handlers</dd>
730 <dl class="detailList">
731 <dt class="heading">Returns:</dt>
733 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> returns false if any of the handlers return false otherwise it returns true</dd>
749 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
755 <tr class="method-row config-row-alt0 expandable">
756 <td class="micon"><a class="exi" href="#expand"> </a></td>
760 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
761 <div class="fixedFont">
762 <span class="attributes">Roo.Ajax.</span><b class="itemname">hasListener</b>
764 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
770 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
779 <div class="short">Checks to see if this object has any listeners for a specified event</div>
785 Checks to see if this object has any listeners for a specified event
792 <dl class="detailList">
793 <dt class="heading">Parameters:</dt>
796 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
799 <dd>The name of the event to check for</dd>
807 <dl class="detailList">
808 <dt class="heading">Returns:</dt>
810 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> True if the event is being listened for, else false</dd>
826 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
832 <tr class="method-row config-row-alt1 expandable">
833 <td class="micon"><a class="exi" href="#expand"> </a></td>
837 <a id="Roo.data.Connection-method-isLoading" name=".isLoading"></a>
838 <div class="fixedFont">
839 <span class="attributes">Roo.Ajax.</span><b class="itemname">isLoading</b>
841 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>transactionId</i></B>)
847 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
856 <div class="short">Determine whether this object has a request outstanding.</div>
862 Determine whether this object has a request outstanding.
869 <dl class="detailList">
870 <dt class="heading">Parameters:</dt>
873 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>transactionId</b>
876 <dd>(Optional) defaults to the last transaction</dd>
884 <dl class="detailList">
885 <dt class="heading">Returns:</dt>
887 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> True if there is an outstanding request.</dd>
903 <a href="./Roo.data.Connection.html#constructor" roo:cls="Roo.data.Connection.html#constructor">Roo.data.Connection</a>
909 <tr class="method-row config-row-alt0 expandable">
910 <td class="micon"><a class="exi" href="#expand"> </a></td>
914 <a id="Roo.util.Observable-method-on" name=".on"></a>
915 <div class="fixedFont">
916 <span class="attributes">Roo.Ajax.</span><b class="itemname">on</b>
918 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
925 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
931 Appends an event handler to this element (shorthand for addListener)
938 <dl class="detailList">
939 <dt class="heading">Parameters:</dt>
942 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
945 <dd>The type of event to listen for</dd>
948 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
951 <dd>The method the event invokes</dd>
954 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
957 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
960 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>options</b>
983 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
989 <tr class="method-row config-row-alt1 expandable">
990 <td class="micon"><a class="exi" href="#expand"> </a></td>
994 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
995 <div class="fixedFont">
996 <span class="attributes">Roo.Ajax.</span><b class="itemname">purgeListeners</b>
1005 <div class="short">Removes all listeners for this object</div>
1011 Removes all listeners for this object
1032 <td class="msource">
1034 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1040 <tr class="method-row config-row-alt0 expandable">
1041 <td class="micon"><a class="exi" href="#expand"> </a></td>
1045 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
1046 <div class="fixedFont">
1047 <span class="attributes">Roo.Ajax.</span><b class="itemname">removeListener</b>
1049 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
1056 <div class="short">Removes a listener</div>
1069 <dl class="detailList">
1070 <dt class="heading">Parameters:</dt>
1073 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1076 <dd>The type of event to listen for</dd>
1079 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1082 <dd>The handler to remove</dd>
1085 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
1088 <dd>(optional) The scope (this object) for the handler</dd>
1106 <td class="msource">
1108 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1114 <tr class="method-row config-row-alt1 expandable">
1115 <td class="micon"><a class="exi" href="#expand"> </a></td>
1119 <a id="Roo.data.Connection-method-request" name=".request"></a>
1120 <div class="fixedFont">
1121 <span class="attributes">Roo.Ajax.</span><b class="itemname">request</b>
1123 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
1129 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
1138 <div class="short">Sends an HTTP request to a remote server.</div>
1144 Sends an HTTP request to a remote server.
1151 <dl class="detailList">
1152 <dt class="heading">Parameters:</dt>
1155 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>options</b>
1158 <dd>An object which may contain the following properties:<ul><br/><li><b>url</b> {String} (Optional) The URL to which to send the request. Defaults to configured URL</li><br/><li><b>params</b> {Object/String/Function} (Optional) An object containing properties which are used as parameters to the<br/>request, a url encoded string or a function to call to get either.</li><br/><li><b>method</b> {String} (Optional) The HTTP method to use for the request. Defaults to the configured method, or<br/>if no method was configured, "GET" if no parameters are being sent, and "POST" if parameters are being sent.</li><br/><li><b>callback</b> {Function} (Optional) The function to be called upon receipt of the HTTP response.<br/>The callback is called regardless of success or failure and is passed the following parameters:<ul><br/><li>options {Object} The parameter to the request call.</li><br/><li>success {Boolean} True if the request succeeded.</li><br/><li>response {Object} The XMLHttpRequest object containing the response data.</li><br/></ul></li><br/><li><b>success</b> {Function} (Optional) The function to be called upon success of the request.<br/>The callback is passed the following parameters:<ul><br/><li>response {Object} The XMLHttpRequest object containing the response data.</li><br/><li>options {Object} The parameter to the request call.</li><br/></ul></li><br/><li><b>failure</b> {Function} (Optional) The function to be called upon failure of the request.<br/>The callback is passed the following parameters:<ul><br/><li>response {Object} The XMLHttpRequest object containing the response data.</li><br/><li>options {Object} The parameter to the request call.</li><br/></ul></li><br/><li><b>scope</b> {Object} (Optional) The scope in which to execute the callbacks: The "this" object<br/>for the callback function. Defaults to the browser window.</li><br/><li><b>form</b> {Object/String} (Optional) A form object or id to pull parameters from.</li><br/><li><b>isUpload</b> {Boolean} (Optional) True if the form object is a file upload (will usually be automatically detected).</li><br/><li><b>headers</b> {Object} (Optional) Request headers to set for the request.</li><br/><li><b>xmlData</b> {Object} (Optional) XML document to use for the post. Note: This will be used instead of<br/>params for the post data. Any params will be appended to the URL.</li><br/><li><b>disableCaching</b> {Boolean} (Optional) True to add a unique cache-buster param to GET requests.</li><br/></ul></dd>
1166 <dl class="detailList">
1167 <dt class="heading">Returns:</dt>
1169 <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> transactionId</dd>
1183 <td class="msource">
1185 <a href="./Roo.data.Connection.html#constructor" roo:cls="Roo.data.Connection.html#constructor">Roo.data.Connection</a>
1191 <tr class="method-row config-row-alt0 expandable notInherited">
1192 <td class="micon"><a class="exi" href="#expand"> </a></td>
1196 <a id="Roo.Ajax-method-serializeForm" name=".serializeForm"></a>
1197 <div class="fixedFont">
1198 <span class="attributes">Roo.Ajax.</span><b class="itemname">serializeForm</b>
1200 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement <B><i>form</i></B>)
1206 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1215 <div class="short">Serialize the passed form into a url encoded string</div>
1221 Serialize the passed form into a url encoded string
1228 <dl class="detailList">
1229 <dt class="heading">Parameters:</dt>
1232 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement</span> <b>form</b>
1243 <dl class="detailList">
1244 <dt class="heading">Returns:</dt>
1246 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> </dd>
1260 <td class="msource">
1268 <tr class="method-row config-row-alt1 expandable">
1269 <td class="micon"><a class="exi" href="#expand"> </a></td>
1273 <a id="Roo.util.Observable-method-un" name=".un"></a>
1274 <div class="fixedFont">
1275 <span class="attributes">Roo.Ajax.</span><b class="itemname">un</b>
1277 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
1284 <div class="short">Removes a listener (shorthand for removeListener)</div>
1290 Removes a listener (shorthand for removeListener)
1297 <dl class="detailList">
1298 <dt class="heading">Parameters:</dt>
1301 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1304 <dd>The type of event to listen for</dd>
1307 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1310 <dd>The handler to remove</dd>
1313 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
1316 <dd>(optional) The scope (this object) for the handler</dd>
1334 <td class="msource">
1336 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1345 <!-- ============================== events summary / details ======================== -->
1348 <a id="Roo.Ajax-events"></a>
1357 <table cellspacing="0" class="member-table">
1358 <caption>Events</caption>
1361 <th class="sig-header" colspan="2">Event</th>
1362 <th class="msource-header">Defined By</th>
1371 <tr class="method-row expandable config-row-alt0">
1372 <td class="micon"><a class="exi" href="#expand"> </a></td>
1375 <a id="Roo.data.Connection-event-*beforerequest"></a>
1377 <div class="fixedFont">
1378 <b class="itemname">beforerequest</b> (Connection <B><i>conn</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
1384 <div class="short">Fires before a network request is made to retrieve a data object.
1390 Fires before a network request is made to retrieve a data object.
1396 <dl class="detailList">
1397 <dt class="heading">Parameters:</dt>
1400 <span class="fixedFont">Connection</span> <b>conn</b>
1403 <dd>This Connection object.</dd>
1406 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>options</b>
1409 <dd>The options config object passed to the {<b>link</b> <b>request</b>} method.</dd>
1427 <td class="msource">
1428 <a href="./Roo.data.Connection.html#constructor" roo:cls="Roo.data.Connection.html#constructor">Roo.data.Connection</a>
1432 <tr class="method-row expandable config-row-alt1">
1433 <td class="micon"><a class="exi" href="#expand"> </a></td>
1436 <a id="Roo.data.Connection-event-*requestcomplete"></a>
1438 <div class="fixedFont">
1439 <b class="itemname">requestcomplete</b> (Connection <B><i>conn</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>response</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
1445 <div class="short">Fires if the request was successfully completed.
1451 Fires if the request was successfully completed.
1457 <dl class="detailList">
1458 <dt class="heading">Parameters:</dt>
1461 <span class="fixedFont">Connection</span> <b>conn</b>
1464 <dd>This Connection object.</dd>
1467 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>response</b>
1470 <dd>The XHR object containing the response data.<br/>See {<b>link</b> http://www.w3.org/TR/XMLHttpRequest/} for details.</dd>
1473 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>options</b>
1476 <dd>The options config object passed to the {<b>link</b> <b>request</b>} method.</dd>
1494 <td class="msource">
1495 <a href="./Roo.data.Connection.html#constructor" roo:cls="Roo.data.Connection.html#constructor">Roo.data.Connection</a>
1499 <tr class="method-row expandable config-row-alt0">
1500 <td class="micon"><a class="exi" href="#expand"> </a></td>
1503 <a id="Roo.data.Connection-event-*requestexception"></a>
1505 <div class="fixedFont">
1506 <b class="itemname">requestexception</b> (Connection <B><i>conn</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>response</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
1512 <div class="short">Fires if an error HTTP status was returned from the server.
1518 Fires if an error HTTP status was returned from the server.<br/>See {<b>link</b> http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html} for details of HTTP status codes.
1524 <dl class="detailList">
1525 <dt class="heading">Parameters:</dt>
1528 <span class="fixedFont">Connection</span> <b>conn</b>
1531 <dd>This Connection object.</dd>
1534 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>response</b>
1537 <dd>The XHR object containing the response data.<br/>See {<b>link</b> http://www.w3.org/TR/XMLHttpRequest/} for details.</dd>
1540 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>options</b>
1543 <dd>The options config object passed to the {<b>link</b> <b>request</b>} method.</dd>
1561 <td class="msource">
1562 <a href="./Roo.data.Connection.html#constructor" roo:cls="Roo.data.Connection.html#constructor">Roo.data.Connection</a>
1573 <!-- ============================== footer ================================= -->
1574 <div class="fineprint" style="clear:both">
1576 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Thu Feb 10 2011 17:59:17 GMT+0800 (HKT)
1578 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>