git.roojs.org Git - roojs1/blob - docs.old/symbols/Roo.data.JsonStore.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.JsonStore</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.JsonStore-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.data.JsonStore-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.data.JsonStore-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.data.JsonStore-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.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
  47 <img src="../../images/default/s.gif" height="1" width="20"/><img src="../../images/default/tree/elbow-end.gif" class="elbow"/><a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
  48 <img src="../../images/default/s.gif" height="1"  width="40"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.data.JsonStore
  49
  50                    </pre>
  51                 </div>
  52
  53 <!-- ============================== class title / details ============================ -->
  54
  55
  56     <h1 class="classTitle">
  57
  58                                 Class Roo.data.JsonStore
  59                         </h1>
  60
  61     <table cellspacing="0" class="class-summary-table">
  62
  63                 <tr><td class="label">Package:</td><td class="hd-info">Roo.data</td></tr>
  64
  65         <tr><td class="label">Defined In:</td><td class="hd-info">
  66
  67                                         <a href="./src/Roo_data_JsonStore.js.html">Roo/data/JsonStore.js</a>.
  68
  69         </td></tr>
  70         <tr><td class="label">Class:</td><td class="hd-info">JsonStore</td></tr>
  71
  72
  73
  74
  75                 <tr><td class="label">Extends:</td><td class="hd-info">
  76                         <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
  77
  78                 </td></tr>
  79
  80
  81     </table>
  82
  83
  84 <!-- ============================== class summary ========================== -->
  85     <div class="description">
  86         /**
  87     </div>
  88
  89
  90 <!-- ============================== Class comment block... ========================== -->
  91
  92 <div class="comments">
  93         <b>Class Comments / Notes</B> =>
  94         <u onclick="parent.CommentDialog.showCommentId = 'Roo.data.JsonStore';">[Add Your comment/notes about this class]</u>
  95         <br/>
  96         <iframe frameborder="0"  id="comments-Roo.data" style="border: none;width:100%;"
  97                 src="/blog.php/GtkDjsComments/Roo.data.JsonStore.html"></iframe>
  98 </div>
  99
 100
 101
 102 <!-- ============================== config options ========================== -->
 103
 104
 105
 106
 107     <div class="hr"></div>
 108     <a id="Roo.data.JsonStore-configs"></a>
 109
 110
 111
 112
 113
 114       <table cellspacing="0" class="member-table">
 115       <caption>Config Options (Usually are also Properties)</caption>
 116
 117
 118         <tr>
 119             <th class="sig-header" colspan="2">Options</th>
 120
 121             <th class="msource-header">Defined By</th>
 122         </tr>
 123
 124
 125
 126
 127
 128                 <tr class="config-row expandable config-row-alt0">
 129                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 130                     <td class="sig">
 131
 132                         <a id="Roo.data.Store-cfg-baseParams" name=".baseParams"></a>
 133                         <div class="fixedFont">
 134                                 <b  class="itemname">baseParams</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
 135
 136
 137                         </div>
 138
 139                         <div class="mdesc">
 140                             <div class="short">An object containing properties which are to be sent as parameters<br/>on any HTTP request</div>
 141                         </div>
 142
 143                         <div class="mdesc">
 144                             <div class="long">
 145                     An object containing properties which are to be sent as parameters<br/>on any HTTP request
 146
 147                 </div>
 148                         </div>
 149
 150
 151
 152                     </td>
 153                     <td class="msource">
 154
 155                         <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
 156
 157                     </td>
 158                 </tr>
 159
 160
 161                 <tr class="config-row expandable config-row-alt1">
 162                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 163                     <td class="sig">
 164
 165                         <a id="Roo.data.Store-cfg-data" name=".data"></a>
 166                         <div class="fixedFont">
 167                                 <b  class="itemname">data</b> : <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
 168
 169
 170                         </div>
 171
 172                         <div class="mdesc">
 173                             <div class="short">Inline data to be loaded when the store is initialized.</div>
 174                         </div>
 175
 176                         <div class="mdesc">
 177                             <div class="long">
 178                     Inline data to be loaded when the store is initialized.
 179
 180                 </div>
 181                         </div>
 182
 183
 184
 185                     </td>
 186                     <td class="msource">
 187
 188                         <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
 189
 190                     </td>
 191                 </tr>
 192
 193
 194                 <tr class="config-row expandable config-row-alt0 notInherited">
 195                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 196                     <td class="sig">
 197
 198                         <a id="Roo.data.JsonStore-cfg-fields" name=".fields"></a>
 199                         <div class="fixedFont">
 200                                 <b  class="itemname">fields</b> : <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
 201
 202
 203                         </div>
 204
 205                         <div class="mdesc">
 206                             <div class="short">An array of field definition objects, or field name strings.</div>
 207                         </div>
 208
 209                         <div class="mdesc">
 210                             <div class="long">
 211                     An array of field definition objects, or field name strings.
 212
 213                 </div>
 214                         </div>
 215
 216
 217
 218                     </td>
 219                     <td class="msource">
 220
 221                         Roo.data.JsonStore
 222
 223                     </td>
 224                 </tr>
 225
 226
 227                 <tr class="config-row expandable config-row-alt1">
 228                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 229                     <td class="sig">
 230
 231                         <a id="Roo.data.Store-cfg-isLocal" name=".isLocal"></a>
 232                         <div class="fixedFont">
 233                                 <b  class="itemname">isLocal</b> : boolean
 234
 235
 236                         </div>
 237
 238                         <div class="mdesc">
 239                             <div class="short">flag if data is locally available (and can be always looked up<br/>without a remote query - used by combo/forms at present.</div>
 240                         </div>
 241
 242                         <div class="mdesc">
 243                             <div class="long">
 244                     flag if data is locally available (and can be always looked up<br/>without a remote query - used by combo/forms at present.
 245
 246                 </div>
 247                         </div>
 248
 249
 250
 251                     </td>
 252                     <td class="msource">
 253
 254                         <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
 255
 256                     </td>
 257                 </tr>
 258
 259
 260                 <tr class="config-row expandable config-row-alt0">
 261                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 262                     <td class="sig">
 263
 264                         <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
 265                         <div class="fixedFont">
 266                                 <b  class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
 267
 268
 269                         </div>
 270
 271                         <div class="mdesc">
 272                             <div class="short">list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/>    listeners :  { <br/>       'click' : function(e) {<br/>           .</div>
 273                         </div>
 274
 275                         <div class="mdesc">
 276                             <div class="long">
 277                     list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/>    listeners :  { <br/>       'click' : function(e) {<br/>           ..... <br/>        } ,<br/>        .... <br/>    } <br/>  </code></pre>
 278
 279                 </div>
 280                         </div>
 281
 282
 283
 284                     </td>
 285                     <td class="msource">
 286
 287                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 288
 289                     </td>
 290                 </tr>
 291
 292
 293                 <tr class="config-row expandable config-row-alt1">
 294                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 295                     <td class="sig">
 296
 297                         <a id="Roo.data.Store-cfg-multiSort" name=".multiSort"></a>
 298                         <div class="fixedFont">
 299                                 <b  class="itemname">multiSort</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 300
 301
 302                         </div>
 303
 304                         <div class="mdesc">
 305                             <div class="short">enable multi column sorting (sort is based on the order of columns, remote only at present)</div>
 306                         </div>
 307
 308                         <div class="mdesc">
 309                             <div class="long">
 310                     enable multi column sorting (sort is based on the order of columns, remote only at present)
 311
 312                 </div>
 313                         </div>
 314
 315
 316
 317                     </td>
 318                     <td class="msource">
 319
 320                         <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
 321
 322                     </td>
 323                 </tr>
 324
 325
 326                 <tr class="config-row expandable config-row-alt0">
 327                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 328                     <td class="sig">
 329
 330                         <a id="Roo.data.Store-cfg-proxy" name=".proxy"></a>
 331                         <div class="fixedFont">
 332                                 <b  class="itemname">proxy</b> : <a href="./Roo.data.DataProxy.html#constructor" roo:cls="Roo.data.DataProxy.html#constructor">Roo.data.DataProxy</a>
 333
 334
 335                         </div>
 336
 337                         <div class="mdesc">
 338                             <div class="short">The Proxy object which provides access to a data object.</div>
 339                         </div>
 340
 341                         <div class="mdesc">
 342                             <div class="long">
 343                     The Proxy object which provides access to a data object.
 344
 345                 </div>
 346                         </div>
 347
 348
 349
 350                     </td>
 351                     <td class="msource">
 352
 353                         <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
 354
 355                     </td>
 356                 </tr>
 357
 358
 359                 <tr class="config-row expandable config-row-alt1">
 360                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 361                     <td class="sig">
 362
 363                         <a id="Roo.data.Store-cfg-pruneModifiedRecords" name=".pruneModifiedRecords"></a>
 364                         <div class="fixedFont">
 365                                 <b  class="itemname">pruneModifiedRecords</b> : boolean
 366
 367
 368                         </div>
 369
 370                         <div class="mdesc">
 371                             <div class="short">True to clear all modified record information each time the store is<br/>loaded or when a record is removed.</div>
 372                         </div>
 373
 374                         <div class="mdesc">
 375                             <div class="long">
 376                     True to clear all modified record information each time the store is<br/>loaded or when a record is removed. (defaults to false).
 377
 378                 </div>
 379                         </div>
 380
 381
 382
 383                     </td>
 384                     <td class="msource">
 385
 386                         <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
 387
 388                     </td>
 389                 </tr>
 390
 391
 392                 <tr class="config-row expandable config-row-alt0">
 393                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 394                     <td class="sig">
 395
 396                         <a id="Roo.data.Store-cfg-reader" name=".reader"></a>
 397                         <div class="fixedFont">
 398                                 <b  class="itemname">reader</b> : Roo.data.Reader
 399
 400
 401                         </div>
 402
 403                         <div class="mdesc">
 404                             <div class="short">The Reader object which processes the data object and returns<br/>an Array of Roo.data.record objects which are cached keyed by their <em>id</em> property.</div>
 405                         </div>
 406
 407                         <div class="mdesc">
 408                             <div class="long">
 409                     The Reader object which processes the data object and returns<br/>an Array of Roo.data.record objects which are cached keyed by their <em>id</em> property.
 410
 411                 </div>
 412                         </div>
 413
 414
 415
 416                     </td>
 417                     <td class="msource">
 418
 419                         <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
 420
 421                     </td>
 422                 </tr>
 423
 424
 425                 <tr class="config-row expandable config-row-alt1">
 426                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 427                     <td class="sig">
 428
 429                         <a id="Roo.data.Store-cfg-remoteSort" name=".remoteSort"></a>
 430                         <div class="fixedFont">
 431                                 <b  class="itemname">remoteSort</b> : boolean
 432
 433
 434                         </div>
 435
 436                         <div class="mdesc">
 437                             <div class="short">True if sorting is to be handled by requesting the Proxy to provide a refreshed<br/>version of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false).</div>
 438                         </div>
 439
 440                         <div class="mdesc">
 441                             <div class="long">
 442                     True if sorting is to be handled by requesting the Proxy to provide a refreshed<br/>version of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false).
 443
 444                 </div>
 445                         </div>
 446
 447
 448
 449                     </td>
 450                     <td class="msource">
 451
 452                         <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
 453
 454                     </td>
 455                 </tr>
 456
 457
 458                 <tr class="config-row expandable config-row-alt0">
 459                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 460                     <td class="sig">
 461
 462                         <a id="Roo.data.Store-cfg-sortInfo" name=".sortInfo"></a>
 463                         <div class="fixedFont">
 464                                 <b  class="itemname">sortInfo</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
 465
 466
 467                         </div>
 468
 469                         <div class="mdesc">
 470                             <div class="short">A config object in the format: {field: "fieldName", direction: "ASC|DESC"}</div>
 471                         </div>
 472
 473                         <div class="mdesc">
 474                             <div class="long">
 475                     A config object in the format: {field: "fieldName", direction: "ASC|DESC"}
 476
 477                 </div>
 478                         </div>
 479
 480
 481
 482                     </td>
 483                     <td class="msource">
 484
 485                         <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
 486
 487                     </td>
 488                 </tr>
 489
 490
 491     </table>
 492
 493
 494
 495
 496
 497
 498
 499
 500
 501   <!-- ============================== public properties ==================== -->
 502
 503
 504
 505     <a id="Roo.data.JsonStore-props"></a>
 506
 507
 508
 509
 510
 511      <table cellspacing="0" class="member-table">
 512       <caption class="Empty">Public Properties - Has None</caption>
 513      </table>
 514
 515
 516
 517
 518   <!-- ============================== methods summary / details ======================== -->
 519
 520
 521   <a id="Roo.data.JsonStore-methods"></a>
 522         <!-- constructor?? -->
 523
 524         <!-- static's first
 525
 526
 527         -->
 528
 529         <!-- then dynamics first -->
 530
 531
 532
 533
 534
 535
 536       <table cellspacing="0" class="member-table">
 537       <caption>Public Methods</caption>
 538         <tr>
 539             <th class="sig-header" colspan="2">Method</th>
 540             <th class="msource-header">Defined By</th>
 541
 542         </tr>
 543
 544
 545
 546
 547
 548
 549
 550           <tr class="method-row config-row-alt0 expandable notInherited">
 551             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 552
 553
 554             <td class="sig">
 555                 <a id="Roo.data-method-JsonStore"   name=".JsonStore"></a>
 556                 <div class="fixedFont">
 557                         <span class="attributes">new <B>Roo.data.</B></span><b class="itemname">JsonStore</b>
 558
 559                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
 560
 561
 562
 563                 </div>
 564                 <div class="mdesc">
 565
 566
 567                         <div class="short">Create a new Roo.data.JsonStore</div>
 568
 569
 570                     <div class="long">
 571
 572
 573
 574                                 Create a new Roo.data.JsonStore
 575
 576
 577                                 <dl class="detailList">
 578                                 <dt class="heading">Parameters:</dt>
 579
 580                                         <dt>
 581                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>config</b>
 582
 583                                         </dt>
 584                                         <dd></dd>
 585
 586                                 </dl>
 587
 588
 589
 590
 591
 592
 593
 594
 595
 596
 597
 598                     </div>
 599                 </div>
 600
 601             </td>
 602             <td class="msource">
 603                 &nbsp;
 604             </td>
 605         </tr>
 606
 607
 608           <tr class="method-row config-row-alt1 expandable">
 609             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 610
 611
 612             <td class="sig">
 613                 <a id="Roo.data.Store-method-add"   name=".add"></a>
 614                 <div class="fixedFont">
 615                         <span class="attributes"></span><b class="itemname">add</b>
 616
 617                                  (<a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a>[] <B><i>records</i></B>)
 618
 619
 620
 621                 </div>
 622                 <div class="mdesc">
 623
 624                    <div class="short">Add Records to the Store and fires the add event.</div>
 625
 626
 627
 628                     <div class="long">
 629
 630                                 Add Records to the Store and fires the add event.
 631
 632
 633
 634
 635
 636
 637                                 <dl class="detailList">
 638                                 <dt class="heading">Parameters:</dt>
 639
 640                                         <dt>
 641                                                 <span class="fixedFont"><a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a>[]</span>  <b>records</b>
 642
 643                                         </dt>
 644                                         <dd>An Array of Roo.data.Record objects to add to the cache.</dd>
 645
 646                                 </dl>
 647
 648
 649
 650
 651
 652
 653
 654
 655
 656
 657
 658                     </div>
 659                 </div>
 660
 661             </td>
 662             <td class="msource">
 663
 664                         <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
 665                 &nbsp;
 666             </td>
 667         </tr>
 668
 669
 670           <tr class="method-row config-row-alt0 expandable">
 671             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 672
 673
 674             <td class="sig">
 675                 <a id="Roo.util.Observable-method-addEvents"   name=".addEvents"></a>
 676                 <div class="fixedFont">
 677                         <span class="attributes"></span><b class="itemname">addEvents</b>
 678
 679                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
 680
 681
 682
 683                 </div>
 684                 <div class="mdesc">
 685
 686                    <div class="short">Used to define events on this Observable</div>
 687
 688
 689
 690                     <div class="long">
 691
 692                                 Used to define events on this Observable
 693
 694
 695
 696
 697
 698
 699                                 <dl class="detailList">
 700                                 <dt class="heading">Parameters:</dt>
 701
 702                                         <dt>
 703                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>object</b>
 704
 705                                         </dt>
 706                                         <dd>The object with the events defined</dd>
 707
 708                                 </dl>
 709
 710
 711
 712
 713
 714
 715
 716
 717
 718
 719
 720                     </div>
 721                 </div>
 722
 723             </td>
 724             <td class="msource">
 725
 726                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 727                 &nbsp;
 728             </td>
 729         </tr>
 730
 731
 732           <tr class="method-row config-row-alt1 expandable">
 733             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 734
 735
 736             <td class="sig">
 737                 <a id="Roo.util.Observable-method-addListener"   name=".addListener"></a>
 738                 <div class="fixedFont">
 739                         <span class="attributes"></span><b class="itemname">addListener</b>
 740
 741                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
 742
 743
 744
 745                 </div>
 746                 <div class="mdesc">
 747
 748                    <div class="short">Appends an event handler to this component</div>
 749
 750
 751
 752                     <div class="long">
 753
 754                                 Appends an event handler to this component
 755
 756
 757
 758
 759
 760
 761                                 <dl class="detailList">
 762                                 <dt class="heading">Parameters:</dt>
 763
 764                                         <dt>
 765                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 766
 767                                         </dt>
 768                                         <dd>The type of event to listen for</dd>
 769
 770                                         <dt>
 771                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
 772
 773                                         </dt>
 774                                         <dd>The method the event invokes</dd>
 775
 776                                         <dt>
 777                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>scope</b>
 778
 779                                         </dt>
 780                                         <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
 781
 782                                         <dt>
 783                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>options</b>
 784
 785                                         </dt>
 786                                         <dd>(optional) An object containing handler configuration<br/>properties. This may contain any of the following properties:<ul><br/><li>scope {Object} The scope in which to execute the handler function. The handler function's "this" context.</li><br/><li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li><br/><li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li><br/><li>buffer {Number} Causes the handler to be scheduled to run in an {<b>link</b> Roo.util.DelayedTask} delayed<br/>by the specified number of milliseconds. If the event fires again within that time, the original<br/>handler is <em>not</em> invoked, but the new handler is scheduled in its place.</li><br/></ul><br><br/><p><br/><b>Combining Options</b><br><br/>Using the options argument, it is possible to combine different types of listeners:<br><br/><br><br/>A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)<br/>             <pre><code><br/>                el.on('click', this.onClick, this, {<br/>                       single: true,<br/>              delay: 100,<br/>                forumId: 4<br/>         });<br/>                </code></pre><br/><p><br/><b>Attaching multiple handlers in 1 call</b><br><br/>The method also allows for a single argument to be passed which is a config object containing properties<br/>which specify multiple handlers.<br/><pre><code><br/>               el.on({<br/>                    'click': {<br/>                 fn: this.onClick,<br/>                  scope: this,<br/>                       delay: 100<br/>                 }, <br/>                'mouseover': {<br/>                     fn: this.onMouseOver,<br/>                      scope: this<br/>                },<br/>                 'mouseout': {<br/>                      fn: this.onMouseOut,<br/>                       scope: this<br/>                }<br/>          });<br/>                </code></pre><br/><p><br/>Or a shorthand syntax which passes the same scope object to all handlers:<br/>        <pre><code><br/>                el.on({<br/>                    'click': this.onClick,<br/>             'mouseover': this.onMouseOver,<br/>             'mouseout': this.onMouseOut,<br/>               scope: this<br/>                });<br/>                </code></pre></dd>
 787
 788                                 </dl>
 789
 790
 791
 792
 793
 794
 795
 796
 797
 798
 799
 800                     </div>
 801                 </div>
 802
 803             </td>
 804             <td class="msource">
 805
 806                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 807                 &nbsp;
 808             </td>
 809         </tr>
 810
 811
 812           <tr class="method-row config-row-alt0 expandable">
 813             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 814
 815
 816             <td class="sig">
 817                 <a id="Roo.data.Store-method-clearFilter"   name=".clearFilter"></a>
 818                 <div class="fixedFont">
 819                         <span class="attributes"></span><b class="itemname">clearFilter</b>
 820
 821                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>suppressEvent</i></B>)
 822
 823
 824
 825                 </div>
 826                 <div class="mdesc">
 827
 828                    <div class="short">Revert to a view of the Record cache with no filtering applied.</div>
 829
 830
 831
 832                     <div class="long">
 833
 834                                 Revert to a view of the Record cache with no filtering applied.
 835
 836
 837
 838
 839
 840
 841                                 <dl class="detailList">
 842                                 <dt class="heading">Parameters:</dt>
 843
 844                                         <dt>
 845                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  <b>suppressEvent</b>
 846
 847                                         </dt>
 848                                         <dd>If true the filter is cleared silently without notifying listeners</dd>
 849
 850                                 </dl>
 851
 852
 853
 854
 855
 856
 857
 858
 859
 860
 861
 862                     </div>
 863                 </div>
 864
 865             </td>
 866             <td class="msource">
 867
 868                         <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
 869                 &nbsp;
 870             </td>
 871         </tr>
 872
 873
 874           <tr class="method-row config-row-alt1 expandable">
 875             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 876
 877
 878             <td class="sig">
 879                 <a id="Roo.data.Store-method-collect"   name=".collect"></a>
 880                 <div class="fixedFont">
 881                         <span class="attributes"></span><b class="itemname">collect</b>
 882
 883                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>dataIndex</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>allowNull</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>bypassFilter</i></B>)
 884
 885
 886                                          :
 887
 888
 889                                                 <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
 890
 891
 892
 893
 894
 895                 </div>
 896                 <div class="mdesc">
 897
 898                    <div class="short">Collects unique values for a particular dataIndex from this store.</div>
 899
 900
 901
 902                     <div class="long">
 903
 904                                 Collects unique values for a particular dataIndex from this store.
 905
 906
 907
 908
 909
 910
 911                                 <dl class="detailList">
 912                                 <dt class="heading">Parameters:</dt>
 913
 914                                         <dt>
 915                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>dataIndex</b>
 916
 917                                         </dt>
 918                                         <dd>The property to collect</dd>
 919
 920                                         <dt>
 921                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  <b>allowNull</b>
 922
 923                                         </dt>
 924                                         <dd>(optional) Pass true to allow null, undefined or empty string values</dd>
 925
 926                                         <dt>
 927                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  <b>bypassFilter</b>
 928
 929                                         </dt>
 930                                         <dd>(optional) Pass true to collect from all records, even ones which are filtered</dd>
 931
 932                                 </dl>
 933
 934
 935
 936
 937
 938                                 <dl class="detailList">
 939                                 <dt class="heading">Returns:</dt>
 940
 941                                         <dd><span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span>  An array of the unique values</dd>
 942
 943                                 </dl>
 944
 945
 946
 947
 948
 949
 950
 951                     </div>
 952                 </div>
 953
 954             </td>
 955             <td class="msource">
 956
 957                         <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
 958                 &nbsp;
 959             </td>
 960         </tr>
 961
 962
 963           <tr class="method-row config-row-alt0 expandable">
 964             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 965
 966
 967             <td class="sig">
 968                 <a id="Roo.data.Store-method-commitChanges"   name=".commitChanges"></a>
 969                 <div class="fixedFont">
 970                         <span class="attributes"></span><b class="itemname">commitChanges</b>
 971
 972                                  ()
 973
 974
 975
 976                 </div>
 977                 <div class="mdesc">
 978
 979                    <div class="short">Commit all Records with outstanding changes.</div>
 980
 981
 982
 983                     <div class="long">
 984
 985                                 Commit all Records with outstanding changes. To handle updates for changes, subscribe to the<br/>Store's "update" event, and perform updating when the third parameter is Roo.data.Record.COMMIT.
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002                     </div>
1003                 </div>
1004
1005             </td>
1006             <td class="msource">
1007
1008                         <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
1009                 &nbsp;
1010             </td>
1011         </tr>
1012
1013
1014           <tr class="method-row config-row-alt1 expandable">
1015             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1016
1017
1018             <td class="sig">
1019                 <a id="Roo.data.Store-method-each"   name=".each"></a>
1020                 <div class="fixedFont">
1021                         <span class="attributes"></span><b class="itemname">each</b>
1022
1023                                  (<a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>fn</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
1024
1025
1026
1027                 </div>
1028                 <div class="mdesc">
1029
1030                    <div class="short">Calls the specified function for each of the Records in the cache.</div>
1031
1032
1033
1034                     <div class="long">
1035
1036                                 Calls the specified function for each of the Records in the cache.
1037
1038
1039
1040
1041
1042
1043                                 <dl class="detailList">
1044                                 <dt class="heading">Parameters:</dt>
1045
1046                                         <dt>
1047                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>fn</b>
1048
1049                                         </dt>
1050                                         <dd>The function to call. The Record is passed as the first parameter.<br/>Returning <em>false</em> aborts and exits the iteration.</dd>
1051
1052                                         <dt>
1053                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>scope</b>
1054
1055                                         </dt>
1056                                         <dd>(optional) The scope in which to call the function (defaults to the Record).</dd>
1057
1058                                 </dl>
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070                     </div>
1071                 </div>
1072
1073             </td>
1074             <td class="msource">
1075
1076                         <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
1077                 &nbsp;
1078             </td>
1079         </tr>
1080
1081
1082           <tr class="method-row config-row-alt0 expandable">
1083             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1084
1085
1086             <td class="sig">
1087                 <a id="Roo.data.Store-method-filter"   name=".filter"></a>
1088                 <div class="fixedFont">
1089                         <span class="attributes"></span><b class="itemname">filter</b>
1090
1091                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>field</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/RegExp <B><i>value</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>anyMatch</i></B>)
1092
1093
1094
1095                 </div>
1096                 <div class="mdesc">
1097
1098                    <div class="short">Filter the records by a specified property.</div>
1099
1100
1101
1102                     <div class="long">
1103
1104                                 Filter the records by a specified property.
1105
1106
1107
1108
1109
1110
1111                                 <dl class="detailList">
1112                                 <dt class="heading">Parameters:</dt>
1113
1114                                         <dt>
1115                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>field</b>
1116
1117                                         </dt>
1118                                         <dd>A field on your records</dd>
1119
1120                                         <dt>
1121                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/RegExp</span>  <b>value</b>
1122
1123                                         </dt>
1124                                         <dd>Either a string that the field<br/>should start with or a RegExp to test against the field</dd>
1125
1126                                         <dt>
1127                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  <b>anyMatch</b>
1128
1129                                         </dt>
1130                                         <dd>True to match any part not just the beginning</dd>
1131
1132                                 </dl>
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144                     </div>
1145                 </div>
1146
1147             </td>
1148             <td class="msource">
1149
1150                         <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
1151                 &nbsp;
1152             </td>
1153         </tr>
1154
1155
1156           <tr class="method-row config-row-alt1 expandable">
1157             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1158
1159
1160             <td class="sig">
1161                 <a id="Roo.data.Store-method-filterBy"   name=".filterBy"></a>
1162                 <div class="fixedFont">
1163                         <span class="attributes"></span><b class="itemname">filterBy</b>
1164
1165                                  (<a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>fn</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
1166
1167
1168
1169                 </div>
1170                 <div class="mdesc">
1171
1172                    <div class="short">Filter by a function.</div>
1173
1174
1175
1176                     <div class="long">
1177
1178                                 Filter by a function. The specified function will be called with each<br/>record in this data source. If the function returns true the record is included,<br/>otherwise it is filtered.
1179
1180
1181
1182
1183
1184
1185                                 <dl class="detailList">
1186                                 <dt class="heading">Parameters:</dt>
1187
1188                                         <dt>
1189                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>fn</b>
1190
1191                                         </dt>
1192                                         <dd>The function to be called, it will receive 2 args (record, id)</dd>
1193
1194                                         <dt>
1195                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>scope</b>
1196
1197                                         </dt>
1198                                         <dd>(optional) The scope of the function (defaults to this)</dd>
1199
1200                                 </dl>
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212                     </div>
1213                 </div>
1214
1215             </td>
1216             <td class="msource">
1217
1218                         <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
1219                 &nbsp;
1220             </td>
1221         </tr>
1222
1223
1224           <tr class="method-row config-row-alt0 expandable">
1225             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1226
1227
1228             <td class="sig">
1229                 <a id="Roo.util.Observable-method-fireEvent"   name=".fireEvent"></a>
1230                 <div class="fixedFont">
1231                         <span class="attributes"></span><b class="itemname">fireEvent</b>
1232
1233                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a> <B><i>args</i></B>)
1234
1235
1236                                          :
1237
1238
1239                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1240
1241
1242
1243
1244
1245                 </div>
1246                 <div class="mdesc">
1247
1248                    <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
1249
1250
1251
1252                     <div class="long">
1253
1254                                 Fires the specified event with the passed parameters (minus the event name).
1255
1256
1257
1258
1259
1260
1261                                 <dl class="detailList">
1262                                 <dt class="heading">Parameters:</dt>
1263
1264                                         <dt>
1265                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
1266
1267                                         </dt>
1268                                         <dd></dd>
1269
1270                                         <dt>
1271                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a></span>  <b>args</b>
1272
1273                                         </dt>
1274                                         <dd>Variable number of parameters are passed to handlers</dd>
1275
1276                                 </dl>
1277
1278
1279
1280
1281
1282                                 <dl class="detailList">
1283                                 <dt class="heading">Returns:</dt>
1284
1285                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  returns false if any of the handlers return false otherwise it returns true</dd>
1286
1287                                 </dl>
1288
1289
1290
1291
1292
1293
1294
1295                     </div>
1296                 </div>
1297
1298             </td>
1299             <td class="msource">
1300
1301                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1302                 &nbsp;
1303             </td>
1304         </tr>
1305
1306
1307           <tr class="method-row config-row-alt1 expandable">
1308             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1309
1310
1311             <td class="sig">
1312                 <a id="Roo.data.Store-method-getAt"   name=".getAt"></a>
1313                 <div class="fixedFont">
1314                         <span class="attributes"></span><b class="itemname">getAt</b>
1315
1316                                  (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>index</i></B>)
1317
1318
1319                                          :
1320
1321
1322                                                 <a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a>
1323
1324
1325
1326
1327
1328                 </div>
1329                 <div class="mdesc">
1330
1331                    <div class="short">Get the Record at the specified index.</div>
1332
1333
1334
1335                     <div class="long">
1336
1337                                 Get the Record at the specified index.
1338
1339
1340
1341
1342
1343
1344                                 <dl class="detailList">
1345                                 <dt class="heading">Parameters:</dt>
1346
1347                                         <dt>
1348                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>index</b>
1349
1350                                         </dt>
1351                                         <dd>The index of the Record to find.</dd>
1352
1353                                 </dl>
1354
1355
1356
1357
1358
1359                                 <dl class="detailList">
1360                                 <dt class="heading">Returns:</dt>
1361
1362                                         <dd><span class="fixedFont"><a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a></span>  The Record at the passed index. Returns undefined if not found.</dd>
1363
1364                                 </dl>
1365
1366
1367
1368
1369
1370
1371
1372                     </div>
1373                 </div>
1374
1375             </td>
1376             <td class="msource">
1377
1378                         <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
1379                 &nbsp;
1380             </td>
1381         </tr>
1382
1383
1384           <tr class="method-row config-row-alt0 expandable">
1385             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1386
1387
1388             <td class="sig">
1389                 <a id="Roo.data.Store-method-getById"   name=".getById"></a>
1390                 <div class="fixedFont">
1391                         <span class="attributes"></span><b class="itemname">getById</b>
1392
1393                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>)
1394
1395
1396                                          :
1397
1398
1399                                                 <a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a>
1400
1401
1402
1403
1404
1405                 </div>
1406                 <div class="mdesc">
1407
1408                    <div class="short">Get the Record with the specified id.</div>
1409
1410
1411
1412                     <div class="long">
1413
1414                                 Get the Record with the specified id.
1415
1416
1417
1418
1419
1420
1421                                 <dl class="detailList">
1422                                 <dt class="heading">Parameters:</dt>
1423
1424                                         <dt>
1425                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>id</b>
1426
1427                                         </dt>
1428                                         <dd>The id of the Record to find.</dd>
1429
1430                                 </dl>
1431
1432
1433
1434
1435
1436                                 <dl class="detailList">
1437                                 <dt class="heading">Returns:</dt>
1438
1439                                         <dd><span class="fixedFont"><a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a></span>  The Record with the passed id. Returns undefined if not found.</dd>
1440
1441                                 </dl>
1442
1443
1444
1445
1446
1447
1448
1449                     </div>
1450                 </div>
1451
1452             </td>
1453             <td class="msource">
1454
1455                         <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
1456                 &nbsp;
1457             </td>
1458         </tr>
1459
1460
1461           <tr class="method-row config-row-alt1 expandable">
1462             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1463
1464
1465             <td class="sig">
1466                 <a id="Roo.data.Store-method-getCount"   name=".getCount"></a>
1467                 <div class="fixedFont">
1468                         <span class="attributes"></span><b class="itemname">getCount</b>
1469
1470                                  ()
1471
1472
1473
1474                 </div>
1475                 <div class="mdesc">
1476
1477                    <div class="short">Gets the number of cached records.</div>
1478
1479
1480
1481                     <div class="long">
1482
1483                                 Gets the number of cached records.<br/><p><br/><em>If using paging, this may not be the total size of the dataset. If the data object<br/>used by the Reader contains the dataset size, then the getTotalCount() function returns<br/>the data set size</em>
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500                     </div>
1501                 </div>
1502
1503             </td>
1504             <td class="msource">
1505
1506                         <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
1507                 &nbsp;
1508             </td>
1509         </tr>
1510
1511
1512           <tr class="method-row config-row-alt0 expandable">
1513             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1514
1515
1516             <td class="sig">
1517                 <a id="Roo.data.Store-method-getModifiedRecords"   name=".getModifiedRecords"></a>
1518                 <div class="fixedFont">
1519                         <span class="attributes"></span><b class="itemname">getModifiedRecords</b>
1520
1521                                  ()
1522
1523
1524                                          :
1525
1526
1527                                                 <a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a>[]
1528
1529
1530
1531
1532
1533                 </div>
1534                 <div class="mdesc">
1535
1536                    <div class="short">Gets all records modified since the last commit.</div>
1537
1538
1539
1540                     <div class="long">
1541
1542                                 Gets all records modified since the last commit.  Modified records are persisted across load operations<br/>(e.g., during paging).
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553                                 <dl class="detailList">
1554                                 <dt class="heading">Returns:</dt>
1555
1556                                         <dd><span class="fixedFont"><a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a>[]</span>  An array of Records containing outstanding modifications.</dd>
1557
1558                                 </dl>
1559
1560
1561
1562
1563
1564
1565
1566                     </div>
1567                 </div>
1568
1569             </td>
1570             <td class="msource">
1571
1572                         <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
1573                 &nbsp;
1574             </td>
1575         </tr>
1576
1577
1578           <tr class="method-row config-row-alt1 expandable">
1579             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1580
1581
1582             <td class="sig">
1583                 <a id="Roo.data.Store-method-getRange"   name=".getRange"></a>
1584                 <div class="fixedFont">
1585                         <span class="attributes"></span><b class="itemname">getRange</b>
1586
1587                                  (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>startIndex</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>endIndex</i></B>)
1588
1589
1590                                          :
1591
1592
1593                                                 <a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a>[]
1594
1595
1596
1597
1598
1599                 </div>
1600                 <div class="mdesc">
1601
1602                    <div class="short">Returns a range of Records between specified indices.</div>
1603
1604
1605
1606                     <div class="long">
1607
1608                                 Returns a range of Records between specified indices.
1609
1610
1611
1612
1613
1614
1615                                 <dl class="detailList">
1616                                 <dt class="heading">Parameters:</dt>
1617
1618                                         <dt>
1619                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>startIndex</b>
1620
1621                                         </dt>
1622                                         <dd>(optional) The starting index (defaults to 0)</dd>
1623
1624                                         <dt>
1625                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>endIndex</b>
1626
1627                                         </dt>
1628                                         <dd>(optional) The ending index (defaults to the last Record in the Store)</dd>
1629
1630                                 </dl>
1631
1632
1633
1634
1635
1636                                 <dl class="detailList">
1637                                 <dt class="heading">Returns:</dt>
1638
1639                                         <dd><span class="fixedFont"><a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a>[]</span>  An array of Records</dd>
1640
1641                                 </dl>
1642
1643
1644
1645
1646
1647
1648
1649                     </div>
1650                 </div>
1651
1652             </td>
1653             <td class="msource">
1654
1655                         <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
1656                 &nbsp;
1657             </td>
1658         </tr>
1659
1660
1661           <tr class="method-row config-row-alt0 expandable">
1662             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1663
1664
1665             <td class="sig">
1666                 <a id="Roo.data.Store-method-getSortState"   name=".getSortState"></a>
1667                 <div class="fixedFont">
1668                         <span class="attributes"></span><b class="itemname">getSortState</b>
1669
1670                                  ()
1671
1672
1673
1674                 </div>
1675                 <div class="mdesc">
1676
1677                    <div class="short">Returns the sort state of the Store as an object with two properties:<br/><pre><code><br/> field {String} The name of the field by which the Records are sorted<br/> direction {String} The sort order, "ASC" or "DESC"<br/></code></pre></div>
1678
1679
1680
1681                     <div class="long">
1682
1683                                 Returns the sort state of the Store as an object with two properties:<br/><pre><code><br/> field {String} The name of the field by which the Records are sorted<br/> direction {String} The sort order, "ASC" or "DESC"<br/></code></pre>
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700                     </div>
1701                 </div>
1702
1703             </td>
1704             <td class="msource">
1705
1706                         <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
1707                 &nbsp;
1708             </td>
1709         </tr>
1710
1711
1712           <tr class="method-row config-row-alt1 expandable">
1713             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1714
1715
1716             <td class="sig">
1717                 <a id="Roo.data.Store-method-getTotalCount"   name=".getTotalCount"></a>
1718                 <div class="fixedFont">
1719                         <span class="attributes"></span><b class="itemname">getTotalCount</b>
1720
1721                                  ()
1722
1723
1724
1725                 </div>
1726                 <div class="mdesc">
1727
1728                    <div class="short">Gets the total number of records in the dataset as returned by the server.</div>
1729
1730
1731
1732                     <div class="long">
1733
1734                                 Gets the total number of records in the dataset as returned by the server.<br/><p><br/><em>If using paging, for this to be accurate, the data object used by the Reader must contain<br/>the dataset size</em>
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751                     </div>
1752                 </div>
1753
1754             </td>
1755             <td class="msource">
1756
1757                         <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
1758                 &nbsp;
1759             </td>
1760         </tr>
1761
1762
1763           <tr class="method-row config-row-alt0 expandable">
1764             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1765
1766
1767             <td class="sig">
1768                 <a id="Roo.util.Observable-method-hasListener"   name=".hasListener"></a>
1769                 <div class="fixedFont">
1770                         <span class="attributes"></span><b class="itemname">hasListener</b>
1771
1772                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1773
1774
1775                                          :
1776
1777
1778                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1779
1780
1781
1782
1783
1784                 </div>
1785                 <div class="mdesc">
1786
1787                    <div class="short">Checks to see if this object has any listeners for a specified event</div>
1788
1789
1790
1791                     <div class="long">
1792
1793                                 Checks to see if this object has any listeners for a specified event
1794
1795
1796
1797
1798
1799
1800                                 <dl class="detailList">
1801                                 <dt class="heading">Parameters:</dt>
1802
1803                                         <dt>
1804                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
1805
1806                                         </dt>
1807                                         <dd>The name of the event to check for</dd>
1808
1809                                 </dl>
1810
1811
1812
1813
1814
1815                                 <dl class="detailList">
1816                                 <dt class="heading">Returns:</dt>
1817
1818                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  True if the event is being listened for, else false</dd>
1819
1820                                 </dl>
1821
1822
1823
1824
1825
1826
1827
1828                     </div>
1829                 </div>
1830
1831             </td>
1832             <td class="msource">
1833
1834                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1835                 &nbsp;
1836             </td>
1837         </tr>
1838
1839
1840           <tr class="method-row config-row-alt1 expandable">
1841             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1842
1843
1844             <td class="sig">
1845                 <a id="Roo.data.Store-method-indexOf"   name=".indexOf"></a>
1846                 <div class="fixedFont">
1847                         <span class="attributes"></span><b class="itemname">indexOf</b>
1848
1849                                  (<a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a> <B><i>record</i></B>)
1850
1851
1852                                          :
1853
1854
1855                                                 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
1856
1857
1858
1859
1860
1861                 </div>
1862                 <div class="mdesc">
1863
1864                    <div class="short">Get the index within the cache of the passed Record.</div>
1865
1866
1867
1868                     <div class="long">
1869
1870                                 Get the index within the cache of the passed Record.
1871
1872
1873
1874
1875
1876
1877                                 <dl class="detailList">
1878                                 <dt class="heading">Parameters:</dt>
1879
1880                                         <dt>
1881                                                 <span class="fixedFont"><a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a></span>  <b>record</b>
1882
1883                                         </dt>
1884                                         <dd>The Roo.data.Record object to to find.</dd>
1885
1886                                 </dl>
1887
1888
1889
1890
1891
1892                                 <dl class="detailList">
1893                                 <dt class="heading">Returns:</dt>
1894
1895                                         <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  The index of the passed Record. Returns -1 if not found.</dd>
1896
1897                                 </dl>
1898
1899
1900
1901
1902
1903
1904
1905                     </div>
1906                 </div>
1907
1908             </td>
1909             <td class="msource">
1910
1911                         <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
1912                 &nbsp;
1913             </td>
1914         </tr>
1915
1916
1917           <tr class="method-row config-row-alt0 expandable">
1918             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1919
1920
1921             <td class="sig">
1922                 <a id="Roo.data.Store-method-indexOfId"   name=".indexOfId"></a>
1923                 <div class="fixedFont">
1924                         <span class="attributes"></span><b class="itemname">indexOfId</b>
1925
1926                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>)
1927
1928
1929                                          :
1930
1931
1932                                                 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
1933
1934
1935
1936
1937
1938                 </div>
1939                 <div class="mdesc">
1940
1941                    <div class="short">Get the index within the cache of the Record with the passed id.</div>
1942
1943
1944
1945                     <div class="long">
1946
1947                                 Get the index within the cache of the Record with the passed id.
1948
1949
1950
1951
1952
1953
1954                                 <dl class="detailList">
1955                                 <dt class="heading">Parameters:</dt>
1956
1957                                         <dt>
1958                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>id</b>
1959
1960                                         </dt>
1961                                         <dd>The id of the Record to find.</dd>
1962
1963                                 </dl>
1964
1965
1966
1967
1968
1969                                 <dl class="detailList">
1970                                 <dt class="heading">Returns:</dt>
1971
1972                                         <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  The index of the Record. Returns -1 if not found.</dd>
1973
1974                                 </dl>
1975
1976
1977
1978
1979
1980
1981
1982                     </div>
1983                 </div>
1984
1985             </td>
1986             <td class="msource">
1987
1988                         <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
1989                 &nbsp;
1990             </td>
1991         </tr>
1992
1993
1994           <tr class="method-row config-row-alt1 expandable">
1995             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1996
1997
1998             <td class="sig">
1999                 <a id="Roo.data.Store-method-insert"   name=".insert"></a>
2000                 <div class="fixedFont">
2001                         <span class="attributes"></span><b class="itemname">insert</b>
2002
2003                                  (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>index</i></B>, <a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a>[] <B><i>records</i></B>)
2004
2005
2006
2007                 </div>
2008                 <div class="mdesc">
2009
2010                    <div class="short">Inserts Records to the Store at the given index and fires the add event.</div>
2011
2012
2013
2014                     <div class="long">
2015
2016                                 Inserts Records to the Store at the given index and fires the add event.
2017
2018
2019
2020
2021
2022
2023                                 <dl class="detailList">
2024                                 <dt class="heading">Parameters:</dt>
2025
2026                                         <dt>
2027                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>index</b>
2028
2029                                         </dt>
2030                                         <dd>The start index at which to insert the passed Records.</dd>
2031
2032                                         <dt>
2033                                                 <span class="fixedFont"><a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a>[]</span>  <b>records</b>
2034
2035                                         </dt>
2036                                         <dd>An Array of Roo.data.Record objects to add to the cache.</dd>
2037
2038                                 </dl>
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050                     </div>
2051                 </div>
2052
2053             </td>
2054             <td class="msource">
2055
2056                         <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
2057                 &nbsp;
2058             </td>
2059         </tr>
2060
2061
2062           <tr class="method-row config-row-alt0 expandable">
2063             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2064
2065
2066             <td class="sig">
2067                 <a id="Roo.data.Store-method-load"   name=".load"></a>
2068                 <div class="fixedFont">
2069                         <span class="attributes"></span><b class="itemname">load</b>
2070
2071                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
2072
2073
2074
2075                 </div>
2076                 <div class="mdesc">
2077
2078                    <div class="short">Loads the Record cache from the configured Proxy using the configured Reader.</div>
2079
2080
2081
2082                     <div class="long">
2083
2084                                 Loads the Record cache from the configured Proxy using the configured Reader.<br/><p><br/>If using remote paging, then the first load call must specify the <em>start</em><br/>and <em>limit</em> properties in the options.params property to establish the initial<br/>position within the dataset, and the number of Records to cache on each read from the Proxy.<br/><p><br/><strong>It is important to note that for remote data sources, loading is asynchronous,<br/>and this call will return before the new data has been loaded. Perform any post-processing<br/>in a callback function, or in a "load" event handler.</strong><br/><p>
2085
2086
2087
2088
2089
2090
2091                                 <dl class="detailList">
2092                                 <dt class="heading">Parameters:</dt>
2093
2094                                         <dt>
2095                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>options</b>
2096
2097                                         </dt>
2098                                         <dd>An object containing properties which control loading options:<ul><br/><li>params {Object} An object containing properties to pass as HTTP parameters to a remote data source.</li><br/><li>callback {Function} A function to be called after the Records have been loaded. The callback is<br/>passed the following arguments:<ul><br/><li>r : Roo.data.Record[]</li><br/><li>options: Options object from the load call</li><br/><li>success: Boolean success indicator</li></ul></li><br/><li>scope {Object} Scope with which to call the callback (defaults to the Store object)</li><br/><li>add {Boolean} indicator to append loaded records rather than replace the current cache.</li><br/></ul></dd>
2099
2100                                 </dl>
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112                     </div>
2113                 </div>
2114
2115             </td>
2116             <td class="msource">
2117
2118                         <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
2119                 &nbsp;
2120             </td>
2121         </tr>
2122
2123
2124           <tr class="method-row config-row-alt1 expandable">
2125             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2126
2127
2128             <td class="sig">
2129                 <a id="Roo.data.Store-method-loadData"   name=".loadData"></a>
2130                 <div class="fixedFont">
2131                         <span class="attributes"></span><b class="itemname">loadData</b>
2132
2133                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>data</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>append</i></B>)
2134
2135
2136
2137                 </div>
2138                 <div class="mdesc">
2139
2140                    <div class="short">Loads data from a passed data block.</div>
2141
2142
2143
2144                     <div class="long">
2145
2146                                 Loads data from a passed data block. A Reader which understands the format of the data<br/>must have been configured in the constructor.
2147
2148
2149
2150
2151
2152
2153                                 <dl class="detailList">
2154                                 <dt class="heading">Parameters:</dt>
2155
2156                                         <dt>
2157                                                 <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>
2158
2159                                         </dt>
2160                                         <dd>The data block from which to read the Records.  The format of the data expected<br/>is dependent on the type of Reader that is configured and should correspond to that Reader's readRecords parameter.</dd>
2161
2162                                         <dt>
2163                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  <b>append</b>
2164
2165                                         </dt>
2166                                         <dd>(Optional) True to append the new Records rather than replace the existing cache.</dd>
2167
2168                                 </dl>
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180                     </div>
2181                 </div>
2182
2183             </td>
2184             <td class="msource">
2185
2186                         <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
2187                 &nbsp;
2188             </td>
2189         </tr>
2190
2191
2192           <tr class="method-row config-row-alt0 expandable">
2193             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2194
2195
2196             <td class="sig">
2197                 <a id="Roo.util.Observable-method-on"   name=".on"></a>
2198                 <div class="fixedFont">
2199                         <span class="attributes"></span><b class="itemname">on</b>
2200
2201                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
2202
2203
2204
2205                 </div>
2206                 <div class="mdesc">
2207
2208                    <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
2209
2210
2211
2212                     <div class="long">
2213
2214                                 Appends an event handler to this element (shorthand for addListener)
2215
2216
2217
2218
2219
2220
2221                                 <dl class="detailList">
2222                                 <dt class="heading">Parameters:</dt>
2223
2224                                         <dt>
2225                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
2226
2227                                         </dt>
2228                                         <dd>The type of event to listen for</dd>
2229
2230                                         <dt>
2231                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
2232
2233                                         </dt>
2234                                         <dd>The method the event invokes</dd>
2235
2236                                         <dt>
2237                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>scope</b>
2238
2239                                         </dt>
2240                                         <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
2241
2242                                         <dt>
2243                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>options</b>
2244
2245                                         </dt>
2246                                         <dd>(optional)</dd>
2247
2248                                 </dl>
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260                     </div>
2261                 </div>
2262
2263             </td>
2264             <td class="msource">
2265
2266                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2267                 &nbsp;
2268             </td>
2269         </tr>
2270
2271
2272           <tr class="method-row config-row-alt1 expandable">
2273             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2274
2275
2276             <td class="sig">
2277                 <a id="Roo.util.Observable-method-purgeListeners"   name=".purgeListeners"></a>
2278                 <div class="fixedFont">
2279                         <span class="attributes"></span><b class="itemname">purgeListeners</b>
2280
2281                                  ()
2282
2283
2284
2285                 </div>
2286                 <div class="mdesc">
2287
2288                    <div class="short">Removes all listeners for this object</div>
2289
2290
2291
2292                     <div class="long">
2293
2294                                 Removes all listeners for this object
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311                     </div>
2312                 </div>
2313
2314             </td>
2315             <td class="msource">
2316
2317                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2318                 &nbsp;
2319             </td>
2320         </tr>
2321
2322
2323           <tr class="method-row config-row-alt0 expandable">
2324             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2325
2326
2327             <td class="sig">
2328                 <a id="Roo.data.Store-method-query"   name=".query"></a>
2329                 <div class="fixedFont">
2330                         <span class="attributes"></span><b class="itemname">query</b>
2331
2332                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>field</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/RegExp <B><i>value</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>anyMatch</i></B>)
2333
2334
2335                                          :
2336
2337
2338                                                 MixedCollection
2339
2340
2341
2342
2343
2344                 </div>
2345                 <div class="mdesc">
2346
2347                    <div class="short">Query the records by a specified property.</div>
2348
2349
2350
2351                     <div class="long">
2352
2353                                 Query the records by a specified property.
2354
2355
2356
2357
2358
2359
2360                                 <dl class="detailList">
2361                                 <dt class="heading">Parameters:</dt>
2362
2363                                         <dt>
2364                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>field</b>
2365
2366                                         </dt>
2367                                         <dd>A field on your records</dd>
2368
2369                                         <dt>
2370                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/RegExp</span>  <b>value</b>
2371
2372                                         </dt>
2373                                         <dd>Either a string that the field<br/>should start with or a RegExp to test against the field</dd>
2374
2375                                         <dt>
2376                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  <b>anyMatch</b>
2377
2378                                         </dt>
2379                                         <dd>True to match any part not just the beginning</dd>
2380
2381                                 </dl>
2382
2383
2384
2385
2386
2387                                 <dl class="detailList">
2388                                 <dt class="heading">Returns:</dt>
2389
2390                                         <dd><span class="fixedFont">MixedCollection</span>  Returns an Roo.util.MixedCollection of the matched records</dd>
2391
2392                                 </dl>
2393
2394
2395
2396
2397
2398
2399
2400                     </div>
2401                 </div>
2402
2403             </td>
2404             <td class="msource">
2405
2406                         <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
2407                 &nbsp;
2408             </td>
2409         </tr>
2410
2411
2412           <tr class="method-row config-row-alt1 expandable">
2413             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2414
2415
2416             <td class="sig">
2417                 <a id="Roo.data.Store-method-queryBy"   name=".queryBy"></a>
2418                 <div class="fixedFont">
2419                         <span class="attributes"></span><b class="itemname">queryBy</b>
2420
2421                                  (<a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>fn</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
2422
2423
2424                                          :
2425
2426
2427                                                 MixedCollection
2428
2429
2430
2431
2432
2433                 </div>
2434                 <div class="mdesc">
2435
2436                    <div class="short">Query by a function.</div>
2437
2438
2439
2440                     <div class="long">
2441
2442                                 Query by a function. The specified function will be called with each<br/>record in this data source. If the function returns true the record is included<br/>in the results.
2443
2444
2445
2446
2447
2448
2449                                 <dl class="detailList">
2450                                 <dt class="heading">Parameters:</dt>
2451
2452                                         <dt>
2453                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>fn</b>
2454
2455                                         </dt>
2456                                         <dd>The function to be called, it will receive 2 args (record, id)</dd>
2457
2458                                         <dt>
2459                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>scope</b>
2460
2461                                         </dt>
2462                                         <dd>(optional) The scope of the function (defaults to this)</dd>
2463
2464                                 </dl>
2465
2466
2467
2468
2469
2470                                 <dl class="detailList">
2471                                 <dt class="heading">Returns:</dt>
2472
2473                                         <dd><span class="fixedFont">MixedCollection</span>  Returns an Roo.util.MixedCollection of the matched records</dd>
2474
2475                                 </dl>
2476
2477
2478
2479
2480
2481
2482
2483                     </div>
2484                 </div>
2485
2486             </td>
2487             <td class="msource">
2488
2489                         <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
2490                 &nbsp;
2491             </td>
2492         </tr>
2493
2494
2495           <tr class="method-row config-row-alt0 expandable">
2496             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2497
2498
2499             <td class="sig">
2500                 <a id="Roo.data.Store-method-rejectChanges"   name=".rejectChanges"></a>
2501                 <div class="fixedFont">
2502                         <span class="attributes"></span><b class="itemname">rejectChanges</b>
2503
2504                                  ()
2505
2506
2507
2508                 </div>
2509                 <div class="mdesc">
2510
2511                    <div class="short">Cancel outstanding changes on all changed records.</div>
2512
2513
2514
2515                     <div class="long">
2516
2517                                 Cancel outstanding changes on all changed records.
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534                     </div>
2535                 </div>
2536
2537             </td>
2538             <td class="msource">
2539
2540                         <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
2541                 &nbsp;
2542             </td>
2543         </tr>
2544
2545
2546           <tr class="method-row config-row-alt1 expandable">
2547             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2548
2549
2550             <td class="sig">
2551                 <a id="Roo.data.Store-method-reload"   name=".reload"></a>
2552                 <div class="fixedFont">
2553                         <span class="attributes"></span><b class="itemname">reload</b>
2554
2555                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
2556
2557
2558
2559                 </div>
2560                 <div class="mdesc">
2561
2562                    <div class="short">Reloads the Record cache from the configured Proxy using the configured Reader and<br/>the options from the last load operation performed.</div>
2563
2564
2565
2566                     <div class="long">
2567
2568                                 Reloads the Record cache from the configured Proxy using the configured Reader and<br/>the options from the last load operation performed.
2569
2570
2571
2572
2573
2574
2575                                 <dl class="detailList">
2576                                 <dt class="heading">Parameters:</dt>
2577
2578                                         <dt>
2579                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>options</b>
2580
2581                                         </dt>
2582                                         <dd>(optional) An object containing properties which may override the options<br/>used in the last load operation. See {<b>link</b> <b>load</b>} for details (defaults to null, in which case<br/>the most recently used options are reused).</dd>
2583
2584                                 </dl>
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596                     </div>
2597                 </div>
2598
2599             </td>
2600             <td class="msource">
2601
2602                         <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
2603                 &nbsp;
2604             </td>
2605         </tr>
2606
2607
2608           <tr class="method-row config-row-alt0 expandable">
2609             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2610
2611
2612             <td class="sig">
2613                 <a id="Roo.data.Store-method-remove"   name=".remove"></a>
2614                 <div class="fixedFont">
2615                         <span class="attributes"></span><b class="itemname">remove</b>
2616
2617                                  (Ext.data.Record <B><i>record</i></B>)
2618
2619
2620
2621                 </div>
2622                 <div class="mdesc">
2623
2624                    <div class="short">Remove a Record from the Store and fires the remove event.</div>
2625
2626
2627
2628                     <div class="long">
2629
2630                                 Remove a Record from the Store and fires the remove event.
2631
2632
2633
2634
2635
2636
2637                                 <dl class="detailList">
2638                                 <dt class="heading">Parameters:</dt>
2639
2640                                         <dt>
2641                                                 <span class="fixedFont">Ext.data.Record</span>  <b>record</b>
2642
2643                                         </dt>
2644                                         <dd>The Roo.data.Record object to remove from the cache.</dd>
2645
2646                                 </dl>
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658                     </div>
2659                 </div>
2660
2661             </td>
2662             <td class="msource">
2663
2664                         <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
2665                 &nbsp;
2666             </td>
2667         </tr>
2668
2669
2670           <tr class="method-row config-row-alt1 expandable">
2671             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2672
2673
2674             <td class="sig">
2675                 <a id="Roo.data.Store-method-removeAll"   name=".removeAll"></a>
2676                 <div class="fixedFont">
2677                         <span class="attributes"></span><b class="itemname">removeAll</b>
2678
2679                                  ()
2680
2681
2682
2683                 </div>
2684                 <div class="mdesc">
2685
2686                    <div class="short">Remove all Records from the Store and fires the clear event.</div>
2687
2688
2689
2690                     <div class="long">
2691
2692                                 Remove all Records from the Store and fires the clear event.
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709                     </div>
2710                 </div>
2711
2712             </td>
2713             <td class="msource">
2714
2715                         <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
2716                 &nbsp;
2717             </td>
2718         </tr>
2719
2720
2721           <tr class="method-row config-row-alt0 expandable">
2722             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2723
2724
2725             <td class="sig">
2726                 <a id="Roo.util.Observable-method-removeListener"   name=".removeListener"></a>
2727                 <div class="fixedFont">
2728                         <span class="attributes"></span><b class="itemname">removeListener</b>
2729
2730                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
2731
2732
2733
2734                 </div>
2735                 <div class="mdesc">
2736
2737                    <div class="short">Removes a listener</div>
2738
2739
2740
2741                     <div class="long">
2742
2743                                 Removes a listener
2744
2745
2746
2747
2748
2749
2750                                 <dl class="detailList">
2751                                 <dt class="heading">Parameters:</dt>
2752
2753                                         <dt>
2754                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
2755
2756                                         </dt>
2757                                         <dd>The type of event to listen for</dd>
2758
2759                                         <dt>
2760                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
2761
2762                                         </dt>
2763                                         <dd>The handler to remove</dd>
2764
2765                                         <dt>
2766                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>scope</b>
2767
2768                                         </dt>
2769                                         <dd>(optional) The scope (this object) for the handler</dd>
2770
2771                                 </dl>
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783                     </div>
2784                 </div>
2785
2786             </td>
2787             <td class="msource">
2788
2789                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2790                 &nbsp;
2791             </td>
2792         </tr>
2793
2794
2795           <tr class="method-row config-row-alt1 expandable">
2796             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2797
2798
2799             <td class="sig">
2800                 <a id="Roo.data.Store-method-setDefaultSort"   name=".setDefaultSort"></a>
2801                 <div class="fixedFont">
2802                         <span class="attributes"></span><b class="itemname">setDefaultSort</b>
2803
2804                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>fieldName</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>dir</i></B>)
2805
2806
2807
2808                 </div>
2809                 <div class="mdesc">
2810
2811                    <div class="short">Sets the default sort column and order to be used by the next load operation.</div>
2812
2813
2814
2815                     <div class="long">
2816
2817                                 Sets the default sort column and order to be used by the next load operation.
2818
2819
2820
2821
2822
2823
2824                                 <dl class="detailList">
2825                                 <dt class="heading">Parameters:</dt>
2826
2827                                         <dt>
2828                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>fieldName</b>
2829
2830                                         </dt>
2831                                         <dd>The name of the field to sort by.</dd>
2832
2833                                         <dt>
2834                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>dir</b>
2835
2836                                         </dt>
2837                                         <dd>(optional) The sort order, "ASC" or "DESC" (defaults to "ASC")</dd>
2838
2839                                 </dl>
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851                     </div>
2852                 </div>
2853
2854             </td>
2855             <td class="msource">
2856
2857                         <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
2858                 &nbsp;
2859             </td>
2860         </tr>
2861
2862
2863           <tr class="method-row config-row-alt0 expandable">
2864             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2865
2866
2867             <td class="sig">
2868                 <a id="Roo.data.Store-method-sort"   name=".sort"></a>
2869                 <div class="fixedFont">
2870                         <span class="attributes"></span><b class="itemname">sort</b>
2871
2872                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>fieldName</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>dir</i></B>)
2873
2874
2875
2876                 </div>
2877                 <div class="mdesc">
2878
2879                    <div class="short">Sort the Records.</div>
2880
2881
2882
2883                     <div class="long">
2884
2885                                 Sort the Records.<br/>If remote sorting is used, the sort is performed on the server, and the cache is<br/>reloaded. If local sorting is used, the cache is sorted internally.
2886
2887
2888
2889
2890
2891
2892                                 <dl class="detailList">
2893                                 <dt class="heading">Parameters:</dt>
2894
2895                                         <dt>
2896                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>fieldName</b>
2897
2898                                         </dt>
2899                                         <dd>The name of the field to sort by.</dd>
2900
2901                                         <dt>
2902                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>dir</b>
2903
2904                                         </dt>
2905                                         <dd>(optional) The sort order, "ASC" or "DESC" (defaults to "ASC")</dd>
2906
2907                                 </dl>
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919                     </div>
2920                 </div>
2921
2922             </td>
2923             <td class="msource">
2924
2925                         <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
2926                 &nbsp;
2927             </td>
2928         </tr>
2929
2930
2931           <tr class="method-row config-row-alt1 expandable">
2932             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2933
2934
2935             <td class="sig">
2936                 <a id="Roo.data.Store-method-sum"   name=".sum"></a>
2937                 <div class="fixedFont">
2938                         <span class="attributes"></span><b class="itemname">sum</b>
2939
2940                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>property</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>start</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>end</i></B>)
2941
2942
2943                                          :
2944
2945
2946                                                 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
2947
2948
2949
2950
2951
2952                 </div>
2953                 <div class="mdesc">
2954
2955                    <div class="short">Sums the value of <i>property</i> for each record between start and end and returns the result.</div>
2956
2957
2958
2959                     <div class="long">
2960
2961                                 Sums the value of <i>property</i> for each record between start and end and returns the result.
2962
2963
2964
2965
2966
2967
2968                                 <dl class="detailList">
2969                                 <dt class="heading">Parameters:</dt>
2970
2971                                         <dt>
2972                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>property</b>
2973
2974                                         </dt>
2975                                         <dd>A field on your records</dd>
2976
2977                                         <dt>
2978                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>start</b>
2979
2980                                         </dt>
2981                                         <dd>The record index to start at (defaults to 0)</dd>
2982
2983                                         <dt>
2984                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>end</b>
2985
2986                                         </dt>
2987                                         <dd>The last record index to include (defaults to length - 1)</dd>
2988
2989                                 </dl>
2990
2991
2992
2993
2994
2995                                 <dl class="detailList">
2996                                 <dt class="heading">Returns:</dt>
2997
2998                                         <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  The sum</dd>
2999
3000                                 </dl>
3001
3002
3003
3004
3005
3006
3007
3008                     </div>
3009                 </div>
3010
3011             </td>
3012             <td class="msource">
3013
3014                         <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
3015                 &nbsp;
3016             </td>
3017         </tr>
3018
3019
3020           <tr class="method-row config-row-alt0 expandable">
3021             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
3022
3023
3024             <td class="sig">
3025                 <a id="Roo.util.Observable-method-un"   name=".un"></a>
3026                 <div class="fixedFont">
3027                         <span class="attributes"></span><b class="itemname">un</b>
3028
3029                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
3030
3031
3032
3033                 </div>
3034                 <div class="mdesc">
3035
3036                    <div class="short">Removes a listener (shorthand for removeListener)</div>
3037
3038
3039
3040                     <div class="long">
3041
3042                                 Removes a listener (shorthand for removeListener)
3043
3044
3045
3046
3047
3048
3049                                 <dl class="detailList">
3050                                 <dt class="heading">Parameters:</dt>
3051
3052                                         <dt>
3053                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
3054
3055                                         </dt>
3056                                         <dd>The type of event to listen for</dd>
3057
3058                                         <dt>
3059                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
3060
3061                                         </dt>
3062                                         <dd>The handler to remove</dd>
3063
3064                                         <dt>
3065                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>scope</b>
3066
3067                                         </dt>
3068                                         <dd>(optional) The scope (this object) for the handler</dd>
3069
3070                                 </dl>
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082                     </div>
3083                 </div>
3084
3085             </td>
3086             <td class="msource">
3087
3088                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
3089                 &nbsp;
3090             </td>
3091         </tr>
3092
3093
3094     </table>
3095
3096
3097   <!-- ============================== events summary / details ======================== -->
3098
3099
3100   <a id="Roo.data.JsonStore-events"></a>
3101
3102
3103
3104
3105
3106
3107
3108
3109       <table cellspacing="0" class="member-table">
3110                 <caption>Events</caption>
3111               <thead>
3112                 <tr>
3113                     <th class="sig-header" colspan="2">Event</th>
3114                     <th class="msource-header">Defined By</th>
3115
3116                 </tr>
3117               </thead>
3118
3119
3120
3121
3122
3123           <tr class="method-row expandable config-row-alt0">
3124             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
3125
3126             <td class="sig">
3127                 <a id="Roo.data.Store-event-*add"></a>
3128
3129                <div class="fixedFont">
3130                 <b class="itemname">add</b> (Store <B><i>this</i></B>, <a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a>[] <B><i>records</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>index</i></B>)
3131
3132                 </div>
3133
3134                 <div class="mdesc">
3135
3136                    <div class="short">Fires when Records have been added to the Store
3137
3138                 </div>
3139
3140                     <div class="long">
3141
3142                         Fires when Records have been added to the Store
3143
3144
3145
3146
3147
3148                                 <dl class="detailList">
3149                                 <dt class="heading">Parameters:</dt>
3150
3151                                         <dt>
3152                                                 <span class="fixedFont">Store</span> <b>this</b>
3153
3154                                         </dt>
3155                                         <dd></dd>
3156
3157                                         <dt>
3158                                                 <span class="fixedFont"><a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a>[]</span> <b>records</b>
3159
3160                                         </dt>
3161                                         <dd>The array of Records added</dd>
3162
3163                                         <dt>
3164                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>index</b>
3165
3166                                         </dt>
3167                                         <dd>The index at which the record(s) were added</dd>
3168
3169                                 </dl>
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181                     </div>
3182                 </div>
3183
3184             </td>
3185             <td class="msource">
3186                 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
3187             </td>
3188         </tr>
3189
3190           <tr class="method-row expandable config-row-alt1">
3191             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
3192
3193             <td class="sig">
3194                 <a id="Roo.data.Store-event-*beforeload"></a>
3195
3196                <div class="fixedFont">
3197                 <b class="itemname">beforeload</b> (Store <B><i>this</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
3198
3199                 </div>
3200
3201                 <div class="mdesc">
3202
3203                    <div class="short">Fires before a request is made for a new data object.
3204
3205                 </div>
3206
3207                     <div class="long">
3208
3209                         Fires before a request is made for a new data object.  If the beforeload handler returns false<br/>the load action will be canceled.
3210
3211
3212
3213
3214
3215                                 <dl class="detailList">
3216                                 <dt class="heading">Parameters:</dt>
3217
3218                                         <dt>
3219                                                 <span class="fixedFont">Store</span> <b>this</b>
3220
3221                                         </dt>
3222                                         <dd></dd>
3223
3224                                         <dt>
3225                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>options</b>
3226
3227                                         </dt>
3228                                         <dd>The loading options that were specified (see {<b>link</b> <b>load</b>} for details)</dd>
3229
3230                                 </dl>
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242                     </div>
3243                 </div>
3244
3245             </td>
3246             <td class="msource">
3247                 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
3248             </td>
3249         </tr>
3250
3251           <tr class="method-row expandable config-row-alt0">
3252             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
3253
3254             <td class="sig">
3255                 <a id="Roo.data.Store-event-*beforeloadadd"></a>
3256
3257                <div class="fixedFont">
3258                 <b class="itemname">beforeloadadd</b> (Store <B><i>this</i></B>, <a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a>[] <B><i>records</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
3259
3260                 </div>
3261
3262                 <div class="mdesc">
3263
3264                    <div class="short">Fires after a new set of Records has been loaded.
3265
3266                 </div>
3267
3268                     <div class="long">
3269
3270                         Fires after a new set of Records has been loaded.
3271
3272
3273
3274
3275
3276                                 <dl class="detailList">
3277                                 <dt class="heading">Parameters:</dt>
3278
3279                                         <dt>
3280                                                 <span class="fixedFont">Store</span> <b>this</b>
3281
3282                                         </dt>
3283                                         <dd></dd>
3284
3285                                         <dt>
3286                                                 <span class="fixedFont"><a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a>[]</span> <b>records</b>
3287
3288                                         </dt>
3289                                         <dd>The Records that were loaded</dd>
3290
3291                                         <dt>
3292                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>options</b>
3293
3294                                         </dt>
3295                                         <dd>The loading options that were specified (see {<b>link</b> <b>load</b>} for details)</dd>
3296
3297                                 </dl>
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309                     </div>
3310                 </div>
3311
3312             </td>
3313             <td class="msource">
3314                 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
3315             </td>
3316         </tr>
3317
3318           <tr class="method-row expandable config-row-alt1">
3319             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
3320
3321             <td class="sig">
3322                 <a id="Roo.data.Store-event-*clear"></a>
3323
3324                <div class="fixedFont">
3325                 <b class="itemname">clear</b> (Store <B><i>this</i></B>)
3326
3327                 </div>
3328
3329                 <div class="mdesc">
3330
3331                    <div class="short">Fires when the data cache has been cleared.
3332
3333                 </div>
3334
3335                     <div class="long">
3336
3337                         Fires when the data cache has been cleared.
3338
3339
3340
3341
3342
3343                                 <dl class="detailList">
3344                                 <dt class="heading">Parameters:</dt>
3345
3346                                         <dt>
3347                                                 <span class="fixedFont">Store</span> <b>this</b>
3348
3349                                         </dt>
3350                                         <dd></dd>
3351
3352                                 </dl>
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364                     </div>
3365                 </div>
3366
3367             </td>
3368             <td class="msource">
3369                 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
3370             </td>
3371         </tr>
3372
3373           <tr class="method-row expandable config-row-alt0">
3374             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
3375
3376             <td class="sig">
3377                 <a id="Roo.data.Store-event-*datachanged"></a>
3378
3379                <div class="fixedFont">
3380                 <b class="itemname">datachanged</b> (Store <B><i>this</i></B>)
3381
3382                 </div>
3383
3384                 <div class="mdesc">
3385
3386                    <div class="short">Fires when the data cache has changed, and a widget which is using this Store<br/>as a Record cache should refresh its view.
3387
3388                 </div>
3389
3390                     <div class="long">
3391
3392                         Fires when the data cache has changed, and a widget which is using this Store<br/>as a Record cache should refresh its view.
3393
3394
3395
3396
3397
3398                                 <dl class="detailList">
3399                                 <dt class="heading">Parameters:</dt>
3400
3401                                         <dt>
3402                                                 <span class="fixedFont">Store</span> <b>this</b>
3403
3404                                         </dt>
3405                                         <dd></dd>
3406
3407                                 </dl>
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419                     </div>
3420                 </div>
3421
3422             </td>
3423             <td class="msource">
3424                 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
3425             </td>
3426         </tr>
3427
3428           <tr class="method-row expandable config-row-alt1">
3429             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
3430
3431             <td class="sig">
3432                 <a id="Roo.data.Store-event-*load"></a>
3433
3434                <div class="fixedFont">
3435                 <b class="itemname">load</b> (Store <B><i>this</i></B>, <a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a>[] <B><i>records</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
3436
3437                 </div>
3438
3439                 <div class="mdesc">
3440
3441                    <div class="short">Fires after a new set of Records has been loaded, before they are added to the store.
3442
3443                 </div>
3444
3445                     <div class="long">
3446
3447                         Fires after a new set of Records has been loaded, before they are added to the store.
3448
3449
3450
3451
3452
3453                                 <dl class="detailList">
3454                                 <dt class="heading">Parameters:</dt>
3455
3456                                         <dt>
3457                                                 <span class="fixedFont">Store</span> <b>this</b>
3458
3459                                         </dt>
3460                                         <dd></dd>
3461
3462                                         <dt>
3463                                                 <span class="fixedFont"><a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a>[]</span> <b>records</b>
3464
3465                                         </dt>
3466                                         <dd>The Records that were loaded</dd>
3467
3468                                         <dt>
3469                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>options</b>
3470
3471                                         </dt>
3472                                         <dd>The loading options that were specified (see {<b>link</b> <b>load</b>} for details)</dd>
3473
3474                                 </dl>
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486                     </div>
3487                 </div>
3488
3489             </td>
3490             <td class="msource">
3491                 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
3492             </td>
3493         </tr>
3494
3495           <tr class="method-row expandable config-row-alt0">
3496             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
3497
3498             <td class="sig">
3499                 <a id="Roo.data.Store-event-*loadexception"></a>
3500
3501                <div class="fixedFont">
3502                 <b class="itemname">loadexception</b> (Proxy <B><i></i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>return</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>load</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>jsonData</i></B>)
3503
3504                 </div>
3505
3506                 <div class="mdesc">
3507
3508                    <div class="short">Fires if an exception occurs in the Proxy during loading.
3509
3510                 </div>
3511
3512                     <div class="long">
3513
3514                         Fires if an exception occurs in the Proxy during loading.<br/>Called with the signature of the Proxy's "loadexception" event.<br/>If you return Json { data: [] , success: false, .... } then this will be thrown with the following args
3515
3516
3517
3518
3519
3520                                 <dl class="detailList">
3521                                 <dt class="heading">Parameters:</dt>
3522
3523                                         <dt>
3524                                                 <span class="fixedFont">Proxy</span> <b></b>
3525
3526                                         </dt>
3527                                         <dd></dd>
3528
3529                                         <dt>
3530                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>return</b>
3531
3532                                         </dt>
3533                                         <dd>from JsonData.reader() - success, totalRecords, records</dd>
3534
3535                                         <dt>
3536                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>load</b>
3537
3538                                         </dt>
3539                                         <dd>options</dd>
3540
3541                                         <dt>
3542                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>jsonData</b>
3543
3544                                         </dt>
3545                                         <dd>from your request (normally this contains the Exception)</dd>
3546
3547                                 </dl>
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559                     </div>
3560                 </div>
3561
3562             </td>
3563             <td class="msource">
3564                 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
3565             </td>
3566         </tr>
3567
3568           <tr class="method-row expandable config-row-alt1">
3569             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
3570
3571             <td class="sig">
3572                 <a id="Roo.data.Store-event-*metachange"></a>
3573
3574                <div class="fixedFont">
3575                 <b class="itemname">metachange</b> (Store <B><i>this</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>meta</i></B>)
3576
3577                 </div>
3578
3579                 <div class="mdesc">
3580
3581                    <div class="short">Fires when this store's reader provides new metadata (fields).
3582
3583                 </div>
3584
3585                     <div class="long">
3586
3587                         Fires when this store's reader provides new metadata (fields). This is currently only support for JsonReaders.
3588
3589
3590
3591
3592
3593                                 <dl class="detailList">
3594                                 <dt class="heading">Parameters:</dt>
3595
3596                                         <dt>
3597                                                 <span class="fixedFont">Store</span> <b>this</b>
3598
3599                                         </dt>
3600                                         <dd></dd>
3601
3602                                         <dt>
3603                                                 <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>
3604
3605                                         </dt>
3606                                         <dd>The JSON metadata</dd>
3607
3608                                 </dl>
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620                     </div>
3621                 </div>
3622
3623             </td>
3624             <td class="msource">
3625                 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
3626             </td>
3627         </tr>
3628
3629           <tr class="method-row expandable config-row-alt0">
3630             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
3631
3632             <td class="sig">
3633                 <a id="Roo.data.Store-event-*remove"></a>
3634
3635                <div class="fixedFont">
3636                 <b class="itemname">remove</b> (Store <B><i>this</i></B>, <a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a> <B><i>record</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>index</i></B>)
3637
3638                 </div>
3639
3640                 <div class="mdesc">
3641
3642                    <div class="short">Fires when a Record has been removed from the Store
3643
3644                 </div>
3645
3646                     <div class="long">
3647
3648                         Fires when a Record has been removed from the Store
3649
3650
3651
3652
3653
3654                                 <dl class="detailList">
3655                                 <dt class="heading">Parameters:</dt>
3656
3657                                         <dt>
3658                                                 <span class="fixedFont">Store</span> <b>this</b>
3659
3660                                         </dt>
3661                                         <dd></dd>
3662
3663                                         <dt>
3664                                                 <span class="fixedFont"><a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a></span> <b>record</b>
3665
3666                                         </dt>
3667                                         <dd>The Record that was removed</dd>
3668
3669                                         <dt>
3670                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>index</b>
3671
3672                                         </dt>
3673                                         <dd>The index at which the record was removed</dd>
3674
3675                                 </dl>
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687                     </div>
3688                 </div>
3689
3690             </td>
3691             <td class="msource">
3692                 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
3693             </td>
3694         </tr>
3695
3696           <tr class="method-row expandable config-row-alt1">
3697             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
3698
3699             <td class="sig">
3700                 <a id="Roo.data.Store-event-*update"></a>
3701
3702                <div class="fixedFont">
3703                 <b class="itemname">update</b> (Store <B><i>this</i></B>, <a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a> <B><i>record</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>operation</i></B>)
3704
3705                 </div>
3706
3707                 <div class="mdesc">
3708
3709                    <div class="short">Fires when a Record has been updated
3710
3711                 </div>
3712
3713                     <div class="long">
3714
3715                         Fires when a Record has been updated
3716
3717
3718
3719
3720
3721                                 <dl class="detailList">
3722                                 <dt class="heading">Parameters:</dt>
3723
3724                                         <dt>
3725                                                 <span class="fixedFont">Store</span> <b>this</b>
3726
3727                                         </dt>
3728                                         <dd></dd>
3729
3730                                         <dt>
3731                                                 <span class="fixedFont"><a href="./Roo.data.Record.html#constructor" roo:cls="Roo.data.Record.html#constructor">Roo.data.Record</a></span> <b>record</b>
3732
3733                                         </dt>
3734                                         <dd>The Record that was updated</dd>
3735
3736                                         <dt>
3737                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>operation</b>
3738
3739                                         </dt>
3740                                         <dd>The update operation being performed.  Value may be one of:<br/><pre><code><br/> Roo.data.Record.EDIT<br/> Roo.data.Record.REJECT<br/> Roo.data.Record.COMMIT<br/></code></pre></dd>
3741
3742                                 </dl>
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754                     </div>
3755                 </div>
3756
3757             </td>
3758             <td class="msource">
3759                 <a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a>
3760             </td>
3761         </tr>
3762
3763
3764     </table>
3765
3766
3767
3768
3769
3770 <!-- ============================== footer ================================= -->
3771                 <div class="fineprint" style="clear:both">
3772
3773                         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)
3774                         Based on
3775                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
3776                 </div>
3777         </body>
3778 </html>