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_Ajax.js.html">Roo/Ajax.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>
114 <table cellspacing="0" class="member-table">
115 <caption>Config Options (Usually are also Properties)</caption>
119 <th class="sig-header" colspan="2">Options</th>
121 <th class="msource-header">Defined By</th>
128 <tr class="config-row expandable config-row-alt0 notInherited">
129 <td class="micon"><a class="exi" href="#expand"> </a></td>
132 <a id="Roo.Ajax-cfg-autoAbort" name=".autoAbort"></a>
133 <div class="fixedFont">
134 <b class="itemname">autoAbort</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
140 <div class="short">(Optional) Whether a new request should abort any pending requests.</div>
144 <div class="long">(Optional) Whether a new request should abort any pending requests. (defaults to false)</div>
158 <tr class="config-row expandable config-row-alt1 notInherited">
159 <td class="micon"><a class="exi" href="#expand"> </a></td>
162 <a id="Roo.Ajax-cfg-defaultHeaders" name=".defaultHeaders"></a>
163 <div class="fixedFont">
164 <b class="itemname">defaultHeaders</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
170 <div class="short">An object containing request headers which are added to each request made by this object.</div>
174 <div class="long">An object containing request headers which are added to each request made by this object. (defaults to undefined)</div>
188 <tr class="config-row expandable config-row-alt0 notInherited">
189 <td class="micon"><a class="exi" href="#expand"> </a></td>
192 <a id="Roo.Ajax-cfg-disableCaching" name=".disableCaching"></a>
193 <div class="fixedFont">
194 <b class="itemname">disableCaching</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
200 <div class="short">(Optional) True to add a unique cache-buster param to GET requests.</div>
204 <div class="long">(Optional) True to add a unique cache-buster param to GET requests. (defaults to true)</div>
218 <tr class="config-row expandable config-row-alt1 notInherited">
219 <td class="micon"><a class="exi" href="#expand"> </a></td>
222 <a id="Roo.Ajax-cfg-extraParams" name=".extraParams"></a>
223 <div class="fixedFont">
224 <b class="itemname">extraParams</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
230 <div class="short">An object containing properties which are used as extra parameters to each request made by this object.</div>
234 <div class="long">An object containing properties which are used as extra parameters to each request made by this object. (defaults to undefined)</div>
248 <tr class="config-row expandable config-row-alt0">
249 <td class="micon"><a class="exi" href="#expand"> </a></td>
252 <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
253 <div class="fixedFont">
254 <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
260 <div class="short">list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/> listeners : { <br/> 'click' : function(e) {<br/> .</div>
264 <div class="long">list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/> listeners : { <br/> 'click' : function(e) {<br/> ..... <br/> } ,<br/> .... <br/> } <br/> </code></pre></div>
272 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
278 <tr class="config-row expandable config-row-alt1 notInherited">
279 <td class="micon"><a class="exi" href="#expand"> </a></td>
282 <a id="Roo.Ajax-cfg-method" name=".method"></a>
283 <div class="fixedFont">
284 <b class="itemname">method</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
290 <div class="short">(Optional) The default HTTP method to be used for requests.</div>
294 <div class="long">(Optional) The default HTTP method to be used for requests. (defaults to undefined; if not set but parms are present will use POST, otherwise GET)</div>
308 <tr class="config-row expandable config-row-alt0 notInherited">
309 <td class="micon"><a class="exi" href="#expand"> </a></td>
312 <a id="Roo.Ajax-cfg-timeout" name=".timeout"></a>
313 <div class="fixedFont">
314 <b class="itemname">timeout</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
320 <div class="short">(Optional) The timeout in milliseconds to be used for requests.</div>
324 <div class="long">(Optional) The timeout in milliseconds to be used for requests. (defaults to 30000)</div>
338 <tr class="config-row expandable config-row-alt1 notInherited">
339 <td class="micon"><a class="exi" href="#expand"> </a></td>
342 <a id="Roo.Ajax-cfg-url" name=".url"></a>
343 <div class="fixedFont">
344 <b class="itemname">url</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
350 <div class="short">The default URL to be used for requests to the server.</div>
354 <div class="long">The default URL to be used for requests to the server. (defaults to undefined)</div>
378 <!-- ============================== public properties ==================== -->
382 <a id="Roo.Ajax-props"></a>
388 <table cellspacing="0" class="member-table">
389 <caption class="Empty">Public Properties - Has None</caption>
395 <!-- ============================== methods summary / details ======================== -->
398 <a id="Roo.Ajax-methods"></a>
399 <!-- constructor?? -->
406 <!-- then dynamics first -->
413 <table cellspacing="0" class="member-table">
414 <caption>Public Methods</caption>
416 <th class="sig-header" colspan="2">Method</th>
417 <th class="msource-header">Defined By</th>
427 <tr class="method-row config-row-alt0 expandable">
428 <td class="micon"><a class="exi" href="#expand"> </a></td>
432 <a id="Roo.data.Connection-method-abort" name=".abort"></a>
433 <div class="fixedFont">
434 <span class="attributes"></span><b class="itemname">abort</b>
436 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>transactionId</i></B>)
443 <div class="short">Aborts any outstanding request.</div>
449 Aborts any outstanding request.
456 <dl class="detailList">
457 <dt class="heading">Parameters:</dt>
460 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>transactionId</b>
463 <dd>(Optional) defaults to the last transaction</dd>
483 <a href="./Roo.data.Connection.html#constructor" roo:cls="Roo.data.Connection.html#constructor">Roo.data.Connection</a>
489 <tr class="method-row config-row-alt1 expandable">
490 <td class="micon"><a class="exi" href="#expand"> </a></td>
494 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
495 <div class="fixedFont">
496 <span class="attributes"></span><b class="itemname">addEvents</b>
498 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
505 <div class="short">Used to define events on this Observable</div>
511 Used to define events on this Observable
518 <dl class="detailList">
519 <dt class="heading">Parameters:</dt>
522 <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>
525 <dd>The object with the events defined</dd>
545 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
551 <tr class="method-row config-row-alt0 expandable">
552 <td class="micon"><a class="exi" href="#expand"> </a></td>
556 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
557 <div class="fixedFont">
558 <span class="attributes"></span><b class="itemname">addListener</b>
560 (<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>)
567 <div class="short">Appends an event handler to this component</div>
573 Appends an event handler to this component
580 <dl class="detailList">
581 <dt class="heading">Parameters:</dt>
584 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
587 <dd>The type of event to listen for</dd>
590 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
593 <dd>The method the event invokes</dd>
596 <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>
599 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
602 <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>
605 <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>
625 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
631 <tr class="method-row config-row-alt1 expandable">
632 <td class="micon"><a class="exi" href="#expand"> </a></td>
636 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
637 <div class="fixedFont">
638 <span class="attributes"></span><b class="itemname">fireEvent</b>
640 (<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>)
646 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
655 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
661 Fires the specified event with the passed parameters (minus the event name).
668 <dl class="detailList">
669 <dt class="heading">Parameters:</dt>
672 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
678 <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>
681 <dd>Variable number of parameters are passed to handlers</dd>
689 <dl class="detailList">
690 <dt class="heading">Returns:</dt>
692 <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>
708 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
714 <tr class="method-row config-row-alt0 expandable">
715 <td class="micon"><a class="exi" href="#expand"> </a></td>
719 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
720 <div class="fixedFont">
721 <span class="attributes"></span><b class="itemname">hasListener</b>
723 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
729 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
738 <div class="short">Checks to see if this object has any listeners for a specified event</div>
744 Checks to see if this object has any listeners for a specified event
751 <dl class="detailList">
752 <dt class="heading">Parameters:</dt>
755 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
758 <dd>The name of the event to check for</dd>
766 <dl class="detailList">
767 <dt class="heading">Returns:</dt>
769 <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>
785 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
791 <tr class="method-row config-row-alt1 expandable">
792 <td class="micon"><a class="exi" href="#expand"> </a></td>
796 <a id="Roo.data.Connection-method-isLoading" name=".isLoading"></a>
797 <div class="fixedFont">
798 <span class="attributes"></span><b class="itemname">isLoading</b>
800 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>transactionId</i></B>)
806 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
815 <div class="short">Determine whether this object has a request outstanding.</div>
821 Determine whether this object has a request outstanding.
828 <dl class="detailList">
829 <dt class="heading">Parameters:</dt>
832 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>transactionId</b>
835 <dd>(Optional) defaults to the last transaction</dd>
843 <dl class="detailList">
844 <dt class="heading">Returns:</dt>
846 <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>
862 <a href="./Roo.data.Connection.html#constructor" roo:cls="Roo.data.Connection.html#constructor">Roo.data.Connection</a>
868 <tr class="method-row config-row-alt0 expandable">
869 <td class="micon"><a class="exi" href="#expand"> </a></td>
873 <a id="Roo.util.Observable-method-on" name=".on"></a>
874 <div class="fixedFont">
875 <span class="attributes"></span><b class="itemname">on</b>
877 (<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>)
884 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
890 Appends an event handler to this element (shorthand for addListener)
897 <dl class="detailList">
898 <dt class="heading">Parameters:</dt>
901 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
904 <dd>The type of event to listen for</dd>
907 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
910 <dd>The method the event invokes</dd>
913 <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>
916 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
919 <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>
942 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
948 <tr class="method-row config-row-alt1 expandable">
949 <td class="micon"><a class="exi" href="#expand"> </a></td>
953 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
954 <div class="fixedFont">
955 <span class="attributes"></span><b class="itemname">purgeListeners</b>
964 <div class="short">Removes all listeners for this object</div>
970 Removes all listeners for this object
993 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
999 <tr class="method-row config-row-alt0 expandable">
1000 <td class="micon"><a class="exi" href="#expand"> </a></td>
1004 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
1005 <div class="fixedFont">
1006 <span class="attributes"></span><b class="itemname">removeListener</b>
1008 (<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>)
1015 <div class="short">Removes a listener</div>
1028 <dl class="detailList">
1029 <dt class="heading">Parameters:</dt>
1032 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1035 <dd>The type of event to listen for</dd>
1038 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1041 <dd>The handler to remove</dd>
1044 <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>
1047 <dd>(optional) The scope (this object) for the handler</dd>
1065 <td class="msource">
1067 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1073 <tr class="method-row config-row-alt1 expandable">
1074 <td class="micon"><a class="exi" href="#expand"> </a></td>
1078 <a id="Roo.data.Connection-method-request" name=".request"></a>
1079 <div class="fixedFont">
1080 <span class="attributes"></span><b class="itemname">request</b>
1082 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
1088 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
1097 <div class="short">Sends an HTTP request to a remote server.</div>
1103 Sends an HTTP request to a remote server.
1110 <dl class="detailList">
1111 <dt class="heading">Parameters:</dt>
1114 <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>
1117 <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>
1125 <dl class="detailList">
1126 <dt class="heading">Returns:</dt>
1128 <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> transactionId</dd>
1142 <td class="msource">
1144 <a href="./Roo.data.Connection.html#constructor" roo:cls="Roo.data.Connection.html#constructor">Roo.data.Connection</a>
1150 <tr class="method-row config-row-alt0 expandable">
1151 <td class="micon"><a class="exi" href="#expand"> </a></td>
1155 <a id="Roo.util.Observable-method-un" name=".un"></a>
1156 <div class="fixedFont">
1157 <span class="attributes"></span><b class="itemname">un</b>
1159 (<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>)
1166 <div class="short">Removes a listener (shorthand for removeListener)</div>
1172 Removes a listener (shorthand for removeListener)
1179 <dl class="detailList">
1180 <dt class="heading">Parameters:</dt>
1183 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1186 <dd>The type of event to listen for</dd>
1189 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1192 <dd>The handler to remove</dd>
1195 <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>
1198 <dd>(optional) The scope (this object) for the handler</dd>
1216 <td class="msource">
1218 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1227 <!-- ============================== events summary / details ======================== -->
1230 <a id="Roo.Ajax-events"></a>
1239 <table cellspacing="0" class="member-table">
1240 <caption>Events</caption>
1243 <th class="sig-header" colspan="2">Event</th>
1244 <th class="msource-header">Defined By</th>
1253 <tr class="method-row expandable config-row-alt0">
1254 <td class="micon"><a class="exi" href="#expand"> </a></td>
1257 <a id="Roo.data.Connection-event-*beforerequest"></a>
1259 <div class="fixedFont">
1260 <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>)
1266 <div class="short">Fires before a network request is made to retrieve a data object.
1272 Fires before a network request is made to retrieve a data object.
1278 <dl class="detailList">
1279 <dt class="heading">Parameters:</dt>
1282 <span class="fixedFont">Connection</span> <b>conn</b>
1285 <dd>This Connection object.</dd>
1288 <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>
1291 <dd>The options config object passed to the {<b>link</b> <b>request</b>} method.</dd>
1309 <td class="msource">
1310 <a href="./Roo.data.Connection.html#constructor" roo:cls="Roo.data.Connection.html#constructor">Roo.data.Connection</a>
1314 <tr class="method-row expandable config-row-alt1">
1315 <td class="micon"><a class="exi" href="#expand"> </a></td>
1318 <a id="Roo.data.Connection-event-*requestcomplete"></a>
1320 <div class="fixedFont">
1321 <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>)
1327 <div class="short">Fires if the request was successfully completed.
1333 Fires if the request was successfully completed.
1339 <dl class="detailList">
1340 <dt class="heading">Parameters:</dt>
1343 <span class="fixedFont">Connection</span> <b>conn</b>
1346 <dd>This Connection object.</dd>
1349 <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>
1352 <dd>The XHR object containing the response data.<br/>See {<b>link</b> http://www.w3.org/TR/XMLHttpRequest/} for details.</dd>
1355 <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>
1358 <dd>The options config object passed to the {<b>link</b> <b>request</b>} method.</dd>
1376 <td class="msource">
1377 <a href="./Roo.data.Connection.html#constructor" roo:cls="Roo.data.Connection.html#constructor">Roo.data.Connection</a>
1381 <tr class="method-row expandable config-row-alt0">
1382 <td class="micon"><a class="exi" href="#expand"> </a></td>
1385 <a id="Roo.data.Connection-event-*requestexception"></a>
1387 <div class="fixedFont">
1388 <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>)
1394 <div class="short">Fires if an error HTTP status was returned from the server.
1400 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.
1406 <dl class="detailList">
1407 <dt class="heading">Parameters:</dt>
1410 <span class="fixedFont">Connection</span> <b>conn</b>
1413 <dd>This Connection object.</dd>
1416 <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>
1419 <dd>The XHR object containing the response data.<br/>See {<b>link</b> http://www.w3.org/TR/XMLHttpRequest/} for details.</dd>
1422 <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>
1425 <dd>The options config object passed to the {<b>link</b> <b>request</b>} method.</dd>
1443 <td class="msource">
1444 <a href="./Roo.data.Connection.html#constructor" roo:cls="Roo.data.Connection.html#constructor">Roo.data.Connection</a>
1455 <!-- ============================== footer ================================= -->
1456 <div class="fineprint" style="clear:both">
1458 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Thu Mar 20 2014 19:25:15 GMT+0800 (HKT)
1460 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>