git.roojs.org Git - roojs1/blob - docs/symbols/Roo.data.JsonReader.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.JsonReader</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.JsonReader-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.data.JsonReader-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.data.JsonReader-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.data.JsonReader-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.JsonReader
  48
  49                    </pre>
  50                 </div>
  51
  52 <!-- ============================== class title / details ============================ -->
  53
  54
  55     <h1 class="classTitle">
  56
  57                                 Class Roo.data.JsonReader
  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_JsonReader.js.html">Roo/data/JsonReader.js</a>.
  67
  68         </td></tr>
  69         <tr><td class="label">Class:</td><td class="hd-info">JsonReader</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 a JSON response<br/>based on mappings in a provided Roo.data.Record constructor.<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>
  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.JsonReader';">[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.JsonReader.html"></iframe>
  97 </div>
  98
  99
 100
 101 <!-- ============================== config options ========================== -->
 102
 103
 104
 105
 106     <div class="hr"></div>
 107     <a id="Roo.data.JsonReader-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.JsonReader-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">Name of the property within a row object that contains a record identifier value.</div>
 140                         </div>
 141
 142                         <div class="mdesc">
 143                             <div class="long">Name of the property within a row object that contains a record identifier value.</div>
 144                         </div>
 145
 146
 147
 148                     </td>
 149                     <td class="msource">
 150
 151                         Roo.data.JsonReader
 152
 153                     </td>
 154                 </tr>
 155
 156
 157                 <tr class="config-row expandable config-row-alt1 notInherited">
 158                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 159                     <td class="sig">
 160
 161                         <a id="Roo.data.JsonReader-cfg-root" name=".root"></a>
 162                         <div class="fixedFont">
 163                                 <b  class="itemname">root</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 164
 165
 166                         </div>
 167
 168                         <div class="mdesc">
 169                             <div class="short">name of the property which contains the Array of row objects.</div>
 170                         </div>
 171
 172                         <div class="mdesc">
 173                             <div class="long">name of the property which contains the Array of row objects.</div>
 174                         </div>
 175
 176
 177
 178                     </td>
 179                     <td class="msource">
 180
 181                         Roo.data.JsonReader
 182
 183                     </td>
 184                 </tr>
 185
 186
 187                 <tr class="config-row expandable config-row-alt0 notInherited">
 188                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 189                     <td class="sig">
 190
 191                         <a id="Roo.data.JsonReader-cfg-successProperty" name=".successProperty"></a>
 192                         <div class="fixedFont">
 193                                 <b  class="itemname">successProperty</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 194
 195
 196                         </div>
 197
 198                         <div class="mdesc">
 199                             <div class="short">Name of the property from which to retrieve the success attribute used by forms.</div>
 200                         </div>
 201
 202                         <div class="mdesc">
 203                             <div class="long">Name of the property from which to retrieve the success attribute used by forms.</div>
 204                         </div>
 205
 206
 207
 208                     </td>
 209                     <td class="msource">
 210
 211                         Roo.data.JsonReader
 212
 213                     </td>
 214                 </tr>
 215
 216
 217                 <tr class="config-row expandable config-row-alt1 notInherited">
 218                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 219                     <td class="sig">
 220
 221                         <a id="Roo.data.JsonReader-cfg-totalProperty" name=".totalProperty"></a>
 222                         <div class="fixedFont">
 223                                 <b  class="itemname">totalProperty</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 224
 225
 226                         </div>
 227
 228                         <div class="mdesc">
 229                             <div class="short">Name of the property from which to retrieve the total number of records<br/>in the dataset.</div>
 230                         </div>
 231
 232                         <div class="mdesc">
 233                             <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>
 234                         </div>
 235
 236
 237
 238                     </td>
 239                     <td class="msource">
 240
 241                         Roo.data.JsonReader
 242
 243                     </td>
 244                 </tr>
 245
 246
 247     </table>
 248
 249
 250
 251
 252
 253
 254
 255
 256
 257   <!-- ============================== public properties ==================== -->
 258
 259
 260
 261     <a id="Roo.data.JsonReader-props"></a>
 262
 263
 264
 265
 266
 267      <table cellspacing="0" class="member-table">
 268       <caption class="Empty">Public Properties - Has None</caption>
 269      </table>
 270
 271
 272
 273
 274   <!-- ============================== methods summary / details ======================== -->
 275
 276
 277   <a id="Roo.data.JsonReader-methods"></a>
 278         <!-- constructor?? -->
 279
 280         <!-- static's first
 281
 282
 283         -->
 284
 285         <!-- then dynamics first -->
 286
 287
 288
 289
 290
 291
 292       <table cellspacing="0" class="member-table">
 293       <caption>Public Methods</caption>
 294         <tr>
 295             <th class="sig-header" colspan="2">Method</th>
 296             <th class="msource-header">Defined By</th>
 297
 298         </tr>
 299
 300
 301
 302
 303
 304
 305
 306           <tr class="method-row config-row-alt0 expandable notInherited">
 307             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 308
 309
 310             <td class="sig">
 311                 <a id="Roo.data-method-JsonReader"   name=".JsonReader"></a>
 312                 <div class="fixedFont">
 313                         <span class="attributes">new <B>Roo.data.</B></span><b class="itemname">JsonReader</b>
 314
 315                                  (<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>)
 316
 317
 318
 319                 </div>
 320                 <div class="mdesc">
 321
 322
 323                         <div class="short">Create a new Roo.data.JsonReader</div>
 324
 325
 326                     <div class="long">
 327
 328
 329
 330                                 Create a new Roo.data.JsonReader
 331
 332
 333                                 <dl class="detailList">
 334                                 <dt class="heading">Parameters:</dt>
 335
 336                                         <dt>
 337                                                 <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>
 338
 339                                         </dt>
 340                                         <dd>Metadata configuration options</dd>
 341
 342                                         <dt>
 343                                                 <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>
 344
 345                                         </dt>
 346                                         <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>
 347
 348                                 </dl>
 349
 350
 351
 352
 353
 354
 355
 356
 357
 358
 359
 360                     </div>
 361                 </div>
 362
 363             </td>
 364             <td class="msource">
 365                 &nbsp;
 366             </td>
 367         </tr>
 368
 369
 370           <tr class="method-row config-row-alt1 expandable">
 371             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 372
 373
 374             <td class="sig">
 375                 <a id="Roo.data.DataReader-method-newRow"   name=".newRow"></a>
 376                 <div class="fixedFont">
 377                         <span class="attributes"></span><b class="itemname">newRow</b>
 378
 379                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>data</i></B>)
 380
 381
 382                                          :
 383
 384
 385                                                 <a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a>
 386
 387
 388
 389
 390
 391                 </div>
 392                 <div class="mdesc">
 393
 394                    <div class="short">Create an empty record</div>
 395
 396
 397
 398                     <div class="long">
 399
 400                                 Create an empty record
 401
 402
 403
 404
 405
 406
 407                                 <dl class="detailList">
 408                                 <dt class="heading">Parameters:</dt>
 409
 410                                         <dt>
 411                                                 <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>
 412
 413                                         </dt>
 414                                         <dd>(optional) - overlay some values</dd>
 415
 416                                 </dl>
 417
 418
 419
 420
 421
 422                                 <dl class="detailList">
 423                                 <dt class="heading">Returns:</dt>
 424
 425                                         <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>
 426
 427                                 </dl>
 428
 429
 430
 431
 432
 433
 434
 435                     </div>
 436                 </div>
 437
 438             </td>
 439             <td class="msource">
 440
 441                         <a href="./Roo.data.DataReader.html#constructor" roo:cls="Roo.data.DataReader.html#constructor">Roo.data.DataReader</a>
 442                 &nbsp;
 443             </td>
 444         </tr>
 445
 446
 447           <tr class="method-row config-row-alt0 expandable notInherited">
 448             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 449
 450
 451             <td class="sig">
 452                 <a id="Roo.data.JsonReader-method-read"   name=".read"></a>
 453                 <div class="fixedFont">
 454                         <span class="attributes"></span><b class="itemname">read</b>
 455
 456                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>response</i></B>)
 457
 458
 459                                          :
 460
 461
 462                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
 463
 464
 465
 466
 467
 468                 </div>
 469                 <div class="mdesc">
 470
 471                    <div class="short">This method is only used by a DataProxy which has retrieved data from a remote server.</div>
 472
 473
 474
 475                     <div class="long">
 476
 477                                 This method is only used by a DataProxy which has retrieved data from a remote server.
 478
 479
 480
 481
 482
 483
 484                                 <dl class="detailList">
 485                                 <dt class="heading">Parameters:</dt>
 486
 487                                         <dt>
 488                                                 <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>
 489
 490                                         </dt>
 491                                         <dd>The XHR object which contains the JSON data in its responseText.</dd>
 492
 493                                 </dl>
 494
 495
 496
 497
 498
 499                                 <dl class="detailList">
 500                                 <dt class="heading">Returns:</dt>
 501
 502                                         <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>
 503
 504                                 </dl>
 505
 506
 507
 508
 509
 510
 511
 512                     </div>
 513                 </div>
 514
 515             </td>
 516             <td class="msource">
 517
 518                         Roo.data.JsonReader
 519                 &nbsp;
 520             </td>
 521         </tr>
 522
 523
 524           <tr class="method-row config-row-alt1 expandable notInherited">
 525             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 526
 527
 528             <td class="sig">
 529                 <a id="Roo.data.JsonReader-method-readRecords"   name=".readRecords"></a>
 530                 <div class="fixedFont">
 531                         <span class="attributes"></span><b class="itemname">readRecords</b>
 532
 533                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>o</i></B>)
 534
 535
 536                                          :
 537
 538
 539                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
 540
 541
 542
 543
 544
 545                 </div>
 546                 <div class="mdesc">
 547
 548                    <div class="short">Create a data block containing Roo.data.Records from an XML document.</div>
 549
 550
 551
 552                     <div class="long">
 553
 554                                 Create a data block containing Roo.data.Records from an XML document.
 555
 556
 557
 558
 559
 560
 561                                 <dl class="detailList">
 562                                 <dt class="heading">Parameters:</dt>
 563
 564                                         <dt>
 565                                                 <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>
 566
 567                                         </dt>
 568                                         <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>
 569
 570                                 </dl>
 571
 572
 573
 574
 575
 576                                 <dl class="detailList">
 577                                 <dt class="heading">Returns:</dt>
 578
 579                                         <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>
 580
 581                                 </dl>
 582
 583
 584
 585
 586
 587
 588
 589                     </div>
 590                 </div>
 591
 592             </td>
 593             <td class="msource">
 594
 595                         Roo.data.JsonReader
 596                 &nbsp;
 597             </td>
 598         </tr>
 599
 600
 601     </table>
 602
 603
 604   <!-- ============================== events summary / details ======================== -->
 605
 606
 607   <a id="Roo.data.JsonReader-events"></a>
 608
 609
 610
 611
 612
 613      <table cellspacing="0" class="member-table">
 614       <caption class="Empty">Events - Has None</caption>
 615      </table>
 616
 617
 618
 619
 620
 621
 622
 623
 624
 625 <!-- ============================== footer ================================= -->
 626                 <div class="fineprint" style="clear:both">
 627
 628                         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)
 629                         Based on
 630                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
 631                 </div>
 632         </body>
 633 </html>