git.roojs.org Git - roojs1/blob - docs/symbols/Roo.data.DataReader.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2
   3
   4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   5
   6         <head>
   7                 <meta http-equiv="content-type" content="text/html; charset=undefined" />
   8                 <meta name="generator" content="JsDoc Toolkit" />
   9
  10
  11                 <title>JsDoc Reference - Roo.data.DataReader</title>
  12
  13
  14         <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
  15         <link rel="stylesheet" type="text/css" href="../default.css" />
  16
  17
  18         <script type="text/javascript" src="../page.js">
  19
  20         </script>
  21
  22
  23         </head>
  24
  25         <body onload="RooDocsPage.onload();">
  26
  27
  28 <div class="body-wrap">
  29
  30     <!-- ============================== links to methods. ================================= -->
  31
  32     <div class="top-tools">
  33     <!--
  34         <a class="inner-link" href="#Roo.data.DataReader-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.data.DataReader-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.data.DataReader-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.data.DataReader-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>
  39         -->
  40     </div>
  41
  42
  43 <!-- ============================== inheritance Block. ================================= -->
  44
  45 <!-- ============================== class title / details ============================ -->
  46
  47
  48     <h1 class="classTitle">
  49
  50                                 Class Roo.data.DataReader
  51                         </h1>
  52
  53     <table cellspacing="0" class="class-summary-table">
  54
  55                 <tr><td class="label">Package:</td><td class="hd-info">Roo.data</td></tr>
  56
  57         <tr><td class="label">Defined In:</td><td class="hd-info">
  58
  59                                         <a href="./src/Roo_data_DataReader.js.html">Roo/data/DataReader.js</a>.
  60
  61         </td></tr>
  62         <tr><td class="label">Class:</td><td class="hd-info">DataReader</td></tr>
  63
  64
  65         <tr><td class="label">Subclasses:</td><td class="hd-info">
  66                 <a href="./Roo.data.ArrayReader.html#constructor" roo:cls="Roo.data.ArrayReader.html#constructor">Roo.data.ArrayReader</a>, <a href="./Roo.data.JsonReader.html#constructor" roo:cls="Roo.data.JsonReader.html#constructor">Roo.data.JsonReader</a>, <a href="./Roo.data.XmlReader.html#constructor" roo:cls="Roo.data.XmlReader.html#constructor">Roo.data.XmlReader</a>
  67
  68
  69
  70         </td></tr>
  71
  72
  73
  74     </table>
  75
  76
  77 <!-- ============================== class summary ========================== -->
  78     <div class="description">
  79         Base class for reading structured data from a data source.  This class is intended to be<br/>extended (see {Roo.data.ArrayReader}, {Roo.data.JsonReader} and {Roo.data.XmlReader}) and should not be created directly.
  80     </div>
  81
  82
  83 <!-- ============================== Class comment block... ========================== -->
  84
  85 <div class="comments">
  86         <b>Class Comments / Notes</B> =>
  87         <u onclick="parent.CommentDialog.showCommentId = 'Roo.data.DataReader';">[Add Your comment/notes about this class]</u>
  88         <br/>
  89         <iframe frameborder="0"  id="comments-Roo.data" style="border: none;width:100%;"
  90                 src="/blog.php/GtkDjsComments/Roo.data.DataReader.html"></iframe>
  91 </div>
  92
  93
  94
  95 <!-- ============================== config options ========================== -->
  96
  97
  98
  99
 100     <div class="hr"></div>
 101     <a id="Roo.data.DataReader-configs"></a>
 102
 103
 104
 105      <table cellspacing="0" class="member-table">
 106       <caption class="Empty">Config Options - Has None</caption>
 107      </table>
 108
 109
 110
 111
 112
 113
 114
 115
 116
 117
 118
 119
 120   <!-- ============================== public properties ==================== -->
 121
 122
 123
 124     <a id="Roo.data.DataReader-props"></a>
 125
 126
 127
 128
 129
 130      <table cellspacing="0" class="member-table">
 131       <caption class="Empty">Public Properties - Has None</caption>
 132      </table>
 133
 134
 135
 136
 137   <!-- ============================== methods summary / details ======================== -->
 138
 139
 140   <a id="Roo.data.DataReader-methods"></a>
 141         <!-- constructor?? -->
 142
 143         <!-- static's first
 144
 145
 146         -->
 147
 148         <!-- then dynamics first -->
 149
 150
 151
 152
 153
 154
 155       <table cellspacing="0" class="member-table">
 156       <caption>Public Methods</caption>
 157         <tr>
 158             <th class="sig-header" colspan="2">Method</th>
 159             <th class="msource-header">Defined By</th>
 160
 161         </tr>
 162
 163
 164
 165
 166
 167
 168
 169           <tr class="method-row config-row-alt0 notInherited">
 170             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 171
 172
 173             <td class="sig">
 174                 <a id="Roo.data-method-DataReader"   name=".DataReader"></a>
 175                 <div class="fixedFont">
 176                         <span class="attributes">new <B>Roo.data.</B></span><b class="itemname">DataReader</b>
 177
 178                                  ()
 179
 180
 181
 182                 </div>
 183                 <div class="mdesc">
 184
 185
 186                         <div class="short">Create a new Roo.data.DataReader</div>
 187
 188
 189                     <div class="long">
 190
 191
 192
 193                                 Create a new Roo.data.DataReader
 194
 195
 196
 197
 198
 199
 200
 201
 202
 203
 204
 205
 206                     </div>
 207                 </div>
 208
 209             </td>
 210             <td class="msource">
 211                 &nbsp;
 212             </td>
 213         </tr>
 214
 215
 216           <tr class="method-row config-row-alt1 expandable notInherited">
 217             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 218
 219
 220             <td class="sig">
 221                 <a id="Roo.data.DataReader-method-newRow"   name=".newRow"></a>
 222                 <div class="fixedFont">
 223                         <span class="attributes"></span><b class="itemname">newRow</b>
 224
 225                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>data</i></B>)
 226
 227
 228                                          :
 229
 230
 231                                                 <a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a>
 232
 233
 234
 235
 236
 237                 </div>
 238                 <div class="mdesc">
 239
 240                    <div class="short">Create an empty record</div>
 241
 242
 243
 244                     <div class="long">
 245
 246                                 Create an empty record
 247
 248
 249
 250
 251
 252
 253                                 <dl class="detailList">
 254                                 <dt class="heading">Parameters:</dt>
 255
 256                                         <dt>
 257                                                 <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>
 258
 259                                         </dt>
 260                                         <dd>(optional) - overlay some values</dd>
 261
 262                                 </dl>
 263
 264
 265
 266
 267
 268                                 <dl class="detailList">
 269                                 <dt class="heading">Returns:</dt>
 270
 271                                         <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>
 272
 273                                 </dl>
 274
 275
 276
 277
 278
 279
 280
 281                     </div>
 282                 </div>
 283
 284             </td>
 285             <td class="msource">
 286
 287                         Roo.data.DataReader
 288                 &nbsp;
 289             </td>
 290         </tr>
 291
 292
 293     </table>
 294
 295
 296   <!-- ============================== events summary / details ======================== -->
 297
 298
 299   <a id="Roo.data.DataReader-events"></a>
 300
 301
 302
 303
 304
 305      <table cellspacing="0" class="member-table">
 306       <caption class="Empty">Events - Has None</caption>
 307      </table>
 308
 309
 310
 311
 312
 313
 314
 315
 316
 317 <!-- ============================== footer ================================= -->
 318                 <div class="fineprint" style="clear:both">
 319
 320                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Tue Jul 27 2010 11:05:07 GMT+0800 (HKT)
 321                         Based on
 322                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
 323                 </div>
 324         </body>
 325 </html>