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

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