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