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>
144 (Optional) Whether this request should abort any pending requests. (defaults to false)
160 <tr class="config-row expandable config-row-alt1 notInherited">
161 <td class="micon"><a class="exi" href="#expand"> </a></td>
164 <a id="Roo.data.HttpProxy-cfg-defaultHeaders" name=".defaultHeaders"></a>
165 <div class="fixedFont">
166 <b class="itemname">defaultHeaders</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
172 <div class="short">(Optional) An object containing request headers which are added<br/> to each request made by this object.</div>
177 (Optional) An object containing request headers which are added<br/> to each request made by this object. (defaults to undefined)
193 <tr class="config-row expandable config-row-alt0 notInherited">
194 <td class="micon"><a class="exi" href="#expand"> </a></td>
197 <a id="Roo.data.HttpProxy-cfg-disableCaching" name=".disableCaching"></a>
198 <div class="fixedFont">
199 <b class="itemname">disableCaching</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
205 <div class="short">(Optional) True to add a unique cache-buster param to GET requests.</div>
210 (Optional) True to add a unique cache-buster param to GET requests. (defaults to true)
226 <tr class="config-row expandable config-row-alt1 notInherited">
227 <td class="micon"><a class="exi" href="#expand"> </a></td>
230 <a id="Roo.data.HttpProxy-cfg-extraParams" name=".extraParams"></a>
231 <div class="fixedFont">
232 <b class="itemname">extraParams</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
238 <div class="short">(Optional) An object containing properties which are used as<br/>extra parameters to each request made by this object.</div>
243 (Optional) An object containing properties which are used as<br/>extra parameters to each request made by this object. (defaults to undefined)
259 <tr class="config-row expandable config-row-alt0 notInherited">
260 <td class="micon"><a class="exi" href="#expand"> </a></td>
263 <a id="Roo.data.HttpProxy-cfg-method" name=".method"></a>
264 <div class="fixedFont">
265 <b class="itemname">method</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
271 <div class="short">(Optional) The default HTTP method to be used for requests.</div>
276 (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)
292 <tr class="config-row expandable config-row-alt1 notInherited">
293 <td class="micon"><a class="exi" href="#expand"> </a></td>
296 <a id="Roo.data.HttpProxy-cfg-timeout" name=".timeout"></a>
297 <div class="fixedFont">
298 <b class="itemname">timeout</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
304 <div class="short">(Optional) The timeout in milliseconds to be used for requests.</div>
309 (Optional) The timeout in milliseconds to be used for requests. (defaults to 30000)
325 <tr class="config-row expandable config-row-alt0 notInherited">
326 <td class="micon"><a class="exi" href="#expand"> </a></td>
329 <a id="Roo.data.HttpProxy-cfg-url" name=".url"></a>
330 <div class="fixedFont">
331 <b class="itemname">url</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
337 <div class="short">(Optional) The default URL to be used for requests to the server.</div>
342 (Optional) The default URL to be used for requests to the server. (defaults to undefined)
368 <!-- ============================== public properties ==================== -->
372 <a id="Roo.data.HttpProxy-props"></a>
378 <table cellspacing="0" class="member-table">
379 <caption class="Empty">Public Properties - Has None</caption>
385 <!-- ============================== methods summary / details ======================== -->
388 <a id="Roo.data.HttpProxy-methods"></a>
389 <!-- constructor?? -->
396 <!-- then dynamics first -->
403 <table cellspacing="0" class="member-table">
404 <caption>Public Methods</caption>
406 <th class="sig-header" colspan="2">Method</th>
407 <th class="msource-header">Defined By</th>
417 <tr class="method-row config-row-alt0 expandable notInherited">
418 <td class="micon"><a class="exi" href="#expand"> </a></td>
422 <a id="Roo.data-method-HttpProxy" name=".HttpProxy"></a>
423 <div class="fixedFont">
424 <span class="attributes">new <B>Roo.data.</B></span><b class="itemname">HttpProxy</b>
426 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>conn</i></B>)
434 <div class="short">Create a new Roo.data.HttpProxy</div>
441 Create a new Roo.data.HttpProxy
444 <dl class="detailList">
445 <dt class="heading">Parameters:</dt>
448 <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>
451 <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>
475 <tr class="method-row config-row-alt1 expandable notInherited">
476 <td class="micon"><a class="exi" href="#expand"> </a></td>
480 <a id="Roo.data.HttpProxy-method-getConnection" name=".getConnection"></a>
481 <div class="fixedFont">
482 <span class="attributes"></span><b class="itemname">getConnection</b>
499 <div class="short">Return the {<b>link</b> Roo.data.Connection} object being used by this Proxy.</div>
505 Return the {<b>link</b> Roo.data.Connection} object being used by this Proxy.
516 <dl class="detailList">
517 <dt class="heading">Returns:</dt>
519 <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>
541 <tr class="method-row config-row-alt0 expandable notInherited">
542 <td class="micon"><a class="exi" href="#expand"> </a></td>
546 <a id="Roo.data.HttpProxy-method-load" name=".load"></a>
547 <div class="fixedFont">
548 <span class="attributes"></span><b class="itemname">load</b>
550 (<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>)
557 <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>
563 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.
570 <dl class="detailList">
571 <dt class="heading">Parameters:</dt>
574 <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>
577 <dd>An object containing properties which are to be used as HTTP parameters<br/>for the request to the remote server.</dd>
580 <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>
583 <dd>The Reader object which converts the data<br/>object into a block of Roo.data.Records.</dd>
586 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>callback</b>
589 <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>
592 <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>
595 <dd>The scope in which to call the callback</dd>
598 <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>
601 <dd>An optional argument which is passed to the callback as its second parameter.</dd>
630 <!-- ============================== events summary / details ======================== -->
633 <a id="Roo.data.HttpProxy-events"></a>
642 <table cellspacing="0" class="member-table">
643 <caption>Events</caption>
646 <th class="sig-header" colspan="2">Event</th>
647 <th class="msource-header">Defined By</th>
656 <tr class="method-row expandable config-row-alt0">
657 <td class="micon"><a class="exi" href="#expand"> </a></td>
660 <a id="Roo.data.DataProxy-event-*beforeload"></a>
662 <div class="fixedFont">
663 <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>)
669 <div class="short">Fires before a network request is made to retrieve a data object.
675 Fires before a network request is made to retrieve a data object.
681 <dl class="detailList">
682 <dt class="heading">Parameters:</dt>
685 <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>
688 <dd>DataProxy object.</dd>
691 <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>
694 <dd>The params parameter to the load function.</dd>
713 <a href="./Roo.data.DataProxy.html#constructor" roo:cls="Roo.data.DataProxy.html#constructor">Roo.data.DataProxy</a>
717 <tr class="method-row expandable config-row-alt1">
718 <td class="micon"><a class="exi" href="#expand"> </a></td>
721 <a id="Roo.data.DataProxy-event-*load"></a>
723 <div class="fixedFont">
724 <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>)
730 <div class="short">Fires before the load method's callback is called.
736 Fires before the load method's callback is called.
742 <dl class="detailList">
743 <dt class="heading">Parameters:</dt>
746 <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>
749 <dd>DataProxy object.</dd>
752 <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>
755 <dd>The data object.</dd>
758 <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>
761 <dd>The callback argument object passed to the load function.</dd>
780 <a href="./Roo.data.DataProxy.html#constructor" roo:cls="Roo.data.DataProxy.html#constructor">Roo.data.DataProxy</a>
784 <tr class="method-row expandable config-row-alt0">
785 <td class="micon"><a class="exi" href="#expand"> </a></td>
788 <a id="Roo.data.DataProxy-event-*loadexception"></a>
790 <div class="fixedFont">
791 <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>)
797 <div class="short">Fires if an Exception occurs during data retrieval.
803 Fires if an Exception occurs during data retrieval.
809 <dl class="detailList">
810 <dt class="heading">Parameters:</dt>
813 <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>
816 <dd>DataProxy object.</dd>
819 <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>
822 <dd>The data object.</dd>
825 <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>
828 <dd>The callback argument object passed to the load function.</dd>
831 <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>
834 <dd>The Exception.</dd>
853 <a href="./Roo.data.DataProxy.html#constructor" roo:cls="Roo.data.DataProxy.html#constructor">Roo.data.DataProxy</a>
864 <!-- ============================== footer ================================= -->
865 <div class="fineprint" style="clear:both">
867 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Mon Apr 25 2016 14:57:01 GMT+0800 (HKT)
869 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>