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.data.HttpProxy</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.data.HttpProxy-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.data.HttpProxy-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.data.HttpProxy-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.data.HttpProxy-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.data.DataProxy.html#constructor" roo:cls="Roo.data.DataProxy.html#constructor">Roo.data.DataProxy</a>
47 <img src="../../images/default/s.gif" height="1" width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.data.HttpProxy
52 <!-- ============================== class title / details ============================ -->
55 <h1 class="classTitle">
57 Class Roo.data.HttpProxy
60 <table cellspacing="0" class="class-summary-table">
62 <tr><td class="label">Package:</td><td class="hd-info">Roo.data</td></tr>
64 <tr><td class="label">Defined In:</td><td class="hd-info">
66 <a href="./src/Roo_data_HttpProxy.js.html">Roo/data/HttpProxy.js</a>.
69 <tr><td class="label">Class:</td><td class="hd-info">HttpProxy</td></tr>
74 <tr><td class="label">Extends:</td><td class="hd-info">
75 <a href="./Roo.data.DataProxy.html#constructor" roo:cls="Roo.data.DataProxy.html#constructor">Roo.data.DataProxy</a>
83 <!-- ============================== class summary ========================== -->
84 <div class="description">
85 An implementation of {<b>link</b> Roo.data.DataProxy} that reads a data object from an {<b>link</b> Roo.data.Connection} object<br/>configured to reference a certain URL.<br><br><br/><p><br/><em>Note that this class cannot be used to retrieve data from a domain other than the domain<br/>from which the running page was served.<br><br><br/><p><br/>For cross-domain access to remote data, use an {<b>link</b> Roo.data.ScriptTagProxy}.</em><br><br><br/><p><br/>Be aware that to enable the browser to parse an XML document, the server must set<br/>the Content-Type header in the HTTP response to "text/xml".
89 <!-- ============================== Class comment block... ========================== -->
91 <div class="comments">
92 <b>Class Comments / Notes</B> =>
93 <u onclick="parent.CommentDialog.showCommentId = 'Roo.data.HttpProxy';">[Add Your comment/notes about this class]</u>
95 <iframe frameborder="0" id="comments-Roo.data" style="border: none;width:100%;"
96 src="/blog.php/GtkDjsComments/Roo.data.HttpProxy.html"></iframe>
101 <!-- ============================== config options ========================== -->
106 <div class="hr"></div>
107 <a id="Roo.data.HttpProxy-configs"></a>
113 <table cellspacing="0" class="member-table">
114 <caption>Config Options (Usually are also Properties)</caption>
118 <th class="sig-header" colspan="2">Options</th>
120 <th class="msource-header">Defined By</th>
127 <tr class="config-row expandable config-row-alt0 notInherited">
128 <td class="micon"><a class="exi" href="#expand"> </a></td>
131 <a id="Roo.data.HttpProxy-cfg-autoAbort" name=".autoAbort"></a>
132 <div class="fixedFont">
133 <b class="itemname">autoAbort</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
139 <div class="short">(Optional) Whether this request should abort any pending requests.</div>
143 <div class="long">(Optional) Whether this request should abort any pending requests. (defaults to false)</div>
157 <tr class="config-row expandable config-row-alt1 notInherited">
158 <td class="micon"><a class="exi" href="#expand"> </a></td>
161 <a id="Roo.data.HttpProxy-cfg-defaultHeaders" name=".defaultHeaders"></a>
162 <div class="fixedFont">
163 <b class="itemname">defaultHeaders</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
169 <div class="short">(Optional) An object containing request headers which are added<br/> to each request made by this object.</div>
173 <div class="long">(Optional) An object containing request headers which are added<br/> to each request made by this object. (defaults to undefined)</div>
187 <tr class="config-row expandable config-row-alt0 notInherited">
188 <td class="micon"><a class="exi" href="#expand"> </a></td>
191 <a id="Roo.data.HttpProxy-cfg-disableCaching" name=".disableCaching"></a>
192 <div class="fixedFont">
193 <b class="itemname">disableCaching</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
199 <div class="short">(Optional) True to add a unique cache-buster param to GET requests.</div>
203 <div class="long">(Optional) True to add a unique cache-buster param to GET requests. (defaults to true)</div>
217 <tr class="config-row expandable config-row-alt1 notInherited">
218 <td class="micon"><a class="exi" href="#expand"> </a></td>
221 <a id="Roo.data.HttpProxy-cfg-extraParams" name=".extraParams"></a>
222 <div class="fixedFont">
223 <b class="itemname">extraParams</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
229 <div class="short">(Optional) An object containing properties which are used as<br/>extra parameters to each request made by this object.</div>
233 <div class="long">(Optional) An object containing properties which are used as<br/>extra parameters to each request made by this object. (defaults to undefined)</div>
247 <tr class="config-row expandable config-row-alt0 notInherited">
248 <td class="micon"><a class="exi" href="#expand"> </a></td>
251 <a id="Roo.data.HttpProxy-cfg-method" name=".method"></a>
252 <div class="fixedFont">
253 <b class="itemname">method</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
259 <div class="short">(Optional) The default HTTP method to be used for requests.</div>
263 <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>
277 <tr class="config-row expandable config-row-alt1 notInherited">
278 <td class="micon"><a class="exi" href="#expand"> </a></td>
281 <a id="Roo.data.HttpProxy-cfg-timeout" name=".timeout"></a>
282 <div class="fixedFont">
283 <b class="itemname">timeout</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
289 <div class="short">(Optional) The timeout in milliseconds to be used for requests.</div>
293 <div class="long">(Optional) The timeout in milliseconds to be used for requests. (defaults to 30000)</div>
307 <tr class="config-row expandable config-row-alt0 notInherited">
308 <td class="micon"><a class="exi" href="#expand"> </a></td>
311 <a id="Roo.data.HttpProxy-cfg-url" name=".url"></a>
312 <div class="fixedFont">
313 <b class="itemname">url</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
319 <div class="short">(Optional) The default URL to be used for requests to the server.</div>
323 <div class="long">(Optional) The default URL to be used for requests to the server. (defaults to undefined)</div>
347 <!-- ============================== public properties ==================== -->
351 <a id="Roo.data.HttpProxy-props"></a>
357 <table cellspacing="0" class="member-table">
358 <caption class="Empty">Public Properties - Has None</caption>
364 <!-- ============================== methods summary / details ======================== -->
367 <a id="Roo.data.HttpProxy-methods"></a>
368 <!-- constructor?? -->
375 <!-- then dynamics first -->
382 <table cellspacing="0" class="member-table">
383 <caption>Public Methods</caption>
385 <th class="sig-header" colspan="2">Method</th>
386 <th class="msource-header">Defined By</th>
396 <tr class="method-row config-row-alt0 expandable notInherited">
397 <td class="micon"><a class="exi" href="#expand"> </a></td>
401 <a id="Roo.data-method-HttpProxy" name=".HttpProxy"></a>
402 <div class="fixedFont">
403 <span class="attributes">new <B>Roo.data.</B></span><b class="itemname">HttpProxy</b>
405 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>conn</i></B>)
413 <div class="short">Create a new Roo.data.HttpProxy</div>
420 Create a new Roo.data.HttpProxy
423 <dl class="detailList">
424 <dt class="heading">Parameters:</dt>
427 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>conn</b>
430 <dd>Connection config options to add to each request (e.g. {url: 'foo.php'} or<br/>an {<b>link</b> Roo.data.Connection} object. If a Connection config is passed, the singleton {<b>link</b> Roo.Ajax} object<br/>will be used to make the request.</dd>
454 <tr class="method-row config-row-alt1 expandable notInherited">
455 <td class="micon"><a class="exi" href="#expand"> </a></td>
459 <a id="Roo.data.HttpProxy-method-getConnection" name=".getConnection"></a>
460 <div class="fixedFont">
461 <span class="attributes"></span><b class="itemname">getConnection</b>
478 <div class="short">Return the {<b>link</b> Roo.data.Connection} object being used by this Proxy.</div>
484 Return the {<b>link</b> Roo.data.Connection} object being used by this Proxy.
495 <dl class="detailList">
496 <dt class="heading">Returns:</dt>
498 <dd><span class="fixedFont">Connection</span> The Connection object. This object may be used to subscribe to events on<br/>a finer-grained basis than the DataProxy events.</dd>
520 <tr class="method-row config-row-alt0 expandable notInherited">
521 <td class="micon"><a class="exi" href="#expand"> </a></td>
525 <a id="Roo.data.HttpProxy-method-load" name=".load"></a>
526 <div class="fixedFont">
527 <span class="attributes"></span><b class="itemname">load</b>
529 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>params</i></B>, <a href="./Roo.data.DataReader.html#constructor" roo:cls="Roo.data.DataReader.html#constructor">Roo.data.DataReader</a> <B><i>reader</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>callback</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>arg</i></B>)
536 <div class="short">Load data from the configured {<b>link</b> Roo.data.Connection}, read the data object into<br/>a block of Roo.data.Records using the passed {<b>link</b> Roo.data.DataReader} implementation, and<br/>process that block using the passed callback.</div>
542 Load data from the configured {<b>link</b> Roo.data.Connection}, read the data object into<br/>a block of Roo.data.Records using the passed {<b>link</b> Roo.data.DataReader} implementation, and<br/>process that block using the passed callback.
549 <dl class="detailList">
550 <dt class="heading">Parameters:</dt>
553 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>params</b>
556 <dd>An object containing properties which are to be used as HTTP parameters<br/>for the request to the remote server.</dd>
559 <span class="fixedFont"><a href="./Roo.data.DataReader.html#constructor" roo:cls="Roo.data.DataReader.html#constructor">Roo.data.DataReader</a></span> <b>reader</b>
562 <dd>The Reader object which converts the data<br/>object into a block of Roo.data.Records.</dd>
565 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>callback</b>
568 <dd>The function into which to pass the block of Roo.data.Records.<br/>The function must be passed <ul><br/><li>The Record block object</li><br/><li>The "arg" argument from the load function</li><br/><li>A boolean success indicator</li><br/></ul></dd>
571 <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>
574 <dd>The scope in which to call the callback</dd>
577 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>arg</b>
580 <dd>An optional argument which is passed to the callback as its second parameter.</dd>
609 <!-- ============================== events summary / details ======================== -->
612 <a id="Roo.data.HttpProxy-events"></a>
621 <table cellspacing="0" class="member-table">
622 <caption>Events</caption>
625 <th class="sig-header" colspan="2">Event</th>
626 <th class="msource-header">Defined By</th>
635 <tr class="method-row expandable config-row-alt0">
636 <td class="micon"><a class="exi" href="#expand"> </a></td>
639 <a id="Roo.data.DataProxy-event-*beforeload"></a>
641 <div class="fixedFont">
642 <b class="itemname">beforeload</b> (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>This</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>params</i></B>)
648 <div class="short">Fires before a network request is made to retrieve a data object.
654 Fires before a network request is made to retrieve a data object.
660 <dl class="detailList">
661 <dt class="heading">Parameters:</dt>
664 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>This</b>
667 <dd>DataProxy object.</dd>
670 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>params</b>
673 <dd>The params parameter to the load function.</dd>
692 <a href="./Roo.data.DataProxy.html#constructor" roo:cls="Roo.data.DataProxy.html#constructor">Roo.data.DataProxy</a>
696 <tr class="method-row expandable config-row-alt1">
697 <td class="micon"><a class="exi" href="#expand"> </a></td>
700 <a id="Roo.data.DataProxy-event-*load"></a>
702 <div class="fixedFont">
703 <b class="itemname">load</b> (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>This</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>o</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>arg</i></B>)
709 <div class="short">Fires before the load method's callback is called.
715 Fires before the load method's callback is called.
721 <dl class="detailList">
722 <dt class="heading">Parameters:</dt>
725 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>This</b>
728 <dd>DataProxy object.</dd>
731 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>o</b>
734 <dd>The data object.</dd>
737 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>arg</b>
740 <dd>The callback argument object passed to the load function.</dd>
759 <a href="./Roo.data.DataProxy.html#constructor" roo:cls="Roo.data.DataProxy.html#constructor">Roo.data.DataProxy</a>
763 <tr class="method-row expandable config-row-alt0">
764 <td class="micon"><a class="exi" href="#expand"> </a></td>
767 <a id="Roo.data.DataProxy-event-*loadexception"></a>
769 <div class="fixedFont">
770 <b class="itemname">loadexception</b> (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>This</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>o</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>arg</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>e</i></B>)
776 <div class="short">Fires if an Exception occurs during data retrieval.
782 Fires if an Exception occurs during data retrieval.
788 <dl class="detailList">
789 <dt class="heading">Parameters:</dt>
792 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>This</b>
795 <dd>DataProxy object.</dd>
798 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>o</b>
801 <dd>The data object.</dd>
804 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>arg</b>
807 <dd>The callback argument object passed to the load function.</dd>
810 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>e</b>
813 <dd>The Exception.</dd>
832 <a href="./Roo.data.DataProxy.html#constructor" roo:cls="Roo.data.DataProxy.html#constructor">Roo.data.DataProxy</a>
843 <!-- ============================== footer ================================= -->
844 <div class="fineprint" style="clear:both">
846 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Tue Apr 01 2014 13:10:15 GMT+0800 (HKT)
848 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>