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.DataProxy</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.DataProxy-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.data.DataProxy-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.data.DataProxy-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.data.DataProxy-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">Roo.data.Observable
47 <img src="../../images/default/s.gif" height="1" width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.data.DataProxy
52 <!-- ============================== class title / details ============================ -->
55 <h1 class="classTitle">
57 Class Roo.data.DataProxy
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_DataProxy.js.html">Roo/data/DataProxy.js</a>.
69 <tr><td class="label">Class:</td><td class="hd-info">DataProxy</td></tr>
72 <tr><td class="label">Subclasses:</td><td class="hd-info">
73 <a href="./Roo.data.HttpProxy.html#constructor" roo:cls="Roo.data.HttpProxy.html#constructor">Roo.data.HttpProxy</a>
81 <tr><td class="label">Extends:</td><td class="hd-info">
90 <!-- ============================== class summary ========================== -->
91 <div class="description">
92 This class is an abstract base class for implementations which provide retrieval of<br/>unformatted data objects.<br><br/><p><br/>DataProxy implementations are usually used in conjunction with an implementation of Roo.data.DataReader<br/>(of the appropriate type which knows how to parse the data object) to provide a block of<br/>{<b>link</b> Roo.data.Records} to an {<b>link</b> Roo.data.Store}.<br><br/><p><br/>Custom implementations must implement the load method as described in<br/>{<b>link</b> Roo.data.HttpProxy<b>load</b>}.
96 <!-- ============================== Class comment block... ========================== -->
98 <div class="comments">
99 <b>Class Comments / Notes</B> =>
100 <u onclick="parent.CommentDialog.showCommentId = 'Roo.data.DataProxy';">[Add Your comment/notes about this class]</u>
102 <iframe frameborder="0" id="comments-Roo.data" style="border: none;width:100%;"
103 src="/blog.php/GtkDjsComments/Roo.data.DataProxy.html"></iframe>
108 <!-- ============================== config options ========================== -->
113 <div class="hr"></div>
114 <a id="Roo.data.DataProxy-configs"></a>
118 <table cellspacing="0" class="member-table">
119 <caption class="Empty">Config Options - Has None</caption>
133 <!-- ============================== public properties ==================== -->
137 <a id="Roo.data.DataProxy-props"></a>
143 <table cellspacing="0" class="member-table">
144 <caption class="Empty">Public Properties - Has None</caption>
150 <!-- ============================== methods summary / details ======================== -->
153 <a id="Roo.data.DataProxy-methods"></a>
154 <!-- constructor?? -->
161 <!-- then dynamics first -->
168 <table cellspacing="0" class="member-table">
169 <caption>Public Methods</caption>
171 <th class="sig-header" colspan="2">Method</th>
172 <th class="msource-header">Defined By</th>
182 <tr class="method-row config-row-alt0 notInherited">
183 <td class="micon"><a class="exi" href="#expand"> </a></td>
187 <a id="Roo.data-method-DataProxy" name=".DataProxy"></a>
188 <div class="fixedFont">
189 <span class="attributes">new <B>Roo.data.</B></span><b class="itemname">DataProxy</b>
199 <div class="short">Create a new Roo.data.DataProxy</div>
206 Create a new Roo.data.DataProxy
232 <!-- ============================== events summary / details ======================== -->
235 <a id="Roo.data.DataProxy-events"></a>
244 <table cellspacing="0" class="member-table">
245 <caption>Events</caption>
248 <th class="sig-header" colspan="2">Event</th>
249 <th class="msource-header">Defined By</th>
258 <tr class="method-row expandable config-row-alt0 notInherited">
259 <td class="micon"><a class="exi" href="#expand"> </a></td>
262 <a id="Roo.data.DataProxy-event-*beforeload"></a>
264 <div class="fixedFont">
265 <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>)
271 <div class="short">Fires before a network request is made to retrieve a data object.
277 Fires before a network request is made to retrieve a data object.
283 <dl class="detailList">
284 <dt class="heading">Parameters:</dt>
287 <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>
290 <dd>DataProxy object.</dd>
293 <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>
296 <dd>The params parameter to the load function.</dd>
319 <tr class="method-row expandable config-row-alt1 notInherited">
320 <td class="micon"><a class="exi" href="#expand"> </a></td>
323 <a id="Roo.data.DataProxy-event-*load"></a>
325 <div class="fixedFont">
326 <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>)
332 <div class="short">Fires before the load method's callback is called.
338 Fires before the load method's callback is called.
344 <dl class="detailList">
345 <dt class="heading">Parameters:</dt>
348 <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>
351 <dd>DataProxy object.</dd>
354 <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>
357 <dd>The data object.</dd>
360 <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>
363 <dd>The callback argument object passed to the load function.</dd>
386 <tr class="method-row expandable config-row-alt0 notInherited">
387 <td class="micon"><a class="exi" href="#expand"> </a></td>
390 <a id="Roo.data.DataProxy-event-*loadexception"></a>
392 <div class="fixedFont">
393 <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>)
399 <div class="short">Fires if an Exception occurs during data retrieval.
405 Fires if an Exception occurs during data retrieval.
411 <dl class="detailList">
412 <dt class="heading">Parameters:</dt>
415 <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>
418 <dd>DataProxy object.</dd>
421 <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>
424 <dd>The data object.</dd>
427 <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>
430 <dd>The callback argument object passed to the load function.</dd>
433 <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>
436 <dd>The Exception.</dd>
466 <!-- ============================== footer ================================= -->
467 <div class="fineprint" style="clear:both">
469 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Sep 01 2017 13:17:17 GMT+0800 (HKT)
471 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>