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