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