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