commit extjs-2.2.1
[extjs.git] / docs / output / Ext.data.DataReader.html
1         <div class="body-wrap">
2         <div class="top-tools">
3             <a class="inner-link" href="#Ext.data.DataReader-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
4             <a class="inner-link" href="#Ext.data.DataReader-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
5             <a class="inner-link" href="#Ext.data.DataReader-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
6                         <a class="bookmark" href="../docs/?class=Ext.data.DataReader"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
7         </div>
8                 <h1>Class Ext.data.DataReader</h1>
9         <table cellspacing="0">
10             <tr><td class="label">Package:</td><td class="hd-info">Ext.data</td></tr>
11             <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/DataReader.js" target="_blank">DataReader.js</a></td></tr>
12             <tr><td class="label">Class:</td><td class="hd-info">DataReader</td></tr>
13                         <tr><td class="label">Subclasses:</td><td class="hd-info"><a ext:cls="Ext.data.JsonReader" href="output/Ext.data.JsonReader.html">JsonReader</a>, <a ext:cls="Ext.data.XmlReader" href="output/Ext.data.XmlReader.html">XmlReader</a></td></tr>
14                                     <tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr>
15                     </table>
16         <div class="description">
17             *
18 Abstract base class for reading structured data from a data source and converting
19 it into an object containing <a ext:cls="Ext.data.Record" href="output/Ext.data.Record.html">Ext.data.Record</a> objects and metadata for use
20 by an <a ext:cls="Ext.data.Store" href="output/Ext.data.Store.html">Ext.data.Store</a>.  This class is intended to be extended and should not
21 be created directly. For existing implementations, see <a ext:cls="Ext.data.ArrayReader" href="output/Ext.data.ArrayReader.html">Ext.data.ArrayReader</a>,
22 <a ext:cls="Ext.data.JsonReader" href="output/Ext.data.JsonReader.html">Ext.data.JsonReader</a> and <a ext:cls="Ext.data.XmlReader" href="output/Ext.data.XmlReader.html">Ext.data.XmlReader</a>.        </div>
23         
24         <div class="hr"></div>
25                 <a id="Ext.data.DataReader-props"></a>
26         <h2>Public Properties</h2>
27                 <table cellspacing="0" class="member-table">
28             <tr>
29                 <th class="sig-header" colspan="2">Property</th>
30                 <th class="msource-header">Defined By</th>
31             </tr>
32                 <tr class="property-row">\r
33         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
34         <td class="sig">\r
35         <a id="Ext.data.DataReader-meta"></a>\r
36             <b>meta</b> : Mixed            <div class="mdesc">\r
37                             This DataReader's configured metadata as passed to the constructor.                        </div>\r
38         </td>\r
39         <td class="msource">DataReader</td>\r
40     </tr>\r
41             </table>
42                 <a id="Ext.data.DataReader-methods"></a>
43         <h2>Public Methods</h2>
44                 <table cellspacing="0" class="member-table">
45             <tr>
46                 <th class="sig-header" colspan="2">Method</th>
47                 <th class="msource-header">Defined By</th>
48             </tr>
49                 <tr class="method-row expandable">\r
50         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
51         <td class="sig">\r
52         <a id="Ext.data.DataReader-DataReader"></a>\r
53             <b>DataReader</b>(&nbsp;<code>Object meta</code>, <code>Object recordType</code>&nbsp;)            <div class="mdesc">\r
54                         <div class="short">Create a new DataReader</div>\r
55             <div class="long">\r
56                 Create a new DataReader    <div class="mdetail-params">\r
57         <strong>Parameters:</strong>\r
58         <ul><li><code>meta</code> : Object<div class="sub-desc">Metadata configuration options (implementation-specific)</div></li><li><code>recordType</code> : Object<div class="sub-desc">Either an Array of field definition objects as specified
59 in <a ext:cls="Ext.data.Record" ext:member="create" href="output/Ext.data.Record.html#create">Ext.data.Record.create</a>, or an <a ext:cls="Ext.data.Record" href="output/Ext.data.Record.html">Ext.data.Record</a> object created
60 using <a ext:cls="Ext.data.Record" ext:member="create" href="output/Ext.data.Record.html#create">Ext.data.Record.create</a>.</div></li>        </ul>\r
61         <strong>Returns:</strong>\r
62         <ul>\r
63             <li><code></code></li>\r
64         </ul>\r
65     </div>\r
66                 </div>\r
67                         </div>\r
68         </td>\r
69         <td class="msource">DataReader</td>\r
70     </tr>\r
71             </table>
72                 <a id="Ext.data.DataReader-events"></a>
73         <h2>Public Events</h2>
74         <div class="no-members">This class has no public events.</div>
75         </div>