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