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.JsonReader</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.JsonReader-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.data.JsonReader-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.data.JsonReader-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.data.JsonReader-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.DataReader.html#constructor" roo:cls="Roo.data.DataReader.html#constructor">Roo.data.DataReader</a>
47 <img src="../../images/default/s.gif" height="1" width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.data.JsonReader
52 <!-- ============================== class title / details ============================ -->
55 <h1 class="classTitle">
57 Class Roo.data.JsonReader
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_JsonReader.js.html">Roo/data/JsonReader.js</a>.
69 <tr><td class="label">Class:</td><td class="hd-info">JsonReader</td></tr>
74 <tr><td class="label">Extends:</td><td class="hd-info">
75 <a href="./Roo.data.DataReader.html#constructor" roo:cls="Roo.data.DataReader.html#constructor">Roo.data.DataReader</a>
83 <!-- ============================== class summary ========================== -->
84 <div class="description">
85 Data reader class to create an Array of Roo.data.Record objects from a JSON response<br/>based on mappings in a provided Roo.data.Record constructor.<br/><br/>The default behaviour of a store is to send ?_requestMeta=1, unless the class has recieved 'metaData' property<br/>in the reply previously. <br/><br/><p><br/>Example code:<br/><pre><code><br/>var RecordDef = Roo.data.Record.create([<br/> {name: 'name', mapping: 'name'}, // "mapping" property not needed if it's the same as "name"<br/> {name: 'occupation'} // This field will use "occupation" as the mapping.<br/>]);<br/>var myReader = new Roo.data.JsonReader({<br/> totalProperty: "results", // The property which contains the total dataset size (optional)<br/> root: "rows", // The property which contains an Array of row objects<br/> id: "id" // The property within each row object that provides an ID for the record (optional)<br/>}, RecordDef);<br/></code></pre><br/><p><br/>This would consume a JSON file like this:<br/><pre><code><br/>{ 'results': 2, 'rows': [<br/> { 'id': 1, 'name': 'Bill', occupation: 'Gardener' },<br/> { 'id': 2, 'name': 'Ben', occupation: 'Horticulturalist' } ]<br/>}<br/></code></pre>
89 <!-- ============================== Class comment block... ========================== -->
91 <div class="comments">
92 <b>Class Comments / Notes</B> =>
93 <u onclick="parent.CommentDialog.showCommentId = 'Roo.data.JsonReader';">[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.JsonReader.html"></iframe>
101 <!-- ============================== config options ========================== -->
106 <div class="hr"></div>
107 <a id="Roo.data.JsonReader-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.JsonReader-cfg-id" name=".id"></a>
132 <div class="fixedFont">
133 <b class="itemname">id</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
139 <div class="short">Name of the property within a row object that contains a record identifier value.</div>
143 <div class="long">Name of the property within a row object that contains a record identifier value.</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.JsonReader-cfg-root" name=".root"></a>
162 <div class="fixedFont">
163 <b class="itemname">root</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
169 <div class="short">name of the property which contains the Array of row objects.</div>
173 <div class="long">name of the property which contains the Array of row objects.</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.JsonReader-cfg-successProperty" name=".successProperty"></a>
192 <div class="fixedFont">
193 <b class="itemname">successProperty</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
199 <div class="short">Name of the property from which to retrieve the success attribute used by forms.</div>
203 <div class="long">Name of the property from which to retrieve the success attribute used by forms.</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.JsonReader-cfg-totalProperty" name=".totalProperty"></a>
222 <div class="fixedFont">
223 <b class="itemname">totalProperty</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
229 <div class="short">Name of the property from which to retrieve the total number of records<br/>in the dataset.</div>
233 <div class="long">Name of the property from which to retrieve the total number of records<br/>in the dataset. This is only needed if the whole dataset is not passed in one go, but is being<br/>paged from the remote server.</div>
257 <!-- ============================== public properties ==================== -->
261 <a id="Roo.data.JsonReader-props"></a>
267 <table cellspacing="0" class="member-table">
268 <caption class="Empty">Public Properties - Has None</caption>
274 <!-- ============================== methods summary / details ======================== -->
277 <a id="Roo.data.JsonReader-methods"></a>
278 <!-- constructor?? -->
285 <!-- then dynamics first -->
292 <table cellspacing="0" class="member-table">
293 <caption>Public Methods</caption>
295 <th class="sig-header" colspan="2">Method</th>
296 <th class="msource-header">Defined By</th>
306 <tr class="method-row config-row-alt0 expandable notInherited">
307 <td class="micon"><a class="exi" href="#expand"> </a></td>
311 <a id="Roo.data-method-JsonReader" name=".JsonReader"></a>
312 <div class="fixedFont">
313 <span class="attributes">new <B>Roo.data.</B></span><b class="itemname">JsonReader</b>
315 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>meta</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>recordType</i></B>)
323 <div class="short">Create a new Roo.data.JsonReader</div>
330 Create a new Roo.data.JsonReader
333 <dl class="detailList">
334 <dt class="heading">Parameters:</dt>
337 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>meta</b>
340 <dd>Metadata configuration options</dd>
343 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>recordType</b>
346 <dd>Either an Array of field definition objects,<br/>or an {<b>link</b> Roo.data.Record} object created using {<b>link</b> Roo.data.Record<b>create</b>}.</dd>
370 <tr class="method-row config-row-alt1 expandable">
371 <td class="micon"><a class="exi" href="#expand"> </a></td>
375 <a id="Roo.data.DataReader-method-newRow" name=".newRow"></a>
376 <div class="fixedFont">
377 <span class="attributes"></span><b class="itemname">newRow</b>
379 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>data</i></B>)
385 <a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a>
394 <div class="short">Create an empty record</div>
400 Create an empty record
407 <dl class="detailList">
408 <dt class="heading">Parameters:</dt>
411 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>data</b>
414 <dd>(optional) - overlay some values</dd>
422 <dl class="detailList">
423 <dt class="heading">Returns:</dt>
425 <dd><span class="fixedFont"><a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a></span> record created.</dd>
441 <a href="./Roo.data.DataReader.html#constructor" roo:cls="Roo.data.DataReader.html#constructor">Roo.data.DataReader</a>
447 <tr class="method-row config-row-alt0 expandable notInherited">
448 <td class="micon"><a class="exi" href="#expand"> </a></td>
452 <a id="Roo.data.JsonReader-method-read" name=".read"></a>
453 <div class="fixedFont">
454 <span class="attributes"></span><b class="itemname">read</b>
456 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>response</i></B>)
462 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
471 <div class="short">This method is only used by a DataProxy which has retrieved data from a remote server.</div>
477 This method is only used by a DataProxy which has retrieved data from a remote server.
484 <dl class="detailList">
485 <dt class="heading">Parameters:</dt>
488 <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>
491 <dd>The XHR object which contains the JSON data in its responseText.</dd>
499 <dl class="detailList">
500 <dt class="heading">Returns:</dt>
502 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> data A data block which is used by an Roo.data.Store object as<br/>a cache of Roo.data.Records.</dd>
524 <tr class="method-row config-row-alt1 expandable notInherited">
525 <td class="micon"><a class="exi" href="#expand"> </a></td>
529 <a id="Roo.data.JsonReader-method-readRecords" name=".readRecords"></a>
530 <div class="fixedFont">
531 <span class="attributes"></span><b class="itemname">readRecords</b>
533 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>o</i></B>)
539 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
548 <div class="short">Create a data block containing Roo.data.Records from an XML document.</div>
554 Create a data block containing Roo.data.Records from an XML document.
561 <dl class="detailList">
562 <dt class="heading">Parameters:</dt>
565 <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>
568 <dd>An object which contains an Array of row objects in the property specified<br/>in the config as 'root, and optionally a property, specified in the config as 'totalProperty'<br/>which contains the total size of the dataset.</dd>
576 <dl class="detailList">
577 <dt class="heading">Returns:</dt>
579 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> data A data block which is used by an Roo.data.Store object as<br/>a cache of Roo.data.Records.</dd>
604 <!-- ============================== events summary / details ======================== -->
607 <a id="Roo.data.JsonReader-events"></a>
613 <table cellspacing="0" class="member-table">
614 <caption class="Empty">Events - Has None</caption>
625 <!-- ============================== footer ================================= -->
626 <div class="fineprint" style="clear:both">
628 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Thu Apr 24 2014 16:32:57 GMT+0800 (HKT)
630 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>