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.ArrayReader</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.ArrayReader-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.data.ArrayReader-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.data.ArrayReader-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.data.ArrayReader-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.ArrayReader
52 <!-- ============================== class title / details ============================ -->
55 <h1 class="classTitle">
57 Class Roo.data.ArrayReader
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_ArrayReader.js.html">Roo/data/ArrayReader.js</a>.
69 <tr><td class="label">Class:</td><td class="hd-info">ArrayReader</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 an Array.<br/>Each element of that Array represents a row of data fields. The<br/>fields are pulled into a Record object using as a subscript, the <em>mapping</em> property<br/>of the field definition if it exists, or the field's ordinal position in the definition.<br><br/><p><br/>Example code:.<br/><pre><code><br/>var RecordDef = Roo.data.Record.create([<br/> {name: 'name', mapping: 1}, // "mapping" only needed if an "id" field is present which<br/> {name: 'occupation', mapping: 2} // precludes using the ordinal position as the index.<br/>]);<br/>var myReader = new Roo.data.ArrayReader({<br/> id: 0 // The subscript within row Array that provides an ID for the Record (optional)<br/>}, RecordDef);<br/></code></pre><br/><p><br/>This would consume an Array like this:<br/><pre><code><br/>[ [1, 'Bill', 'Gardener'], [2, 'Ben', 'Horticulturalist'] ]<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.ArrayReader';">[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.ArrayReader.html"></iframe>
101 <!-- ============================== config options ========================== -->
106 <div class="hr"></div>
107 <a id="Roo.data.ArrayReader-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.ArrayReader-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">(optional) The subscript within row Array that provides an ID for the Record</div>
143 <div class="long">(optional) The subscript within row Array that provides an ID for the Record</div>
167 <!-- ============================== public properties ==================== -->
171 <a id="Roo.data.ArrayReader-props"></a>
177 <table cellspacing="0" class="member-table">
178 <caption class="Empty">Public Properties - Has None</caption>
184 <!-- ============================== methods summary / details ======================== -->
187 <a id="Roo.data.ArrayReader-methods"></a>
188 <!-- constructor?? -->
195 <!-- then dynamics first -->
202 <table cellspacing="0" class="member-table">
203 <caption>Public Methods</caption>
205 <th class="sig-header" colspan="2">Method</th>
206 <th class="msource-header">Defined By</th>
216 <tr class="method-row config-row-alt0 expandable notInherited">
217 <td class="micon"><a class="exi" href="#expand"> </a></td>
221 <a id="Roo.data-method-ArrayReader" name=".ArrayReader"></a>
222 <div class="fixedFont">
223 <span class="attributes">new <B>Roo.data.</B></span><b class="itemname">ArrayReader</b>
225 (<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>)
233 <div class="short">Create a new Roo.data.ArrayReader</div>
240 Create a new Roo.data.ArrayReader
243 <dl class="detailList">
244 <dt class="heading">Parameters:</dt>
247 <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>
250 <dd>Metadata configuration options.</dd>
253 <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>
256 <dd>Either an Array of field definition objects<br/>as specified to {<b>link</b> Roo.data.Record<b>create</b>},<br/>or an {<b>link</b> Roo.data.Record} object<br/>created using {<b>link</b> Roo.data.Record<b>create</b>}.</dd>
280 <tr class="method-row config-row-alt1 expandable">
281 <td class="micon"><a class="exi" href="#expand"> </a></td>
285 <a id="Roo.data.DataReader-method-newRow" name=".newRow"></a>
286 <div class="fixedFont">
287 <span class="attributes"></span><b class="itemname">newRow</b>
289 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>data</i></B>)
295 <a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a>
304 <div class="short">Create an empty record</div>
310 Create an empty record
317 <dl class="detailList">
318 <dt class="heading">Parameters:</dt>
321 <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>
324 <dd>(optional) - overlay some values</dd>
332 <dl class="detailList">
333 <dt class="heading">Returns:</dt>
335 <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>
351 <a href="./Roo.data.DataReader.html#constructor" roo:cls="Roo.data.DataReader.html#constructor">Roo.data.DataReader</a>
357 <tr class="method-row config-row-alt0 expandable notInherited">
358 <td class="micon"><a class="exi" href="#expand"> </a></td>
362 <a id="Roo.data.ArrayReader-method-readRecords" name=".readRecords"></a>
363 <div class="fixedFont">
364 <span class="attributes"></span><b class="itemname">readRecords</b>
366 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>o</i></B>)
372 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
381 <div class="short">Create a data block containing Roo.data.Records from an XML document.</div>
387 Create a data block containing Roo.data.Records from an XML document.
394 <dl class="detailList">
395 <dt class="heading">Parameters:</dt>
398 <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>
401 <dd>An Array of row objects which represents the dataset.</dd>
409 <dl class="detailList">
410 <dt class="heading">Returns:</dt>
412 <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>
437 <!-- ============================== events summary / details ======================== -->
440 <a id="Roo.data.ArrayReader-events"></a>
446 <table cellspacing="0" class="member-table">
447 <caption class="Empty">Events - Has None</caption>
458 <!-- ============================== footer ================================= -->
459 <div class="fineprint" style="clear:both">
461 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Apr 04 2014 18:59:39 GMT+0800 (HKT)
463 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>