git.roojs.org Git - roojs1/blob - docs/symbols/Roo.util.MixedCollection.json

   1 {
   2   "name" : "Roo.util.MixedCollection",
   3   "augments" : [
   4     "Roo.util.Observable"
   5   ],
   6   "desc" : "A Collection class that maintains both numeric indexes and keys and exposes events.",
   7   "isSingleton" : false,
   8   "isStatic" : false,
   9   "isBuiltin" : false,
  10   "memberOf" : "MixedCollection",
  11   "example" : "",
  12   "deprecated" : "",
  13   "since" : "",
  14   "see" : "",
  15   "params" : [
  16     {
  17       "name" : "allowFunctions",
  18       "type" : "Boolean",
  19       "desc" : "True if the addAll function should add function references to the\ncollection (defaults to false)",
  20       "isOptional" : false
  21     },
  22     {
  23       "name" : "keyFn",
  24       "type" : "Function",
  25       "desc" : "A function that can accept an item of the type(s) stored in this MixedCollection\nand return the key value for that item.  This is used when available to look up the key on items that\nwere passed without an explicit key parameter to a MixedCollection method.  Passing this parameter is\nequivalent to providing an implementation for the {@link #getKey} method.",
  26       "isOptional" : false
  27     }
  28   ],
  29   "returns" : [],
  30   "config" : [
  31     {
  32       "name" : "listeners",
  33       "type" : "Object",
  34       "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>",
  35       "memberOf" : "Roo.util.Observable",
  36       "optvals" : []
  37     }
  38   ],
  39   "methods" : [
  40     {
  41       "name" : "remove",
  42       "desc" : "Removed an item from the collection.",
  43       "isStatic" : false,
  44       "isConstructor" : false,
  45       "isPrivate" : false,
  46       "memberOf" : "Roo.util.MixedCollection",
  47       "example" : "",
  48       "deprecated" : "",
  49       "since" : "",
  50       "see" : "",
  51       "params" : [
  52         {
  53           "name" : "o",
  54           "type" : "Object",
  55           "desc" : "The item to remove.",
  56           "isOptional" : false
  57         }
  58       ],
  59       "returns" : [
  60         {
  61           "name" : "",
  62           "type" : "Object",
  63           "desc" : "The item removed."
  64         }
  65       ]
  66     },
  67     {
  68       "name" : "get",
  69       "desc" : "Returns the item associated with the passed key or index.",
  70       "isStatic" : false,
  71       "isConstructor" : false,
  72       "isPrivate" : false,
  73       "memberOf" : "Roo.util.MixedCollection",
  74       "example" : "",
  75       "deprecated" : "",
  76       "since" : "",
  77       "see" : "",
  78       "params" : [
  79         {
  80           "name" : "key",
  81           "type" : "String/Number",
  82           "desc" : "The key or index of the item.",
  83           "isOptional" : false
  84         }
  85       ],
  86       "returns" : [
  87         {
  88           "name" : "",
  89           "type" : "Object",
  90           "desc" : "The item associated with the passed key."
  91         }
  92       ]
  93     },
  94     {
  95       "name" : "itemAt",
  96       "desc" : "Returns the item at the specified index.",
  97       "isStatic" : false,
  98       "isConstructor" : false,
  99       "isPrivate" : false,
 100       "memberOf" : "Roo.util.MixedCollection",
 101       "example" : "",
 102       "deprecated" : "",
 103       "since" : "",
 104       "see" : "",
 105       "params" : [
 106         {
 107           "name" : "index",
 108           "type" : "Number",
 109           "desc" : "The index of the item.",
 110           "isOptional" : false
 111         }
 112       ],
 113       "returns" : [
 114         {
 115           "name" : "",
 116           "type" : "Object",
 117           "desc" : ""
 118         }
 119       ]
 120     },
 121     {
 122       "name" : "each",
 123       "desc" : "Executes the specified function once for every item in the collection, passing each\nitem as the first and only parameter. returning false from the function will stop the iteration.",
 124       "isStatic" : false,
 125       "isConstructor" : false,
 126       "isPrivate" : false,
 127       "memberOf" : "Roo.util.MixedCollection",
 128       "example" : "",
 129       "deprecated" : "",
 130       "since" : "",
 131       "see" : "",
 132       "params" : [
 133         {
 134           "name" : "fn",
 135           "type" : "Function",
 136           "desc" : "The function to execute for each item.",
 137           "isOptional" : false
 138         },
 139         {
 140           "name" : "scope",
 141           "type" : "Object",
 142           "desc" : "(optional) The scope in which to execute the function.",
 143           "isOptional" : false
 144         }
 145       ],
 146       "returns" : []
 147     },
 148     {
 149       "name" : "insert",
 150       "desc" : "Inserts an item at the specified index in the collection.",
 151       "isStatic" : false,
 152       "isConstructor" : false,
 153       "isPrivate" : false,
 154       "memberOf" : "Roo.util.MixedCollection",
 155       "example" : "",
 156       "deprecated" : "",
 157       "since" : "",
 158       "see" : "",
 159       "params" : [
 160         {
 161           "name" : "index",
 162           "type" : "Number",
 163           "desc" : "The index to insert the item at.",
 164           "isOptional" : false
 165         },
 166         {
 167           "name" : "key",
 168           "type" : "String",
 169           "desc" : "The key to associate with the new item, or the item itself.",
 170           "isOptional" : false
 171         },
 172         {
 173           "name" : "o",
 174           "type" : "Object",
 175           "desc" : "(optional) If the second parameter was a key, the new item.",
 176           "isOptional" : false
 177         }
 178       ],
 179       "returns" : [
 180         {
 181           "name" : "",
 182           "type" : "Object",
 183           "desc" : "The item inserted."
 184         }
 185       ]
 186     },
 187     {
 188       "name" : "getCount",
 189       "desc" : "Returns the number of items in the collection.",
 190       "isStatic" : false,
 191       "isConstructor" : false,
 192       "isPrivate" : false,
 193       "memberOf" : "Roo.util.MixedCollection",
 194       "example" : "",
 195       "deprecated" : "",
 196       "since" : "",
 197       "see" : "",
 198       "params" : [],
 199       "returns" : [
 200         {
 201           "name" : "",
 202           "type" : "Number",
 203           "desc" : "the number of items in the collection."
 204         }
 205       ]
 206     },
 207     {
 208       "name" : "clear",
 209       "desc" : "Removes all items from the collection.",
 210       "isStatic" : false,
 211       "isConstructor" : false,
 212       "isPrivate" : false,
 213       "memberOf" : "Roo.util.MixedCollection",
 214       "example" : "",
 215       "deprecated" : "",
 216       "since" : "",
 217       "see" : "",
 218       "params" : [],
 219       "returns" : []
 220     },
 221     {
 222       "name" : "keySort",
 223       "desc" : "Sorts this collection by keys",
 224       "isStatic" : false,
 225       "isConstructor" : false,
 226       "isPrivate" : false,
 227       "memberOf" : "Roo.util.MixedCollection",
 228       "example" : "",
 229       "deprecated" : "",
 230       "since" : "",
 231       "see" : "",
 232       "params" : [
 233         {
 234           "name" : "direction",
 235           "type" : "String",
 236           "desc" : "(optional) \"ASC\" or \"DESC\"",
 237           "isOptional" : false
 238         },
 239         {
 240           "name" : "fn",
 241           "type" : "Function",
 242           "desc" : "(optional) a comparison function (defaults to case insensitive string)",
 243           "isOptional" : false
 244         }
 245       ],
 246       "returns" : []
 247     },
 248     {
 249       "name" : "indexOf",
 250       "desc" : "Returns index within the collection of the passed Object.",
 251       "isStatic" : false,
 252       "isConstructor" : false,
 253       "isPrivate" : false,
 254       "memberOf" : "Roo.util.MixedCollection",
 255       "example" : "",
 256       "deprecated" : "",
 257       "since" : "",
 258       "see" : "",
 259       "params" : [
 260         {
 261           "name" : "o",
 262           "type" : "Object",
 263           "desc" : "The item to find the index of.",
 264           "isOptional" : false
 265         }
 266       ],
 267       "returns" : [
 268         {
 269           "name" : "",
 270           "type" : "Number",
 271           "desc" : "index of the item."
 272         }
 273       ]
 274     },
 275     {
 276       "name" : "clone",
 277       "desc" : "Creates a duplicate of this collection",
 278       "isStatic" : false,
 279       "isConstructor" : false,
 280       "isPrivate" : false,
 281       "memberOf" : "Roo.util.MixedCollection",
 282       "example" : "",
 283       "deprecated" : "",
 284       "since" : "",
 285       "see" : "",
 286       "params" : [],
 287       "returns" : [
 288         {
 289           "name" : "",
 290           "type" : "MixedCollection",
 291           "desc" : ""
 292         }
 293       ]
 294     },
 295     {
 296       "name" : "containsKey",
 297       "desc" : "Returns true if the collection contains the passed Object as a key.",
 298       "isStatic" : false,
 299       "isConstructor" : false,
 300       "isPrivate" : false,
 301       "memberOf" : "Roo.util.MixedCollection",
 302       "example" : "",
 303       "deprecated" : "",
 304       "since" : "",
 305       "see" : "",
 306       "params" : [
 307         {
 308           "name" : "key",
 309           "type" : "String",
 310           "desc" : "The key to look for in the collection.",
 311           "isOptional" : false
 312         }
 313       ],
 314       "returns" : [
 315         {
 316           "name" : "",
 317           "type" : "Boolean",
 318           "desc" : "True if the collection contains the Object as a key."
 319         }
 320       ]
 321     },
 322     {
 323       "name" : "getKey",
 324       "desc" : "MixedCollection has a generic way to fetch keys if you implement getKey.\n<pre><code>\n// normal way\nvar mc = new Roo.util.MixedCollection();\nmc.add(someEl.dom.id, someEl);\nmc.add(otherEl.dom.id, otherEl);\n//and so on\n\n// using getKey\nvar mc = new Roo.util.MixedCollection();\nmc.getKey = function(el){\n   return el.dom.id;\n};\nmc.add(someEl);\nmc.add(otherEl);\n\n// or via the constructor\nvar mc = new Roo.util.MixedCollection(false, function(el){\n   return el.dom.id;\n});\nmc.add(someEl);\nmc.add(otherEl);\n</code></pre>",
 325       "isStatic" : false,
 326       "isConstructor" : false,
 327       "isPrivate" : false,
 328       "memberOf" : "Roo.util.MixedCollection",
 329       "example" : "",
 330       "deprecated" : "",
 331       "since" : "",
 332       "see" : "",
 333       "params" : [
 334         {
 335           "name" : "o",
 336           "type" : "",
 337           "desc" : "{Object} The item for which to find the key.",
 338           "isOptional" : false
 339         }
 340       ],
 341       "returns" : [
 342         {
 343           "name" : "",
 344           "type" : "Object",
 345           "desc" : "The key for the passed item."
 346         }
 347       ]
 348     },
 349     {
 350       "name" : "find",
 351       "desc" : "Returns the first item in the collection which elicits a true return value from the\npassed selection function.",
 352       "isStatic" : false,
 353       "isConstructor" : false,
 354       "isPrivate" : false,
 355       "memberOf" : "Roo.util.MixedCollection",
 356       "example" : "",
 357       "deprecated" : "",
 358       "since" : "",
 359       "see" : "",
 360       "params" : [
 361         {
 362           "name" : "fn",
 363           "type" : "Function",
 364           "desc" : "The selection function to execute for each item.",
 365           "isOptional" : false
 366         },
 367         {
 368           "name" : "scope",
 369           "type" : "Object",
 370           "desc" : "(optional) The scope in which to execute the function.",
 371           "isOptional" : false
 372         }
 373       ],
 374       "returns" : [
 375         {
 376           "name" : "",
 377           "type" : "Object",
 378           "desc" : "The first item in the collection which returned true from the selection function."
 379         }
 380       ]
 381     },
 382     {
 383       "name" : "getRange",
 384       "desc" : "Returns a range of items in this collection",
 385       "isStatic" : false,
 386       "isConstructor" : false,
 387       "isPrivate" : false,
 388       "memberOf" : "Roo.util.MixedCollection",
 389       "example" : "",
 390       "deprecated" : "",
 391       "since" : "",
 392       "see" : "",
 393       "params" : [
 394         {
 395           "name" : "startIndex",
 396           "type" : "Number",
 397           "desc" : "(optional) defaults to 0",
 398           "isOptional" : false
 399         },
 400         {
 401           "name" : "endIndex",
 402           "type" : "Number",
 403           "desc" : "(optional) default to the last item",
 404           "isOptional" : false
 405         }
 406       ],
 407       "returns" : [
 408         {
 409           "name" : "",
 410           "type" : "Array",
 411           "desc" : "An array of items"
 412         }
 413       ]
 414     },
 415     {
 416       "name" : "eachKey",
 417       "desc" : "Executes the specified function once for every key in the collection, passing each\nkey, and its associated item as the first two parameters.",
 418       "isStatic" : false,
 419       "isConstructor" : false,
 420       "isPrivate" : false,
 421       "memberOf" : "Roo.util.MixedCollection",
 422       "example" : "",
 423       "deprecated" : "",
 424       "since" : "",
 425       "see" : "",
 426       "params" : [
 427         {
 428           "name" : "fn",
 429           "type" : "Function",
 430           "desc" : "The function to execute for each item.",
 431           "isOptional" : false
 432         },
 433         {
 434           "name" : "scope",
 435           "type" : "Object",
 436           "desc" : "(optional) The scope in which to execute the function.",
 437           "isOptional" : false
 438         }
 439       ],
 440       "returns" : []
 441     },
 442     {
 443       "name" : "indexOfKey",
 444       "desc" : "Returns index within the collection of the passed key.",
 445       "isStatic" : false,
 446       "isConstructor" : false,
 447       "isPrivate" : false,
 448       "memberOf" : "Roo.util.MixedCollection",
 449       "example" : "",
 450       "deprecated" : "",
 451       "since" : "",
 452       "see" : "",
 453       "params" : [
 454         {
 455           "name" : "key",
 456           "type" : "String",
 457           "desc" : "The key to find the index of.",
 458           "isOptional" : false
 459         }
 460       ],
 461       "returns" : [
 462         {
 463           "name" : "",
 464           "type" : "Number",
 465           "desc" : "index of the key."
 466         }
 467       ]
 468     },
 469     {
 470       "name" : "contains",
 471       "desc" : "Returns true if the collection contains the passed Object as an item.",
 472       "isStatic" : false,
 473       "isConstructor" : false,
 474       "isPrivate" : false,
 475       "memberOf" : "Roo.util.MixedCollection",
 476       "example" : "",
 477       "deprecated" : "",
 478       "since" : "",
 479       "see" : "",
 480       "params" : [
 481         {
 482           "name" : "o",
 483           "type" : "Object",
 484           "desc" : "The Object to look for in the collection.",
 485           "isOptional" : false
 486         }
 487       ],
 488       "returns" : [
 489         {
 490           "name" : "",
 491           "type" : "Boolean",
 492           "desc" : "True if the collection contains the Object as an item."
 493         }
 494       ]
 495     },
 496     {
 497       "name" : "addAll",
 498       "desc" : "Adds all elements of an Array or an Object to the collection.",
 499       "isStatic" : false,
 500       "isConstructor" : false,
 501       "isPrivate" : false,
 502       "memberOf" : "Roo.util.MixedCollection",
 503       "example" : "",
 504       "deprecated" : "",
 505       "since" : "",
 506       "see" : "",
 507       "params" : [
 508         {
 509           "name" : "objs",
 510           "type" : "Object/Array",
 511           "desc" : "An Object containing properties which will be added to the collection, or\nan Array of values, each of which are added to the collection.",
 512           "isOptional" : false
 513         }
 514       ],
 515       "returns" : []
 516     },
 517     {
 518       "name" : "key",
 519       "desc" : "Returns the item associated with the passed key.",
 520       "isStatic" : false,
 521       "isConstructor" : false,
 522       "isPrivate" : false,
 523       "memberOf" : "Roo.util.MixedCollection",
 524       "example" : "",
 525       "deprecated" : "",
 526       "since" : "",
 527       "see" : "",
 528       "params" : [
 529         {
 530           "name" : "key",
 531           "type" : "String/Number",
 532           "desc" : "The key of the item.",
 533           "isOptional" : false
 534         }
 535       ],
 536       "returns" : [
 537         {
 538           "name" : "",
 539           "type" : "Object",
 540           "desc" : "The item associated with the passed key."
 541         }
 542       ]
 543     },
 544     {
 545       "name" : "item",
 546       "desc" : "Returns the item associated with the passed key OR index. Key has priority over index.",
 547       "isStatic" : false,
 548       "isConstructor" : false,
 549       "isPrivate" : false,
 550       "memberOf" : "Roo.util.MixedCollection",
 551       "example" : "",
 552       "deprecated" : "",
 553       "since" : "",
 554       "see" : "",
 555       "params" : [
 556         {
 557           "name" : "key",
 558           "type" : "String/Number",
 559           "desc" : "The key or index of the item.",
 560           "isOptional" : false
 561         }
 562       ],
 563       "returns" : [
 564         {
 565           "name" : "",
 566           "type" : "Object",
 567           "desc" : "The item associated with the passed key."
 568         }
 569       ]
 570     },
 571     {
 572       "name" : "filterBy",
 573       "desc" : "Filter by a function. * Returns a new collection that has been filtered.\nThe passed function will be called with each \nobject in the collection. If the function returns true, the value is included \notherwise it is filtered.",
 574       "isStatic" : false,
 575       "isConstructor" : false,
 576       "isPrivate" : false,
 577       "memberOf" : "Roo.util.MixedCollection",
 578       "example" : "",
 579       "deprecated" : "",
 580       "since" : "",
 581       "see" : "",
 582       "params" : [
 583         {
 584           "name" : "fn",
 585           "type" : "Function",
 586           "desc" : "The function to be called, it will receive the args o (the object), k (the key)",
 587           "isOptional" : false
 588         },
 589         {
 590           "name" : "scope",
 591           "type" : "Object",
 592           "desc" : "(optional) The scope of the function (defaults to this)",
 593           "isOptional" : false
 594         }
 595       ],
 596       "returns" : [
 597         {
 598           "name" : "",
 599           "type" : "MixedCollection",
 600           "desc" : "The new filtered collection"
 601         }
 602       ]
 603     },
 604     {
 605       "name" : "add",
 606       "desc" : "Adds an item to the collection.",
 607       "isStatic" : false,
 608       "isConstructor" : false,
 609       "isPrivate" : false,
 610       "memberOf" : "Roo.util.MixedCollection",
 611       "example" : "",
 612       "deprecated" : "",
 613       "since" : "",
 614       "see" : "",
 615       "params" : [
 616         {
 617           "name" : "key",
 618           "type" : "String",
 619           "desc" : "The key to associate with the item",
 620           "isOptional" : false
 621         },
 622         {
 623           "name" : "o",
 624           "type" : "Object",
 625           "desc" : "The item to add.",
 626           "isOptional" : false
 627         }
 628       ],
 629       "returns" : [
 630         {
 631           "name" : "",
 632           "type" : "Object",
 633           "desc" : "The item added."
 634         }
 635       ]
 636     },
 637     {
 638       "name" : "removeAt",
 639       "desc" : "Remove an item from a specified index in the collection.",
 640       "isStatic" : false,
 641       "isConstructor" : false,
 642       "isPrivate" : false,
 643       "memberOf" : "Roo.util.MixedCollection",
 644       "example" : "",
 645       "deprecated" : "",
 646       "since" : "",
 647       "see" : "",
 648       "params" : [
 649         {
 650           "name" : "index",
 651           "type" : "Number",
 652           "desc" : "The index within the collection of the item to remove.",
 653           "isOptional" : false
 654         }
 655       ],
 656       "returns" : []
 657     },
 658     {
 659       "name" : "removeKey",
 660       "desc" : "Removed an item associated with the passed key fom the collection.",
 661       "isStatic" : false,
 662       "isConstructor" : false,
 663       "isPrivate" : false,
 664       "memberOf" : "Roo.util.MixedCollection",
 665       "example" : "",
 666       "deprecated" : "",
 667       "since" : "",
 668       "see" : "",
 669       "params" : [
 670         {
 671           "name" : "key",
 672           "type" : "String",
 673           "desc" : "The key of the item to remove.",
 674           "isOptional" : false
 675         }
 676       ],
 677       "returns" : []
 678     },
 679     {
 680       "name" : "filter",
 681       "desc" : "Filter the <i>objects</i> in this collection by a specific property. \nReturns a new collection that has been filtered.",
 682       "isStatic" : false,
 683       "isConstructor" : false,
 684       "isPrivate" : false,
 685       "memberOf" : "Roo.util.MixedCollection",
 686       "example" : "",
 687       "deprecated" : "",
 688       "since" : "",
 689       "see" : "",
 690       "params" : [
 691         {
 692           "name" : "property",
 693           "type" : "String",
 694           "desc" : "A property on your objects",
 695           "isOptional" : false
 696         },
 697         {
 698           "name" : "value",
 699           "type" : "String/RegExp",
 700           "desc" : "Either string that the property values \nshould start with or a RegExp to test against the property",
 701           "isOptional" : false
 702         }
 703       ],
 704       "returns" : [
 705         {
 706           "name" : "",
 707           "type" : "MixedCollection",
 708           "desc" : "The new filtered collection"
 709         }
 710       ]
 711     },
 712     {
 713       "name" : "last",
 714       "desc" : "Returns the last item in the collection.",
 715       "isStatic" : false,
 716       "isConstructor" : false,
 717       "isPrivate" : false,
 718       "memberOf" : "Roo.util.MixedCollection",
 719       "example" : "",
 720       "deprecated" : "",
 721       "since" : "",
 722       "see" : "",
 723       "params" : [],
 724       "returns" : [
 725         {
 726           "name" : "",
 727           "type" : "Object",
 728           "desc" : "the last item in the collection.."
 729         }
 730       ]
 731     },
 732     {
 733       "name" : "replace",
 734       "desc" : "Replaces an item in the collection.",
 735       "isStatic" : false,
 736       "isConstructor" : false,
 737       "isPrivate" : false,
 738       "memberOf" : "Roo.util.MixedCollection",
 739       "example" : "",
 740       "deprecated" : "",
 741       "since" : "",
 742       "see" : "",
 743       "params" : [
 744         {
 745           "name" : "key",
 746           "type" : "String",
 747           "desc" : "The key associated with the item to replace, or the item to replace.",
 748           "isOptional" : false
 749         },
 750         {
 751           "name" : "o",
 752           "type" : "",
 753           "desc" : "{Object} o (optional) If the first parameter passed was a key, the item to associate with that key.",
 754           "isOptional" : false
 755         }
 756       ],
 757       "returns" : [
 758         {
 759           "name" : "",
 760           "type" : "Object",
 761           "desc" : "The new item."
 762         }
 763       ]
 764     },
 765     {
 766       "name" : "first",
 767       "desc" : "Returns the first item in the collection.",
 768       "isStatic" : false,
 769       "isConstructor" : false,
 770       "isPrivate" : false,
 771       "memberOf" : "Roo.util.MixedCollection",
 772       "example" : "",
 773       "deprecated" : "",
 774       "since" : "",
 775       "see" : "",
 776       "params" : [],
 777       "returns" : [
 778         {
 779           "name" : "",
 780           "type" : "Object",
 781           "desc" : "the first item in the collection.."
 782         }
 783       ]
 784     },
 785     {
 786       "name" : "sort",
 787       "desc" : "Sorts this collection with the passed comparison function",
 788       "isStatic" : false,
 789       "isConstructor" : false,
 790       "isPrivate" : false,
 791       "memberOf" : "Roo.util.MixedCollection",
 792       "example" : "",
 793       "deprecated" : "",
 794       "since" : "",
 795       "see" : "",
 796       "params" : [
 797         {
 798           "name" : "direction",
 799           "type" : "String",
 800           "desc" : "(optional) \"ASC\" or \"DESC\"",
 801           "isOptional" : false
 802         },
 803         {
 804           "name" : "fn",
 805           "type" : "Function",
 806           "desc" : "(optional) comparison function",
 807           "isOptional" : false
 808         }
 809       ],
 810       "returns" : []
 811     },
 812     {
 813       "name" : "purgeListeners",
 814       "desc" : "Removes all listeners for this object",
 815       "isStatic" : false,
 816       "isConstructor" : false,
 817       "isPrivate" : false,
 818       "memberOf" : "Roo.util.Observable",
 819       "example" : "",
 820       "deprecated" : "",
 821       "since" : "",
 822       "see" : "",
 823       "params" : [],
 824       "returns" : []
 825     },
 826     {
 827       "name" : "on",
 828       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 829       "isStatic" : false,
 830       "isConstructor" : false,
 831       "isPrivate" : false,
 832       "memberOf" : "Roo.util.Observable",
 833       "example" : "",
 834       "deprecated" : "",
 835       "since" : "",
 836       "see" : "",
 837       "params" : [
 838         {
 839           "name" : "eventName",
 840           "type" : "String",
 841           "desc" : "The type of event to listen for",
 842           "isOptional" : false
 843         },
 844         {
 845           "name" : "handler",
 846           "type" : "Function",
 847           "desc" : "The method the event invokes",
 848           "isOptional" : false
 849         },
 850         {
 851           "name" : "scope",
 852           "type" : "Object",
 853           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 854           "isOptional" : false
 855         },
 856         {
 857           "name" : "options",
 858           "type" : "Object",
 859           "desc" : "(optional)",
 860           "isOptional" : false
 861         }
 862       ],
 863       "returns" : []
 864     },
 865     {
 866       "name" : "un",
 867       "desc" : "Removes a listener (shorthand for removeListener)",
 868       "isStatic" : false,
 869       "isConstructor" : false,
 870       "isPrivate" : false,
 871       "memberOf" : "Roo.util.Observable",
 872       "example" : "",
 873       "deprecated" : "",
 874       "since" : "",
 875       "see" : "",
 876       "params" : [
 877         {
 878           "name" : "eventName",
 879           "type" : "String",
 880           "desc" : "The type of event to listen for",
 881           "isOptional" : false
 882         },
 883         {
 884           "name" : "handler",
 885           "type" : "Function",
 886           "desc" : "The handler to remove",
 887           "isOptional" : false
 888         },
 889         {
 890           "name" : "scope",
 891           "type" : "Object",
 892           "desc" : "(optional) The scope (this object) for the handler",
 893           "isOptional" : false
 894         }
 895       ],
 896       "returns" : []
 897     },
 898     {
 899       "name" : "addEvents",
 900       "desc" : "Used to define events on this Observable",
 901       "isStatic" : false,
 902       "isConstructor" : false,
 903       "isPrivate" : false,
 904       "memberOf" : "Roo.util.Observable",
 905       "example" : "",
 906       "deprecated" : "",
 907       "since" : "",
 908       "see" : "",
 909       "params" : [
 910         {
 911           "name" : "object",
 912           "type" : "Object",
 913           "desc" : "The object with the events defined",
 914           "isOptional" : false
 915         }
 916       ],
 917       "returns" : []
 918     },
 919     {
 920       "name" : "releaseCapture",
 921       "desc" : "Removes <b>all</b> added captures from the Observable.",
 922       "isStatic" : true,
 923       "isConstructor" : false,
 924       "isPrivate" : false,
 925       "memberOf" : "Roo.util.Observable",
 926       "example" : "",
 927       "deprecated" : "",
 928       "since" : "",
 929       "see" : "",
 930       "params" : [
 931         {
 932           "name" : "o",
 933           "type" : "Observable",
 934           "desc" : "The Observable to release",
 935           "isOptional" : false
 936         }
 937       ],
 938       "returns" : []
 939     },
 940     {
 941       "name" : "removeListener",
 942       "desc" : "Removes a listener",
 943       "isStatic" : false,
 944       "isConstructor" : false,
 945       "isPrivate" : false,
 946       "memberOf" : "Roo.util.Observable",
 947       "example" : "",
 948       "deprecated" : "",
 949       "since" : "",
 950       "see" : "",
 951       "params" : [
 952         {
 953           "name" : "eventName",
 954           "type" : "String",
 955           "desc" : "The type of event to listen for",
 956           "isOptional" : false
 957         },
 958         {
 959           "name" : "handler",
 960           "type" : "Function",
 961           "desc" : "The handler to remove",
 962           "isOptional" : false
 963         },
 964         {
 965           "name" : "scope",
 966           "type" : "Object",
 967           "desc" : "(optional) The scope (this object) for the handler",
 968           "isOptional" : false
 969         }
 970       ],
 971       "returns" : []
 972     },
 973     {
 974       "name" : "fireEvent",
 975       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 976       "isStatic" : false,
 977       "isConstructor" : false,
 978       "isPrivate" : false,
 979       "memberOf" : "Roo.util.Observable",
 980       "example" : "",
 981       "deprecated" : "",
 982       "since" : "",
 983       "see" : "",
 984       "params" : [
 985         {
 986           "name" : "eventName",
 987           "type" : "String",
 988           "desc" : "",
 989           "isOptional" : false
 990         },
 991         {
 992           "name" : "args",
 993           "type" : "Object...",
 994           "desc" : "Variable number of parameters are passed to handlers",
 995           "isOptional" : false
 996         }
 997       ],
 998       "returns" : [
 999         {
1000           "name" : "",
1001           "type" : "Boolean",
1002           "desc" : "returns false if any of the handlers return false otherwise it returns true"
1003         }
1004       ]
1005     },
1006     {
1007       "name" : "hasListener",
1008       "desc" : "Checks to see if this object has any listeners for a specified event",
1009       "isStatic" : false,
1010       "isConstructor" : false,
1011       "isPrivate" : false,
1012       "memberOf" : "Roo.util.Observable",
1013       "example" : "",
1014       "deprecated" : "",
1015       "since" : "",
1016       "see" : "",
1017       "params" : [
1018         {
1019           "name" : "eventName",
1020           "type" : "String",
1021           "desc" : "The name of the event to check for",
1022           "isOptional" : false
1023         }
1024       ],
1025       "returns" : [
1026         {
1027           "name" : "",
1028           "type" : "Boolean",
1029           "desc" : "True if the event is being listened for, else false"
1030         }
1031       ]
1032     },
1033     {
1034       "name" : "capture",
1035       "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.",
1036       "isStatic" : true,
1037       "isConstructor" : false,
1038       "isPrivate" : false,
1039       "memberOf" : "Roo.util.Observable",
1040       "example" : "",
1041       "deprecated" : "",
1042       "since" : "",
1043       "see" : "",
1044       "params" : [
1045         {
1046           "name" : "o",
1047           "type" : "Observable",
1048           "desc" : "The Observable to capture",
1049           "isOptional" : false
1050         },
1051         {
1052           "name" : "fn",
1053           "type" : "Function",
1054           "desc" : "The function to call",
1055           "isOptional" : false
1056         },
1057         {
1058           "name" : "scope",
1059           "type" : "Object",
1060           "desc" : "(optional) The scope (this object) for the fn",
1061           "isOptional" : false
1062         }
1063       ],
1064       "returns" : []
1065     },
1066     {
1067       "name" : "addListener",
1068       "desc" : "Appends an event handler to this component",
1069       "isStatic" : false,
1070       "isConstructor" : false,
1071       "isPrivate" : false,
1072       "memberOf" : "Roo.util.Observable",
1073       "example" : "",
1074       "deprecated" : "",
1075       "since" : "",
1076       "see" : "",
1077       "params" : [
1078         {
1079           "name" : "eventName",
1080           "type" : "String",
1081           "desc" : "The type of event to listen for",
1082           "isOptional" : false
1083         },
1084         {
1085           "name" : "handler",
1086           "type" : "Function",
1087           "desc" : "The method the event invokes",
1088           "isOptional" : false
1089         },
1090         {
1091           "name" : "scope",
1092           "type" : "Object",
1093           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1094           "isOptional" : false
1095         },
1096         {
1097           "name" : "options",
1098           "type" : "Object",
1099           "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>",
1100           "isOptional" : false
1101         }
1102       ],
1103       "returns" : []
1104     }
1105   ],
1106   "events" : [
1107     {
1108       "name" : "remove",
1109       "desc" : "Fires when an item is removed from the collection.",
1110       "memberOf" : "Roo.util.MixedCollection",
1111       "example" : "",
1112       "deprecated" : "",
1113       "since" : "",
1114       "see" : "",
1115       "params" : [
1116         {
1117           "name" : "o",
1118           "type" : "Object",
1119           "desc" : "The item being removed.",
1120           "isOptional" : false
1121         },
1122         {
1123           "name" : "key",
1124           "type" : "String",
1125           "desc" : "(optional) The key associated with the removed item.",
1126           "isOptional" : false
1127         }
1128       ],
1129       "returns" : []
1130     },
1131     {
1132       "name" : "add",
1133       "desc" : "Fires when an item is added to the collection.",
1134       "memberOf" : "Roo.util.MixedCollection",
1135       "example" : "",
1136       "deprecated" : "",
1137       "since" : "",
1138       "see" : "",
1139       "params" : [
1140         {
1141           "name" : "index",
1142           "type" : "Number",
1143           "desc" : "The index at which the item was added.",
1144           "isOptional" : false
1145         },
1146         {
1147           "name" : "o",
1148           "type" : "Object",
1149           "desc" : "The item added.",
1150           "isOptional" : false
1151         },
1152         {
1153           "name" : "key",
1154           "type" : "String",
1155           "desc" : "The key associated with the added item.",
1156           "isOptional" : false
1157         }
1158       ],
1159       "returns" : []
1160     },
1161     {
1162       "name" : "replace",
1163       "desc" : "Fires when an item is replaced in the collection.",
1164       "memberOf" : "Roo.util.MixedCollection",
1165       "example" : "",
1166       "deprecated" : "",
1167       "since" : "",
1168       "see" : "",
1169       "params" : [
1170         {
1171           "name" : "key",
1172           "type" : "String",
1173           "desc" : "he key associated with the new added.",
1174           "isOptional" : false
1175         },
1176         {
1177           "name" : "old",
1178           "type" : "Object",
1179           "desc" : "The item being replaced.",
1180           "isOptional" : false
1181         },
1182         {
1183           "name" : "new",
1184           "type" : "Object",
1185           "desc" : "The new item.",
1186           "isOptional" : false
1187         }
1188       ],
1189       "returns" : []
1190     },
1191     {
1192       "name" : "clear",
1193       "desc" : "Fires when the collection is cleared.",
1194       "memberOf" : "Roo.util.MixedCollection",
1195       "example" : "",
1196       "deprecated" : "",
1197       "since" : "",
1198       "see" : "",
1199       "params" : [],
1200       "returns" : []
1201     }
1202   ]
1203 }