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