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