git.roojs.org Git - roojs1/blob - docs/symbols/Roo.data.SimpleStore.html

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