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

   1 {
   2   "name" : "Roo.data.SimpleStore",
   3   "augments" : [
   4     "Roo.data.Store",
   5     "Roo.util.Observable"
   6   ],
   7   "desc" : "Small helper class to make creating Stores from Array data easier.",
   8   "isSingleton" : false,
   9   "isStatic" : false,
  10   "isBuiltin" : false,
  11   "memberOf" : "SimpleStore",
  12   "example" : "",
  13   "deprecated" : "",
  14   "since" : "",
  15   "see" : "",
  16   "params" : [
  17     {
  18       "name" : "config",
  19       "type" : "Object",
  20       "desc" : "",
  21       "isOptional" : false
  22     }
  23   ],
  24   "returns" : [
  25   ],
  26   "config" : [
  27     {
  28       "name" : "listeners",
  29       "type" : "Object",
  30       "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  </code></pre>",
  31       "memberOf" : "Roo.util.Observable",
  32       "values" : [
  33       ]
  34     },
  35     {
  36       "name" : "id",
  37       "type" : "Number",
  38       "desc" : "The array index of the record id. Leave blank to auto generate ids.",
  39       "memberOf" : "Roo.data.SimpleStore",
  40       "values" : [
  41       ]
  42     },
  43     {
  44       "name" : "fields",
  45       "type" : "Array",
  46       "desc" : "An array of field definition objects, or field name strings.",
  47       "memberOf" : "Roo.data.SimpleStore",
  48       "values" : [
  49       ]
  50     },
  51     {
  52       "name" : "proxy",
  53       "type" : "Roo.data.DataProxy",
  54       "desc" : "The Proxy object which provides access to a data object.",
  55       "memberOf" : "Roo.data.Store",
  56       "values" : [
  57       ]
  58     },
  59     {
  60       "name" : "multiSort",
  61       "type" : "Boolean",
  62       "desc" : "enable multi column sorting (sort is based on the order of columns, remote only at present)",
  63       "memberOf" : "Roo.data.Store",
  64       "values" : [
  65       ]
  66     },
  67     {
  68       "name" : "pruneModifiedRecords",
  69       "type" : "boolean",
  70       "desc" : "True to clear all modified record information each time the store is\nloaded or when a record is removed. (defaults to false).",
  71       "memberOf" : "Roo.data.Store",
  72       "values" : [
  73       ]
  74     },
  75     {
  76       "name" : "remoteSort",
  77       "type" : "boolean",
  78       "desc" : "True if sorting is to be handled by requesting the Proxy to provide a refreshed\nversion of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false).",
  79       "memberOf" : "Roo.data.Store",
  80       "values" : [
  81       ]
  82     },
  83     {
  84       "name" : "data",
  85       "type" : "Array",
  86       "desc" : "The multi-dimensional array of data",
  87       "memberOf" : "Roo.data.SimpleStore",
  88       "values" : [
  89       ]
  90     },
  91     {
  92       "name" : "sortInfo",
  93       "type" : "Object",
  94       "desc" : "A config object in the format: {field: \"fieldName\", direction: \"ASC|DESC\"}",
  95       "memberOf" : "Roo.data.Store",
  96       "values" : [
  97       ]
  98     },
  99     {
 100       "name" : "baseParams",
 101       "type" : "Object",
 102       "desc" : "An object containing properties which are to be sent as parameters\non any HTTP request",
 103       "memberOf" : "Roo.data.Store",
 104       "values" : [
 105       ]
 106     },
 107     {
 108       "name" : "reader",
 109       "type" : "Roo.data.Reader",
 110       "desc" : "The Reader object which processes the data object and returns\nan Array of Roo.data.record objects which are cached keyed by their <em>id</em> property.",
 111       "memberOf" : "Roo.data.Store",
 112       "values" : [
 113       ]
 114     },
 115     {
 116       "name" : "isLocal",
 117       "type" : "boolean",
 118       "desc" : "flag if data is locally available (and can be always looked up\nwithout a remote query - used by combo/forms at present.",
 119       "memberOf" : "Roo.data.Store",
 120       "values" : [
 121       ]
 122     }
 123   ],
 124   "methods" : [
 125     {
 126       "name" : "reload",
 127       "desc" : "Reloads the Record cache from the configured Proxy using the configured Reader and\nthe options from the last load operation performed.",
 128       "isStatic" : false,
 129       "isConstructor" : false,
 130       "isPrivate" : false,
 131       "memberOf" : "Roo.data.Store",
 132       "example" : "",
 133       "deprecated" : "",
 134       "since" : "",
 135       "see" : "",
 136       "params" : [
 137         {
 138           "name" : "options",
 139           "type" : "Object",
 140           "desc" : "(optional) An object containing properties which may override the options\nused in the last load operation. See {@link #load} for details (defaults to null, in which case\nthe most recently used options are reused).",
 141           "isOptional" : false
 142         }
 143       ],
 144       "returns" : [
 145       ]
 146     },
 147     {
 148       "name" : "removeAll",
 149       "desc" : "Remove all Records from the Store and fires the clear event.",
 150       "isStatic" : false,
 151       "isConstructor" : false,
 152       "isPrivate" : false,
 153       "memberOf" : "Roo.data.Store",
 154       "example" : "",
 155       "deprecated" : "",
 156       "since" : "",
 157       "see" : "",
 158       "params" : [
 159       ],
 160       "returns" : [
 161       ]
 162     },
 163     {
 164       "name" : "query",
 165       "desc" : "Query the records by a specified property.",
 166       "isStatic" : false,
 167       "isConstructor" : false,
 168       "isPrivate" : false,
 169       "memberOf" : "Roo.data.Store",
 170       "example" : "",
 171       "deprecated" : "",
 172       "since" : "",
 173       "see" : "",
 174       "params" : [
 175         {
 176           "name" : "field",
 177           "type" : "String",
 178           "desc" : "A field on your records",
 179           "isOptional" : false
 180         },
 181         {
 182           "name" : "value",
 183           "type" : "String/RegExp",
 184           "desc" : "Either a string that the field\nshould start with or a RegExp to test against the field",
 185           "isOptional" : false
 186         },
 187         {
 188           "name" : "anyMatch",
 189           "type" : "Boolean",
 190           "desc" : "True to match any part not just the beginning",
 191           "isOptional" : false
 192         }
 193       ],
 194       "returns" : [
 195         {
 196           "name" : "",
 197           "type" : "MixedCollection",
 198           "desc" : "Returns an Roo.util.MixedCollection of the matched records"
 199         }
 200       ]
 201     },
 202     {
 203       "name" : "sum",
 204       "desc" : "Sums the value of <i>property</i> for each record between start and end and returns the result.",
 205       "isStatic" : false,
 206       "isConstructor" : false,
 207       "isPrivate" : false,
 208       "memberOf" : "Roo.data.Store",
 209       "example" : "",
 210       "deprecated" : "",
 211       "since" : "",
 212       "see" : "",
 213       "params" : [
 214         {
 215           "name" : "property",
 216           "type" : "String",
 217           "desc" : "A field on your records",
 218           "isOptional" : false
 219         },
 220         {
 221           "name" : "start",
 222           "type" : "Number",
 223           "desc" : "The record index to start at (defaults to 0)",
 224           "isOptional" : false
 225         },
 226         {
 227           "name" : "end",
 228           "type" : "Number",
 229           "desc" : "The last record index to include (defaults to length - 1)",
 230           "isOptional" : false
 231         }
 232       ],
 233       "returns" : [
 234         {
 235           "name" : "",
 236           "type" : "Number",
 237           "desc" : "The sum"
 238         }
 239       ]
 240     },
 241     {
 242       "name" : "getById",
 243       "desc" : "Get the Record with the specified id.",
 244       "isStatic" : false,
 245       "isConstructor" : false,
 246       "isPrivate" : false,
 247       "memberOf" : "Roo.data.Store",
 248       "example" : "",
 249       "deprecated" : "",
 250       "since" : "",
 251       "see" : "",
 252       "params" : [
 253         {
 254           "name" : "id",
 255           "type" : "String",
 256           "desc" : "The id of the Record to find.",
 257           "isOptional" : false
 258         }
 259       ],
 260       "returns" : [
 261         {
 262           "name" : "",
 263           "type" : "Roo.data.Record",
 264           "desc" : "The Record with the passed id. Returns undefined if not found."
 265         }
 266       ]
 267     },
 268     {
 269       "name" : "commitChanges",
 270       "desc" : "Commit all Records with outstanding changes. To handle updates for changes, subscribe to the\nStore's \"update\" event, and perform updating when the third parameter is Roo.data.Record.COMMIT.",
 271       "isStatic" : false,
 272       "isConstructor" : false,
 273       "isPrivate" : false,
 274       "memberOf" : "Roo.data.Store",
 275       "example" : "",
 276       "deprecated" : "",
 277       "since" : "",
 278       "see" : "",
 279       "params" : [
 280       ],
 281       "returns" : [
 282       ]
 283     },
 284     {
 285       "name" : "getCount",
 286       "desc" : "Gets the number of cached records.\n<p>\n<em>If using paging, this may not be the total size of the dataset. If the data object\nused by the Reader contains the dataset size, then the getTotalCount() function returns\nthe data set size</em>",
 287       "isStatic" : false,
 288       "isConstructor" : false,
 289       "isPrivate" : false,
 290       "memberOf" : "Roo.data.Store",
 291       "example" : "",
 292       "deprecated" : "",
 293       "since" : "",
 294       "see" : "",
 295       "params" : [
 296       ],
 297       "returns" : [
 298       ]
 299     },
 300     {
 301       "name" : "indexOf",
 302       "desc" : "Get the index within the cache of the passed Record.",
 303       "isStatic" : false,
 304       "isConstructor" : false,
 305       "isPrivate" : false,
 306       "memberOf" : "Roo.data.Store",
 307       "example" : "",
 308       "deprecated" : "",
 309       "since" : "",
 310       "see" : "",
 311       "params" : [
 312         {
 313           "name" : "record",
 314           "type" : "Roo.data.Record",
 315           "desc" : "The Roo.data.Record object to to find.",
 316           "isOptional" : false
 317         }
 318       ],
 319       "returns" : [
 320         {
 321           "name" : "",
 322           "type" : "Number",
 323           "desc" : "The index of the passed Record. Returns -1 if not found."
 324         }
 325       ]
 326     },
 327     {
 328       "name" : "add",
 329       "desc" : "Add Records to the Store and fires the add event.",
 330       "isStatic" : false,
 331       "isConstructor" : false,
 332       "isPrivate" : false,
 333       "memberOf" : "Roo.data.Store",
 334       "example" : "",
 335       "deprecated" : "",
 336       "since" : "",
 337       "see" : "",
 338       "params" : [
 339         {
 340           "name" : "records",
 341           "type" : "Roo.data.Record[]",
 342           "desc" : "An Array of Roo.data.Record objects to add to the cache.",
 343           "isOptional" : false
 344         }
 345       ],
 346       "returns" : [
 347       ]
 348     },
 349     {
 350       "name" : "indexOfId",
 351       "desc" : "Get the index within the cache of the Record with the passed id.",
 352       "isStatic" : false,
 353       "isConstructor" : false,
 354       "isPrivate" : false,
 355       "memberOf" : "Roo.data.Store",
 356       "example" : "",
 357       "deprecated" : "",
 358       "since" : "",
 359       "see" : "",
 360       "params" : [
 361         {
 362           "name" : "id",
 363           "type" : "String",
 364           "desc" : "The id of the Record to find.",
 365           "isOptional" : false
 366         }
 367       ],
 368       "returns" : [
 369         {
 370           "name" : "",
 371           "type" : "Number",
 372           "desc" : "The index of the Record. Returns -1 if not found."
 373         }
 374       ]
 375     },
 376     {
 377       "name" : "filter",
 378       "desc" : "Filter the records by a specified property.",
 379       "isStatic" : false,
 380       "isConstructor" : false,
 381       "isPrivate" : false,
 382       "memberOf" : "Roo.data.Store",
 383       "example" : "",
 384       "deprecated" : "",
 385       "since" : "",
 386       "see" : "",
 387       "params" : [
 388         {
 389           "name" : "field",
 390           "type" : "String",
 391           "desc" : "A field on your records",
 392           "isOptional" : false
 393         },
 394         {
 395           "name" : "value",
 396           "type" : "String/RegExp",
 397           "desc" : "Either a string that the field\nshould start with or a RegExp to test against the field",
 398           "isOptional" : false
 399         },
 400         {
 401           "name" : "anyMatch",
 402           "type" : "Boolean",
 403           "desc" : "True to match any part not just the beginning",
 404           "isOptional" : false
 405         }
 406       ],
 407       "returns" : [
 408       ]
 409     },
 410     {
 411       "name" : "sort",
 412       "desc" : "Sort the Records.\nIf remote sorting is used, the sort is performed on the server, and the cache is\nreloaded. If local sorting is used, the cache is sorted internally.",
 413       "isStatic" : false,
 414       "isConstructor" : false,
 415       "isPrivate" : false,
 416       "memberOf" : "Roo.data.Store",
 417       "example" : "",
 418       "deprecated" : "",
 419       "since" : "",
 420       "see" : "",
 421       "params" : [
 422         {
 423           "name" : "fieldName",
 424           "type" : "String",
 425           "desc" : "The name of the field to sort by.",
 426           "isOptional" : false
 427         },
 428         {
 429           "name" : "dir",
 430           "type" : "String",
 431           "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")",
 432           "isOptional" : false
 433         }
 434       ],
 435       "returns" : [
 436       ]
 437     },
 438     {
 439       "name" : "getRange",
 440       "desc" : "Returns a range of Records between specified indices.",
 441       "isStatic" : false,
 442       "isConstructor" : false,
 443       "isPrivate" : false,
 444       "memberOf" : "Roo.data.Store",
 445       "example" : "",
 446       "deprecated" : "",
 447       "since" : "",
 448       "see" : "",
 449       "params" : [
 450         {
 451           "name" : "startIndex",
 452           "type" : "Number",
 453           "desc" : "(optional) The starting index (defaults to 0)",
 454           "isOptional" : false
 455         },
 456         {
 457           "name" : "endIndex",
 458           "type" : "Number",
 459           "desc" : "(optional) The ending index (defaults to the last Record in the Store)",
 460           "isOptional" : false
 461         }
 462       ],
 463       "returns" : [
 464         {
 465           "name" : "",
 466           "type" : "Roo.data.Record[]",
 467           "desc" : "An array of Records"
 468         }
 469       ]
 470     },
 471     {
 472       "name" : "queryBy",
 473       "desc" : "Query by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included\nin the results.",
 474       "isStatic" : false,
 475       "isConstructor" : false,
 476       "isPrivate" : false,
 477       "memberOf" : "Roo.data.Store",
 478       "example" : "",
 479       "deprecated" : "",
 480       "since" : "",
 481       "see" : "",
 482       "params" : [
 483         {
 484           "name" : "fn",
 485           "type" : "Function",
 486           "desc" : "The function to be called, it will receive 2 args (record, id)",
 487           "isOptional" : false
 488         },
 489         {
 490           "name" : "scope",
 491           "type" : "Object",
 492           "desc" : "(optional) The scope of the function (defaults to this)",
 493           "isOptional" : false
 494         }
 495       ],
 496       "returns" : [
 497         {
 498           "name" : "",
 499           "type" : "MixedCollection",
 500           "desc" : "Returns an Roo.util.MixedCollection of the matched records"
 501         }
 502       ]
 503     },
 504     {
 505       "name" : "clearFilter",
 506       "desc" : "Revert to a view of the Record cache with no filtering applied.",
 507       "isStatic" : false,
 508       "isConstructor" : false,
 509       "isPrivate" : false,
 510       "memberOf" : "Roo.data.Store",
 511       "example" : "",
 512       "deprecated" : "",
 513       "since" : "",
 514       "see" : "",
 515       "params" : [
 516         {
 517           "name" : "suppressEvent",
 518           "type" : "Boolean",
 519           "desc" : "If true the filter is cleared silently without notifying listeners",
 520           "isOptional" : false
 521         }
 522       ],
 523       "returns" : [
 524       ]
 525     },
 526     {
 527       "name" : "each",
 528       "desc" : "Calls the specified function for each of the Records in the cache.",
 529       "isStatic" : false,
 530       "isConstructor" : false,
 531       "isPrivate" : false,
 532       "memberOf" : "Roo.data.Store",
 533       "example" : "",
 534       "deprecated" : "",
 535       "since" : "",
 536       "see" : "",
 537       "params" : [
 538         {
 539           "name" : "fn",
 540           "type" : "Function",
 541           "desc" : "The function to call. The Record is passed as the first parameter.\nReturning <em>false</em> aborts and exits the iteration.",
 542           "isOptional" : false
 543         },
 544         {
 545           "name" : "scope",
 546           "type" : "Object",
 547           "desc" : "(optional) The scope in which to call the function (defaults to the Record).",
 548           "isOptional" : false
 549         }
 550       ],
 551       "returns" : [
 552       ]
 553     },
 554     {
 555       "name" : "rejectChanges",
 556       "desc" : "Cancel outstanding changes on all changed records.",
 557       "isStatic" : false,
 558       "isConstructor" : false,
 559       "isPrivate" : false,
 560       "memberOf" : "Roo.data.Store",
 561       "example" : "",
 562       "deprecated" : "",
 563       "since" : "",
 564       "see" : "",
 565       "params" : [
 566       ],
 567       "returns" : [
 568       ]
 569     },
 570     {
 571       "name" : "getAt",
 572       "desc" : "Get the Record at the specified index.",
 573       "isStatic" : false,
 574       "isConstructor" : false,
 575       "isPrivate" : false,
 576       "memberOf" : "Roo.data.Store",
 577       "example" : "",
 578       "deprecated" : "",
 579       "since" : "",
 580       "see" : "",
 581       "params" : [
 582         {
 583           "name" : "index",
 584           "type" : "Number",
 585           "desc" : "The index of the Record to find.",
 586           "isOptional" : false
 587         }
 588       ],
 589       "returns" : [
 590         {
 591           "name" : "",
 592           "type" : "Roo.data.Record",
 593           "desc" : "The Record at the passed index. Returns undefined if not found."
 594         }
 595       ]
 596     },
 597     {
 598       "name" : "getTotalCount",
 599       "desc" : "Gets the total number of records in the dataset as returned by the server.\n<p>\n<em>If using paging, for this to be accurate, the data object used by the Reader must contain\nthe dataset size</em>",
 600       "isStatic" : false,
 601       "isConstructor" : false,
 602       "isPrivate" : false,
 603       "memberOf" : "Roo.data.Store",
 604       "example" : "",
 605       "deprecated" : "",
 606       "since" : "",
 607       "see" : "",
 608       "params" : [
 609       ],
 610       "returns" : [
 611       ]
 612     },
 613     {
 614       "name" : "filterBy",
 615       "desc" : "Filter by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included,\notherwise it is filtered.",
 616       "isStatic" : false,
 617       "isConstructor" : false,
 618       "isPrivate" : false,
 619       "memberOf" : "Roo.data.Store",
 620       "example" : "",
 621       "deprecated" : "",
 622       "since" : "",
 623       "see" : "",
 624       "params" : [
 625         {
 626           "name" : "fn",
 627           "type" : "Function",
 628           "desc" : "The function to be called, it will receive 2 args (record, id)",
 629           "isOptional" : false
 630         },
 631         {
 632           "name" : "scope",
 633           "type" : "Object",
 634           "desc" : "(optional) The scope of the function (defaults to this)",
 635           "isOptional" : false
 636         }
 637       ],
 638       "returns" : [
 639       ]
 640     },
 641     {
 642       "name" : "collect",
 643       "desc" : "Collects unique values for a particular dataIndex from this store.",
 644       "isStatic" : false,
 645       "isConstructor" : false,
 646       "isPrivate" : false,
 647       "memberOf" : "Roo.data.Store",
 648       "example" : "",
 649       "deprecated" : "",
 650       "since" : "",
 651       "see" : "",
 652       "params" : [
 653         {
 654           "name" : "dataIndex",
 655           "type" : "String",
 656           "desc" : "The property to collect",
 657           "isOptional" : false
 658         },
 659         {
 660           "name" : "allowNull",
 661           "type" : "Boolean",
 662           "desc" : "(optional) Pass true to allow null, undefined or empty string values",
 663           "isOptional" : false
 664         },
 665         {
 666           "name" : "bypassFilter",
 667           "type" : "Boolean",
 668           "desc" : "(optional) Pass true to collect from all records, even ones which are filtered",
 669           "isOptional" : false
 670         }
 671       ],
 672       "returns" : [
 673         {
 674           "name" : "",
 675           "type" : "Array",
 676           "desc" : "An array of the unique values"
 677         }
 678       ]
 679     },
 680     {
 681       "name" : "getModifiedRecords",
 682       "desc" : "Gets all records modified since the last commit.  Modified records are persisted across load operations\n(e.g., during paging).",
 683       "isStatic" : false,
 684       "isConstructor" : false,
 685       "isPrivate" : false,
 686       "memberOf" : "Roo.data.Store",
 687       "example" : "",
 688       "deprecated" : "",
 689       "since" : "",
 690       "see" : "",
 691       "params" : [
 692       ],
 693       "returns" : [
 694         {
 695           "name" : "",
 696           "type" : "Roo.data.Record[]",
 697           "desc" : "An array of Records containing outstanding modifications."
 698         }
 699       ]
 700     },
 701     {
 702       "name" : "remove",
 703       "desc" : "Remove a Record from the Store and fires the remove event.",
 704       "isStatic" : false,
 705       "isConstructor" : false,
 706       "isPrivate" : false,
 707       "memberOf" : "Roo.data.Store",
 708       "example" : "",
 709       "deprecated" : "",
 710       "since" : "",
 711       "see" : "",
 712       "params" : [
 713         {
 714           "name" : "record",
 715           "type" : "Ext.data.Record",
 716           "desc" : "The Roo.data.Record object to remove from the cache.",
 717           "isOptional" : false
 718         }
 719       ],
 720       "returns" : [
 721       ]
 722     },
 723     {
 724       "name" : "loadData",
 725       "desc" : "Loads data from a passed data block. A Reader which understands the format of the data\nmust have been configured in the constructor.",
 726       "isStatic" : false,
 727       "isConstructor" : false,
 728       "isPrivate" : false,
 729       "memberOf" : "Roo.data.Store",
 730       "example" : "",
 731       "deprecated" : "",
 732       "since" : "",
 733       "see" : "",
 734       "params" : [
 735         {
 736           "name" : "data",
 737           "type" : "Object",
 738           "desc" : "The data block from which to read the Records.  The format of the data expected\nis dependent on the type of Reader that is configured and should correspond to that Reader's readRecords parameter.",
 739           "isOptional" : false
 740         },
 741         {
 742           "name" : "append",
 743           "type" : "Boolean",
 744           "desc" : "(Optional) True to append the new Records rather than replace the existing cache.",
 745           "isOptional" : false
 746         }
 747       ],
 748       "returns" : [
 749       ]
 750     },
 751     {
 752       "name" : "load",
 753       "desc" : "Loads the Record cache from the configured Proxy using the configured Reader.\n<p>\nIf using remote paging, then the first load call must specify the <em>start</em>\nand <em>limit</em> properties in the options.params property to establish the initial\nposition within the dataset, and the number of Records to cache on each read from the Proxy.\n<p>\n<strong>It is important to note that for remote data sources, loading is asynchronous,\nand this call will return before the new data has been loaded. Perform any post-processing\nin a callback function, or in a \"load\" event handler.</strong>\n<p>",
 754       "isStatic" : false,
 755       "isConstructor" : false,
 756       "isPrivate" : false,
 757       "memberOf" : "Roo.data.Store",
 758       "example" : "",
 759       "deprecated" : "",
 760       "since" : "",
 761       "see" : "",
 762       "params" : [
 763         {
 764           "name" : "options",
 765           "type" : "Object",
 766           "desc" : "An object containing properties which control loading options:<ul>\n<li>params {Object} An object containing properties to pass as HTTP parameters to a remote data source.</li>\n<li>callback {Function} A function to be called after the Records have been loaded. The callback is\npassed the following arguments:<ul>\n<li>r : Roo.data.Record[]</li>\n<li>options: Options object from the load call</li>\n<li>success: Boolean success indicator</li></ul></li>\n<li>scope {Object} Scope with which to call the callback (defaults to the Store object)</li>\n<li>add {Boolean} indicator to append loaded records rather than replace the current cache.</li>\n</ul>",
 767           "isOptional" : false
 768         }
 769       ],
 770       "returns" : [
 771       ]
 772     },
 773     {
 774       "name" : "setDefaultSort",
 775       "desc" : "Sets the default sort column and order to be used by the next load operation.",
 776       "isStatic" : false,
 777       "isConstructor" : false,
 778       "isPrivate" : false,
 779       "memberOf" : "Roo.data.Store",
 780       "example" : "",
 781       "deprecated" : "",
 782       "since" : "",
 783       "see" : "",
 784       "params" : [
 785         {
 786           "name" : "fieldName",
 787           "type" : "String",
 788           "desc" : "The name of the field to sort by.",
 789           "isOptional" : false
 790         },
 791         {
 792           "name" : "dir",
 793           "type" : "String",
 794           "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")",
 795           "isOptional" : false
 796         }
 797       ],
 798       "returns" : [
 799       ]
 800     },
 801     {
 802       "name" : "insert",
 803       "desc" : "Inserts Records to the Store at the given index and fires the add event.",
 804       "isStatic" : false,
 805       "isConstructor" : false,
 806       "isPrivate" : false,
 807       "memberOf" : "Roo.data.Store",
 808       "example" : "",
 809       "deprecated" : "",
 810       "since" : "",
 811       "see" : "",
 812       "params" : [
 813         {
 814           "name" : "index",
 815           "type" : "Number",
 816           "desc" : "The start index at which to insert the passed Records.",
 817           "isOptional" : false
 818         },
 819         {
 820           "name" : "records",
 821           "type" : "Roo.data.Record[]",
 822           "desc" : "An Array of Roo.data.Record objects to add to the cache.",
 823           "isOptional" : false
 824         }
 825       ],
 826       "returns" : [
 827       ]
 828     },
 829     {
 830       "name" : "getSortState",
 831       "desc" : "Returns the sort state of the Store as an object with two properties:\n<pre><code>\n field {String} The name of the field by which the Records are sorted\n direction {String} The sort order, \"ASC\" or \"DESC\"\n</code></pre>",
 832       "isStatic" : false,
 833       "isConstructor" : false,
 834       "isPrivate" : false,
 835       "memberOf" : "Roo.data.Store",
 836       "example" : "",
 837       "deprecated" : "",
 838       "since" : "",
 839       "see" : "",
 840       "params" : [
 841       ],
 842       "returns" : [
 843       ]
 844     },
 845     {
 846       "name" : "purgeListeners",
 847       "desc" : "Removes all listeners for this object",
 848       "isStatic" : false,
 849       "isConstructor" : false,
 850       "isPrivate" : false,
 851       "memberOf" : "Roo.util.Observable",
 852       "example" : "",
 853       "deprecated" : "",
 854       "since" : "",
 855       "see" : "",
 856       "params" : [
 857       ],
 858       "returns" : [
 859       ]
 860     },
 861     {
 862       "name" : "on",
 863       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 864       "isStatic" : false,
 865       "isConstructor" : false,
 866       "isPrivate" : false,
 867       "memberOf" : "Roo.util.Observable",
 868       "example" : "",
 869       "deprecated" : "",
 870       "since" : "",
 871       "see" : "",
 872       "params" : [
 873         {
 874           "name" : "eventName",
 875           "type" : "String",
 876           "desc" : "The type of event to listen for",
 877           "isOptional" : false
 878         },
 879         {
 880           "name" : "handler",
 881           "type" : "Function",
 882           "desc" : "The method the event invokes",
 883           "isOptional" : false
 884         },
 885         {
 886           "name" : "scope",
 887           "type" : "Object",
 888           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 889           "isOptional" : false
 890         },
 891         {
 892           "name" : "options",
 893           "type" : "Object",
 894           "desc" : "(optional)",
 895           "isOptional" : false
 896         }
 897       ],
 898       "returns" : [
 899       ]
 900     },
 901     {
 902       "name" : "un",
 903       "desc" : "Removes a listener (shorthand for removeListener)",
 904       "isStatic" : false,
 905       "isConstructor" : false,
 906       "isPrivate" : false,
 907       "memberOf" : "Roo.util.Observable",
 908       "example" : "",
 909       "deprecated" : "",
 910       "since" : "",
 911       "see" : "",
 912       "params" : [
 913         {
 914           "name" : "eventName",
 915           "type" : "String",
 916           "desc" : "The type of event to listen for",
 917           "isOptional" : false
 918         },
 919         {
 920           "name" : "handler",
 921           "type" : "Function",
 922           "desc" : "The handler to remove",
 923           "isOptional" : false
 924         },
 925         {
 926           "name" : "scope",
 927           "type" : "Object",
 928           "desc" : "(optional) The scope (this object) for the handler",
 929           "isOptional" : false
 930         }
 931       ],
 932       "returns" : [
 933       ]
 934     },
 935     {
 936       "name" : "addEvents",
 937       "desc" : "Used to define events on this Observable",
 938       "isStatic" : false,
 939       "isConstructor" : false,
 940       "isPrivate" : false,
 941       "memberOf" : "Roo.util.Observable",
 942       "example" : "",
 943       "deprecated" : "",
 944       "since" : "",
 945       "see" : "",
 946       "params" : [
 947         {
 948           "name" : "object",
 949           "type" : "Object",
 950           "desc" : "The object with the events defined",
 951           "isOptional" : false
 952         }
 953       ],
 954       "returns" : [
 955       ]
 956     },
 957     {
 958       "name" : "releaseCapture",
 959       "desc" : "Removes <b>all</b> added captures from the Observable.",
 960       "isStatic" : true,
 961       "isConstructor" : false,
 962       "isPrivate" : false,
 963       "memberOf" : "Roo.util.Observable",
 964       "example" : "",
 965       "deprecated" : "",
 966       "since" : "",
 967       "see" : "",
 968       "params" : [
 969         {
 970           "name" : "o",
 971           "type" : "Observable",
 972           "desc" : "The Observable to release",
 973           "isOptional" : false
 974         }
 975       ],
 976       "returns" : [
 977       ]
 978     },
 979     {
 980       "name" : "removeListener",
 981       "desc" : "Removes a listener",
 982       "isStatic" : false,
 983       "isConstructor" : false,
 984       "isPrivate" : false,
 985       "memberOf" : "Roo.util.Observable",
 986       "example" : "",
 987       "deprecated" : "",
 988       "since" : "",
 989       "see" : "",
 990       "params" : [
 991         {
 992           "name" : "eventName",
 993           "type" : "String",
 994           "desc" : "The type of event to listen for",
 995           "isOptional" : false
 996         },
 997         {
 998           "name" : "handler",
 999           "type" : "Function",
1000           "desc" : "The handler to remove",
1001           "isOptional" : false
1002         },
1003         {
1004           "name" : "scope",
1005           "type" : "Object",
1006           "desc" : "(optional) The scope (this object) for the handler",
1007           "isOptional" : false
1008         }
1009       ],
1010       "returns" : [
1011       ]
1012     },
1013     {
1014       "name" : "fireEvent",
1015       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
1016       "isStatic" : false,
1017       "isConstructor" : false,
1018       "isPrivate" : false,
1019       "memberOf" : "Roo.util.Observable",
1020       "example" : "",
1021       "deprecated" : "",
1022       "since" : "",
1023       "see" : "",
1024       "params" : [
1025         {
1026           "name" : "eventName",
1027           "type" : "String",
1028           "desc" : "",
1029           "isOptional" : false
1030         },
1031         {
1032           "name" : "args",
1033           "type" : "Object...",
1034           "desc" : "Variable number of parameters are passed to handlers",
1035           "isOptional" : false
1036         }
1037       ],
1038       "returns" : [
1039         {
1040           "name" : "",
1041           "type" : "Boolean",
1042           "desc" : "returns false if any of the handlers return false otherwise it returns true"
1043         }
1044       ]
1045     },
1046     {
1047       "name" : "hasListener",
1048       "desc" : "Checks to see if this object has any listeners for a specified event",
1049       "isStatic" : false,
1050       "isConstructor" : false,
1051       "isPrivate" : false,
1052       "memberOf" : "Roo.util.Observable",
1053       "example" : "",
1054       "deprecated" : "",
1055       "since" : "",
1056       "see" : "",
1057       "params" : [
1058         {
1059           "name" : "eventName",
1060           "type" : "String",
1061           "desc" : "The name of the event to check for",
1062           "isOptional" : false
1063         }
1064       ],
1065       "returns" : [
1066         {
1067           "name" : "",
1068           "type" : "Boolean",
1069           "desc" : "True if the event is being listened for, else false"
1070         }
1071       ]
1072     },
1073     {
1074       "name" : "capture",
1075       "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
1076       "isStatic" : true,
1077       "isConstructor" : false,
1078       "isPrivate" : false,
1079       "memberOf" : "Roo.util.Observable",
1080       "example" : "",
1081       "deprecated" : "",
1082       "since" : "",
1083       "see" : "",
1084       "params" : [
1085         {
1086           "name" : "o",
1087           "type" : "Observable",
1088           "desc" : "The Observable to capture",
1089           "isOptional" : false
1090         },
1091         {
1092           "name" : "fn",
1093           "type" : "Function",
1094           "desc" : "The function to call",
1095           "isOptional" : false
1096         },
1097         {
1098           "name" : "scope",
1099           "type" : "Object",
1100           "desc" : "(optional) The scope (this object) for the fn",
1101           "isOptional" : false
1102         }
1103       ],
1104       "returns" : [
1105       ]
1106     },
1107     {
1108       "name" : "addListener",
1109       "desc" : "Appends an event handler to this component",
1110       "isStatic" : false,
1111       "isConstructor" : false,
1112       "isPrivate" : false,
1113       "memberOf" : "Roo.util.Observable",
1114       "example" : "",
1115       "deprecated" : "",
1116       "since" : "",
1117       "see" : "",
1118       "params" : [
1119         {
1120           "name" : "eventName",
1121           "type" : "String",
1122           "desc" : "The type of event to listen for",
1123           "isOptional" : false
1124         },
1125         {
1126           "name" : "handler",
1127           "type" : "Function",
1128           "desc" : "The method the event invokes",
1129           "isOptional" : false
1130         },
1131         {
1132           "name" : "scope",
1133           "type" : "Object",
1134           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1135           "isOptional" : false
1136         },
1137         {
1138           "name" : "options",
1139           "type" : "Object",
1140           "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n     \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t</code></pre>",
1141           "isOptional" : false
1142         }
1143       ],
1144       "returns" : [
1145       ]
1146     }
1147   ],
1148   "events" : [
1149     {
1150       "name" : "beforeloadadd",
1151       "desc" : "Fires after a new set of Records has been loaded.",
1152       "memberOf" : "Roo.data.Store",
1153       "example" : "",
1154       "deprecated" : "",
1155       "since" : "",
1156       "see" : "",
1157       "params" : [
1158         {
1159           "name" : "this",
1160           "type" : "Store",
1161           "desc" : "",
1162           "isOptional" : false
1163         },
1164         {
1165           "name" : "records",
1166           "type" : "Roo.data.Record[]",
1167           "desc" : "The Records that were loaded",
1168           "isOptional" : false
1169         },
1170         {
1171           "name" : "options",
1172           "type" : "Object",
1173           "desc" : "The loading options that were specified (see {@link #load} for details)",
1174           "isOptional" : false
1175         }
1176       ],
1177       "returns" : [
1178       ]
1179     },
1180     {
1181       "name" : "loadexception",
1182       "desc" : "Fires if an exception occurs in the Proxy during loading.\nCalled with the signature of the Proxy's \"loadexception\" event.\nIf you return Json { data: [] , success: false, .... } then this will be thrown with the following args",
1183       "memberOf" : "Roo.data.Store",
1184       "example" : "",
1185       "deprecated" : "",
1186       "since" : "",
1187       "see" : "",
1188       "params" : [
1189         {
1190           "name" : "",
1191           "type" : "Proxy",
1192           "desc" : "",
1193           "isOptional" : false
1194         },
1195         {
1196           "name" : "return",
1197           "type" : "Object",
1198           "desc" : "from JsonData.reader() - success, totalRecords, records",
1199           "isOptional" : false
1200         },
1201         {
1202           "name" : "load",
1203           "type" : "Object",
1204           "desc" : "options",
1205           "isOptional" : false
1206         },
1207         {
1208           "name" : "jsonData",
1209           "type" : "Object",
1210           "desc" : "from your request (normally this contains the Exception)",
1211           "isOptional" : false
1212         }
1213       ],
1214       "returns" : [
1215       ]
1216     },
1217     {
1218       "name" : "load",
1219       "desc" : "Fires after a new set of Records has been loaded, before they are added to the store.",
1220       "memberOf" : "Roo.data.Store",
1221       "example" : "",
1222       "deprecated" : "",
1223       "since" : "",
1224       "see" : "",
1225       "params" : [
1226         {
1227           "name" : "this",
1228           "type" : "Store",
1229           "desc" : "",
1230           "isOptional" : false
1231         },
1232         {
1233           "name" : "records",
1234           "type" : "Roo.data.Record[]",
1235           "desc" : "The Records that were loaded",
1236           "isOptional" : false
1237         },
1238         {
1239           "name" : "options",
1240           "type" : "Object",
1241           "desc" : "The loading options that were specified (see {@link #load} for details)",
1242           "isOptional" : false
1243         }
1244       ],
1245       "returns" : [
1246       ]
1247     },
1248     {
1249       "name" : "add",
1250       "desc" : "Fires when Records have been added to the Store",
1251       "memberOf" : "Roo.data.Store",
1252       "example" : "",
1253       "deprecated" : "",
1254       "since" : "",
1255       "see" : "",
1256       "params" : [
1257         {
1258           "name" : "this",
1259           "type" : "Store",
1260           "desc" : "",
1261           "isOptional" : false
1262         },
1263         {
1264           "name" : "records",
1265           "type" : "Roo.data.Record[]",
1266           "desc" : "The array of Records added",
1267           "isOptional" : false
1268         },
1269         {
1270           "name" : "index",
1271           "type" : "Number",
1272           "desc" : "The index at which the record(s) were added",
1273           "isOptional" : false
1274         }
1275       ],
1276       "returns" : [
1277       ]
1278     },
1279     {
1280       "name" : "metachange",
1281       "desc" : "Fires when this store's reader provides new metadata (fields). This is currently only support for JsonReaders.",
1282       "memberOf" : "Roo.data.Store",
1283       "example" : "",
1284       "deprecated" : "",
1285       "since" : "",
1286       "see" : "",
1287       "params" : [
1288         {
1289           "name" : "this",
1290           "type" : "Store",
1291           "desc" : "",
1292           "isOptional" : false
1293         },
1294         {
1295           "name" : "meta",
1296           "type" : "Object",
1297           "desc" : "The JSON metadata",
1298           "isOptional" : false
1299         }
1300       ],
1301       "returns" : [
1302       ]
1303     },
1304     {
1305       "name" : "clear",
1306       "desc" : "Fires when the data cache has been cleared.",
1307       "memberOf" : "Roo.data.Store",
1308       "example" : "",
1309       "deprecated" : "",
1310       "since" : "",
1311       "see" : "",
1312       "params" : [
1313         {
1314           "name" : "this",
1315           "type" : "Store",
1316           "desc" : "",
1317           "isOptional" : false
1318         }
1319       ],
1320       "returns" : [
1321       ]
1322     },
1323     {
1324       "name" : "remove",
1325       "desc" : "Fires when a Record has been removed from the Store",
1326       "memberOf" : "Roo.data.Store",
1327       "example" : "",
1328       "deprecated" : "",
1329       "since" : "",
1330       "see" : "",
1331       "params" : [
1332         {
1333           "name" : "this",
1334           "type" : "Store",
1335           "desc" : "",
1336           "isOptional" : false
1337         },
1338         {
1339           "name" : "record",
1340           "type" : "Roo.data.Record",
1341           "desc" : "The Record that was removed",
1342           "isOptional" : false
1343         },
1344         {
1345           "name" : "index",
1346           "type" : "Number",
1347           "desc" : "The index at which the record was removed",
1348           "isOptional" : false
1349         }
1350       ],
1351       "returns" : [
1352       ]
1353     },
1354     {
1355       "name" : "update",
1356       "desc" : "Fires when a Record has been updated",
1357       "memberOf" : "Roo.data.Store",
1358       "example" : "",
1359       "deprecated" : "",
1360       "since" : "",
1361       "see" : "",
1362       "params" : [
1363         {
1364           "name" : "this",
1365           "type" : "Store",
1366           "desc" : "",
1367           "isOptional" : false
1368         },
1369         {
1370           "name" : "record",
1371           "type" : "Roo.data.Record",
1372           "desc" : "The Record that was updated",
1373           "isOptional" : false
1374         },
1375         {
1376           "name" : "operation",
1377           "type" : "String",
1378           "desc" : "The update operation being performed.  Value may be one of:\n<pre><code>\n Roo.data.Record.EDIT\n Roo.data.Record.REJECT\n Roo.data.Record.COMMIT\n</code></pre>",
1379           "isOptional" : false
1380         }
1381       ],
1382       "returns" : [
1383       ]
1384     },
1385     {
1386       "name" : "beforeload",
1387       "desc" : "Fires before a request is made for a new data object.  If the beforeload handler returns false\nthe load action will be canceled.",
1388       "memberOf" : "Roo.data.Store",
1389       "example" : "",
1390       "deprecated" : "",
1391       "since" : "",
1392       "see" : "",
1393       "params" : [
1394         {
1395           "name" : "this",
1396           "type" : "Store",
1397           "desc" : "",
1398           "isOptional" : false
1399         },
1400         {
1401           "name" : "options",
1402           "type" : "Object",
1403           "desc" : "The loading options that were specified (see {@link #load} for details)",
1404           "isOptional" : false
1405         }
1406       ],
1407       "returns" : [
1408       ]
1409     },
1410     {
1411       "name" : "datachanged",
1412       "desc" : "Fires when the data cache has changed, and a widget which is using this Store\nas a Record cache should refresh its view.",
1413       "memberOf" : "Roo.data.Store",
1414       "example" : "",
1415       "deprecated" : "",
1416       "since" : "",
1417       "see" : "",
1418       "params" : [
1419         {
1420           "name" : "this",
1421           "type" : "Store",
1422           "desc" : "",
1423           "isOptional" : false
1424         }
1425       ],
1426       "returns" : [
1427       ]
1428     }
1429   ]
1430 }