git.roojs.org Git - roojs1/blob - docs/symbols/Roo.data.ArrayReader.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.ArrayReader</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.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>
  39         -->
  40     </div>
  41
  42
  43 <!-- ============================== inheritance Block. ================================= -->
  44
  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
  48
  49                    </pre>
  50                 </div>
  51
  52 <!-- ============================== class title / details ============================ -->
  53
  54
  55     <h1 class="classTitle">
  56
  57                                 Class Roo.data.ArrayReader
  58                         </h1>
  59
  60     <table cellspacing="0" class="class-summary-table">
  61
  62                 <tr><td class="label">Package:</td><td class="hd-info">Roo.data</td></tr>
  63
  64         <tr><td class="label">Defined In:</td><td class="hd-info">
  65
  66                                         <a href="./src/Roo_data_ArrayReader.js.html">Roo/data/ArrayReader.js</a>.
  67
  68         </td></tr>
  69         <tr><td class="label">Class:</td><td class="hd-info">ArrayReader</td></tr>
  70
  71
  72
  73
  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>
  76
  77                 </td></tr>
  78
  79
  80     </table>
  81
  82
  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>
  86     </div>
  87
  88
  89 <!-- ============================== Class comment block... ========================== -->
  90
  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>
  94         <br/>
  95         <iframe frameborder="0"  id="comments-Roo.data" style="border: none;width:100%;"
  96                 src="/blog.php/GtkDjsComments/Roo.data.ArrayReader.html"></iframe>
  97 </div>
  98
  99
 100
 101 <!-- ============================== config options ========================== -->
 102
 103
 104
 105
 106     <div class="hr"></div>
 107     <a id="Roo.data.ArrayReader-configs"></a>
 108
 109
 110
 111
 112
 113       <table cellspacing="0" class="member-table">
 114       <caption>Config Options (Usually are also Properties)</caption>
 115
 116
 117         <tr>
 118             <th class="sig-header" colspan="2">Options</th>
 119
 120             <th class="msource-header">Defined By</th>
 121         </tr>
 122
 123
 124
 125
 126
 127                 <tr class="config-row expandable config-row-alt0 notInherited">
 128                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 129                     <td class="sig">
 130
 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>
 134
 135
 136                         </div>
 137
 138                         <div class="mdesc">
 139                             <div class="short">(optional) The subscript within row Array that provides an ID for the Record</div>
 140                         </div>
 141
 142                         <div class="mdesc">
 143                             <div class="long">(optional) The subscript within row Array that provides an ID for the Record</div>
 144                         </div>
 145
 146
 147
 148                     </td>
 149                     <td class="msource">
 150
 151                         Roo.data.ArrayReader
 152
 153                     </td>
 154                 </tr>
 155
 156
 157     </table>
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167   <!-- ============================== public properties ==================== -->
 168
 169
 170
 171     <a id="Roo.data.ArrayReader-props"></a>
 172
 173
 174
 175
 176
 177      <table cellspacing="0" class="member-table">
 178       <caption class="Empty">Public Properties - Has None</caption>
 179      </table>
 180
 181
 182
 183
 184   <!-- ============================== methods summary / details ======================== -->
 185
 186
 187   <a id="Roo.data.ArrayReader-methods"></a>
 188         <!-- constructor?? -->
 189
 190         <!-- static's first
 191
 192
 193         -->
 194
 195         <!-- then dynamics first -->
 196
 197
 198
 199
 200
 201
 202       <table cellspacing="0" class="member-table">
 203       <caption>Public Methods</caption>
 204         <tr>
 205             <th class="sig-header" colspan="2">Method</th>
 206             <th class="msource-header">Defined By</th>
 207
 208         </tr>
 209
 210
 211
 212
 213
 214
 215
 216           <tr class="method-row config-row-alt0 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-method-ArrayReader"   name=".ArrayReader"></a>
 222                 <div class="fixedFont">
 223                         <span class="attributes">new <B>Roo.data.</B></span><b class="itemname">ArrayReader</b>
 224
 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>)
 226
 227
 228
 229                 </div>
 230                 <div class="mdesc">
 231
 232
 233                         <div class="short">Create a new Roo.data.ArrayReader</div>
 234
 235
 236                     <div class="long">
 237
 238
 239
 240                                 Create a new Roo.data.ArrayReader
 241
 242
 243                                 <dl class="detailList">
 244                                 <dt class="heading">Parameters:</dt>
 245
 246                                         <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>
 248
 249                                         </dt>
 250                                         <dd>Metadata configuration options.</dd>
 251
 252                                         <dt>
 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>
 254
 255                                         </dt>
 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>
 257
 258                                 </dl>
 259
 260
 261
 262
 263
 264
 265
 266
 267
 268
 269
 270                     </div>
 271                 </div>
 272
 273             </td>
 274             <td class="msource">
 275                 &nbsp;
 276             </td>
 277         </tr>
 278
 279
 280           <tr class="method-row config-row-alt1 expandable">
 281             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 282
 283
 284             <td class="sig">
 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>
 288
 289                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>data</i></B>)
 290
 291
 292                                          :
 293
 294
 295                                                 <a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a>
 296
 297
 298
 299
 300
 301                 </div>
 302                 <div class="mdesc">
 303
 304                    <div class="short">Create an empty record</div>
 305
 306
 307
 308                     <div class="long">
 309
 310                                 Create an empty record
 311
 312
 313
 314
 315
 316
 317                                 <dl class="detailList">
 318                                 <dt class="heading">Parameters:</dt>
 319
 320                                         <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>
 322
 323                                         </dt>
 324                                         <dd>(optional) - overlay some values</dd>
 325
 326                                 </dl>
 327
 328
 329
 330
 331
 332                                 <dl class="detailList">
 333                                 <dt class="heading">Returns:</dt>
 334
 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>
 336
 337                                 </dl>
 338
 339
 340
 341
 342
 343
 344
 345                     </div>
 346                 </div>
 347
 348             </td>
 349             <td class="msource">
 350
 351                         <a href="./Roo.data.DataReader.html#constructor" roo:cls="Roo.data.DataReader.html#constructor">Roo.data.DataReader</a>
 352                 &nbsp;
 353             </td>
 354         </tr>
 355
 356
 357           <tr class="method-row config-row-alt0 expandable notInherited">
 358             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 359
 360
 361             <td class="sig">
 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>
 365
 366                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>o</i></B>)
 367
 368
 369                                          :
 370
 371
 372                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
 373
 374
 375
 376
 377
 378                 </div>
 379                 <div class="mdesc">
 380
 381                    <div class="short">Create a data block containing Roo.data.Records from an XML document.</div>
 382
 383
 384
 385                     <div class="long">
 386
 387                                 Create a data block containing Roo.data.Records from an XML document.
 388
 389
 390
 391
 392
 393
 394                                 <dl class="detailList">
 395                                 <dt class="heading">Parameters:</dt>
 396
 397                                         <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>
 399
 400                                         </dt>
 401                                         <dd>An Array of row objects which represents the dataset.</dd>
 402
 403                                 </dl>
 404
 405
 406
 407
 408
 409                                 <dl class="detailList">
 410                                 <dt class="heading">Returns:</dt>
 411
 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>
 413
 414                                 </dl>
 415
 416
 417
 418
 419
 420
 421
 422                     </div>
 423                 </div>
 424
 425             </td>
 426             <td class="msource">
 427
 428                         Roo.data.ArrayReader
 429                 &nbsp;
 430             </td>
 431         </tr>
 432
 433
 434     </table>
 435
 436
 437   <!-- ============================== events summary / details ======================== -->
 438
 439
 440   <a id="Roo.data.ArrayReader-events"></a>
 441
 442
 443
 444
 445
 446      <table cellspacing="0" class="member-table">
 447       <caption class="Empty">Events - Has None</caption>
 448      </table>
 449
 450
 451
 452
 453
 454
 455
 456
 457
 458 <!-- ============================== footer ================================= -->
 459                 <div class="fineprint" style="clear:both">
 460
 461                         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)
 462                         Based on
 463                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
 464                 </div>
 465         </body>
 466 </html>