+++ /dev/null
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-
- <head>
- <meta http-equiv="content-type" content="text/html; charset=undefined" />
- <meta name="generator" content="JsDoc Toolkit" />
-
-
- <title>JsDoc Reference - Roo.data.JsonReader</title>
-
-
- <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
- <link rel="stylesheet" type="text/css" href="../default.css" />
-
-
- <script type="text/javascript" src="../page.js">
-
- </script>
-
-
- </head>
-
- <body onload="RooDocsPage.onload();">
-
-
-<div class="body-wrap">
-
- <!-- ============================== links to methods. ================================= -->
-
- <div class="top-tools">
- <!--
- <a class="inner-link" href="#Roo.data.JsonReader-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
- <a class="inner-link" href="#Roo.data.JsonReader-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
- <a class="inner-link" href="#Roo.data.JsonReader-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
- <a class="inner-link" href="#Roo.data.JsonReader-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
- <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
- -->
- </div>
-
-
-<!-- ============================== inheritance Block. ================================= -->
-
- <div class="inheritance res-block">
- <pre class="res-block-inner"><a href="./Roo.data.DataReader.html#constructor" roo:cls="Roo.data.DataReader.html#constructor">Roo.data.DataReader</a>
-<img src="../../images/default/s.gif" height="1" width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.data.JsonReader
-
- </pre>
- </div>
-
-<!-- ============================== class title / details ============================ -->
-
-
- <h1 class="classTitle">
-
- Class Roo.data.JsonReader
- </h1>
-
- <table cellspacing="0" class="class-summary-table">
-
- <tr><td class="label">Package:</td><td class="hd-info">Roo.data</td></tr>
-
- <tr><td class="label">Defined In:</td><td class="hd-info">
-
- <a href="./src/Roo_data_JsonReader.js.html">Roo/data/JsonReader.js</a>.
-
- </td></tr>
- <tr><td class="label">Class:</td><td class="hd-info">JsonReader</td></tr>
-
-
-
-
- <tr><td class="label">Extends:</td><td class="hd-info">
- <a href="./Roo.data.DataReader.html#constructor" roo:cls="Roo.data.DataReader.html#constructor">Roo.data.DataReader</a>
-
- </td></tr>
-
-
- </table>
-
-
-<!-- ============================== class summary ========================== -->
- <div class="description">
- 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>
- </div>
-
-
-<!-- ============================== Class comment block... ========================== -->
-
-<div class="comments">
- <b>Class Comments / Notes</B> =>
- <u onclick="parent.CommentDialog.showCommentId = 'Roo.data.JsonReader';">[Add Your comment/notes about this class]</u>
- <br/>
- <iframe frameborder="0" id="comments-Roo.data" style="border: none;width:100%;"
- src="/blog.php/GtkDjsComments/Roo.data.JsonReader.html"></iframe>
-</div>
-
-
-
-<!-- ============================== config options ========================== -->
-
-
-
-
- <div class="hr"></div>
- <a id="Roo.data.JsonReader-configs"></a>
-
-
-
-
-
- <table cellspacing="0" class="member-table">
- <caption>Config Options (Usually are also Properties)</caption>
-
-
- <tr>
- <th class="sig-header" colspan="2">Options</th>
-
- <th class="msource-header">Defined By</th>
- </tr>
-
-
-
-
-
- <tr class="config-row expandable config-row-alt0 notInherited">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
-
- <a id="Roo.data.JsonReader-cfg-fields" name=".fields"></a>
- <div class="fixedFont">
- <b class="itemname">fields</b> : <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
-
-
- </div>
-
- <div class="mdesc">
- <div class="short">Array of field definition objects</div>
- </div>
-
- <div class="mdesc">
- <div class="long">
- Array of field definition objects
-
- </div>
- </div>
-
-
-
- </td>
- <td class="msource">
-
- Roo.data.JsonReader
-
- </td>
- </tr>
-
-
- <tr class="config-row expandable config-row-alt1 notInherited">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
-
- <a id="Roo.data.JsonReader-cfg-id" name=".id"></a>
- <div class="fixedFont">
- <b class="itemname">id</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
-
-
- </div>
-
- <div class="mdesc">
- <div class="short">Name of the property within a row object that contains a record identifier value.</div>
- </div>
-
- <div class="mdesc">
- <div class="long">
- Name of the property within a row object that contains a record identifier value.
-
- </div>
- </div>
-
-
-
- </td>
- <td class="msource">
-
- Roo.data.JsonReader
-
- </td>
- </tr>
-
-
- <tr class="config-row expandable config-row-alt0 notInherited">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
-
- <a id="Roo.data.JsonReader-cfg-root" name=".root"></a>
- <div class="fixedFont">
- <b class="itemname">root</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
-
-
- </div>
-
- <div class="mdesc">
- <div class="short">name of the property which contains the Array of row objects.</div>
- </div>
-
- <div class="mdesc">
- <div class="long">
- name of the property which contains the Array of row objects.
-
- </div>
- </div>
-
-
-
- </td>
- <td class="msource">
-
- Roo.data.JsonReader
-
- </td>
- </tr>
-
-
- <tr class="config-row expandable config-row-alt1 notInherited">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
-
- <a id="Roo.data.JsonReader-cfg-successProperty" name=".successProperty"></a>
- <div class="fixedFont">
- <b class="itemname">successProperty</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
-
-
- </div>
-
- <div class="mdesc">
- <div class="short">Name of the property from which to retrieve the success attribute used by forms.</div>
- </div>
-
- <div class="mdesc">
- <div class="long">
- Name of the property from which to retrieve the success attribute used by forms.
-
- </div>
- </div>
-
-
-
- </td>
- <td class="msource">
-
- Roo.data.JsonReader
-
- </td>
- </tr>
-
-
- <tr class="config-row expandable config-row-alt0 notInherited">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
-
- <a id="Roo.data.JsonReader-cfg-totalProperty" name=".totalProperty"></a>
- <div class="fixedFont">
- <b class="itemname">totalProperty</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
-
-
- </div>
-
- <div class="mdesc">
- <div class="short">Name of the property from which to retrieve the total number of records<br/>in the dataset.</div>
- </div>
-
- <div class="mdesc">
- <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>
- </div>
-
-
-
- </td>
- <td class="msource">
-
- Roo.data.JsonReader
-
- </td>
- </tr>
-
-
- </table>
-
-
-
-
-
-
-
-
-
- <!-- ============================== public properties ==================== -->
-
-
-
- <a id="Roo.data.JsonReader-props"></a>
-
-
-
-
-
- <table cellspacing="0" class="member-table">
- <caption class="Empty">Public Properties - Has None</caption>
- </table>
-
-
-
-
- <!-- ============================== methods summary / details ======================== -->
-
-
- <a id="Roo.data.JsonReader-methods"></a>
- <!-- constructor?? -->
-
- <!-- static's first
-
-
- -->
-
- <!-- then dynamics first -->
-
-
-
-
-
-
- <table cellspacing="0" class="member-table">
- <caption>Public Methods</caption>
- <tr>
- <th class="sig-header" colspan="2">Method</th>
- <th class="msource-header">Defined By</th>
-
- </tr>
-
-
-
-
-
-
-
- <tr class="method-row config-row-alt0 expandable notInherited">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.data-method-JsonReader" name=".JsonReader"></a>
- <div class="fixedFont">
- <span class="attributes">new <B>Roo.data.</B></span><b class="itemname">JsonReader</b>
-
- (<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>)
-
-
-
- </div>
- <div class="mdesc">
-
-
- <div class="short">Create a new Roo.data.JsonReader</div>
-
-
- <div class="long">
-
-
-
- Create a new Roo.data.JsonReader
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <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>
-
- </dt>
- <dd>Metadata configuration options</dd>
-
- <dt>
- <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>
-
- </dt>
- <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>
-
- </dl>
-
-
-
-
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt1 expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.data.DataReader-method-newRow" name=".newRow"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">newRow</b>
-
- (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>data</i></B>)
-
-
- :
-
-
- <a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a>
-
-
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Create an empty record</div>
-
-
-
- <div class="long">
-
- Create an empty record
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <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>
-
- </dt>
- <dd>(optional) - overlay some values</dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <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>
-
- </dl>
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- <a href="./Roo.data.DataReader.html#constructor" roo:cls="Roo.data.DataReader.html#constructor">Roo.data.DataReader</a>
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt0 expandable notInherited">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.data.JsonReader-method-read" name=".read"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">read</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>
-
-
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">This method is only used by a DataProxy which has retrieved data from a remote server.</div>
-
-
-
- <div class="long">
-
- This method is only used by a DataProxy which has retrieved data from a remote server.
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <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>
-
- </dt>
- <dd>The XHR object which contains the JSON data in its responseText.</dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <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>
-
- </dl>
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- Roo.data.JsonReader
-
- </td>
- </tr>
-
-
- <tr class="method-row config-row-alt1 expandable notInherited">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
-
-
- <td class="sig">
- <a id="Roo.data.JsonReader-method-readRecords" name=".readRecords"></a>
- <div class="fixedFont">
- <span class="attributes"></span><b class="itemname">readRecords</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>
-
-
-
-
-
- </div>
- <div class="mdesc">
-
- <div class="short">Create a data block containing Roo.data.Records from an XML document.</div>
-
-
-
- <div class="long">
-
- Create a data block containing Roo.data.Records from an XML document.
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <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>
-
- </dt>
- <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>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <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>
-
- </dl>
-
-
-
-
-
-
-
- </div>
- </div>
-
- </td>
- <td class="msource">
-
- Roo.data.JsonReader
-
- </td>
- </tr>
-
-
- </table>
-
-
- <!-- ============================== events summary / details ======================== -->
-
-
- <a id="Roo.data.JsonReader-events"></a>
-
-
-
-
-
- <table cellspacing="0" class="member-table">
- <caption class="Empty">Events - Has None</caption>
- </table>
-
-
-
-
-
-
-
-
-
-<!-- ============================== footer ================================= -->
- <div class="fineprint" style="clear:both">
-
- Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Jul 13 2018 14:10:54 GMT+0800 (HKT)
- Based on
- <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
- </div>
- </body>
-</html>
projects / roojs1 / blobdiff