git.roojs.org Git - roojs1/blob - docs/symbols/Roo.bootstrap.Element.json

   1 {
   2   "name" : "Roo.bootstrap.Element",
   3   "augments" : [
   4     "Roo.bootstrap.Component",
   5     "Roo.Component",
   6     "Roo.util.Observable"
   7   ],
   8   "desc" : "Bootstrap Element class",
   9   "isSingleton" : false,
  10   "isStatic" : false,
  11   "isBuiltin" : false,
  12   "memberOf" : "Element",
  13   "example" : "",
  14   "deprecated" : "",
  15   "since" : "",
  16   "see" : "",
  17   "params" : [
  18     {
  19       "name" : "config",
  20       "type" : "Object",
  21       "desc" : "The config object",
  22       "isOptional" : false
  23     }
  24   ],
  25   "returns" : [
  26   ],
  27   "config" : [
  28     {
  29       "name" : "listeners",
  30       "type" : "Object",
  31       "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>",
  32       "memberOf" : "Roo.util.Observable",
  33       "values" : [
  34       ]
  35     },
  36     {
  37       "name" : "tooltip",
  38       "type" : "string",
  39       "desc" : "Text for the tooltip",
  40       "memberOf" : "Roo.bootstrap.Component",
  41       "values" : [
  42       ]
  43     },
  44     {
  45       "name" : "container_method",
  46       "type" : "string",
  47       "desc" : "method to fetch parents container element (used by NavHeaderbar -  getHeaderChildContainer)",
  48       "memberOf" : "Roo.bootstrap.Component",
  49       "values" : [
  50       ]
  51     },
  52     {
  53       "name" : "visibilityEl",
  54       "type" : "string|object",
  55       "desc" : "What element to use for visibility (@see getVisibilityEl())",
  56       "memberOf" : "Roo.bootstrap.Component",
  57       "values" : [
  58         "(el",
  59         "parent)"
  60       ]
  61     },
  62     {
  63       "name" : "can_build_overlaid",
  64       "type" : "Boolean",
  65       "desc" : "True if element can be rebuild from a HTML page",
  66       "memberOf" : "Roo.bootstrap.Component",
  67       "values" : [
  68       ]
  69     },
  70     {
  71       "name" : "hideMode",
  72       "type" : "String",
  73       "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
  74       "memberOf" : "Roo.Component",
  75       "values" : [
  76         "(display",
  77         "visibility)"
  78       ]
  79     },
  80     {
  81       "name" : "tag",
  82       "type" : "String",
  83       "desc" : "tag of the element",
  84       "memberOf" : "Roo.bootstrap.Element",
  85       "values" : [
  86       ]
  87     },
  88     {
  89       "name" : "style",
  90       "type" : "String",
  91       "desc" : "any extra css",
  92       "memberOf" : "Roo.bootstrap.Component",
  93       "values" : [
  94       ]
  95     },
  96     {
  97       "name" : "allowDomMove",
  98       "type" : "Boolean",
  99       "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
 100       "memberOf" : "Roo.Component",
 101       "values" : [
 102       ]
 103     },
 104     {
 105       "name" : "cls",
 106       "type" : "String",
 107       "desc" : "class of the element",
 108       "memberOf" : "Roo.bootstrap.Element",
 109       "values" : [
 110       ]
 111     },
 112     {
 113       "name" : "html",
 114       "type" : "String",
 115       "desc" : "contents of the element",
 116       "memberOf" : "Roo.bootstrap.Element",
 117       "values" : [
 118       ]
 119     },
 120     {
 121       "name" : "preventDefault",
 122       "type" : "Boolean",
 123       "desc" : "default false",
 124       "memberOf" : "Roo.bootstrap.Element",
 125       "values" : [
 126         "(true",
 127         "false)"
 128       ]
 129     },
 130     {
 131       "name" : "clickable",
 132       "type" : "Boolean",
 133       "desc" : "default false",
 134       "memberOf" : "Roo.bootstrap.Element",
 135       "values" : [
 136         "(true",
 137         "false)"
 138       ]
 139     },
 140     {
 141       "name" : "xattr",
 142       "type" : "Object",
 143       "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
 144       "memberOf" : "Roo.bootstrap.Component",
 145       "values" : [
 146       ]
 147     },
 148     {
 149       "name" : "actionMode",
 150       "type" : "String",
 151       "desc" : "which property holds the element that used for  hide() / show() / disable() / enable()\ndefault is 'el'",
 152       "memberOf" : "Roo.Component",
 153       "values" : [
 154       ]
 155     },
 156     {
 157       "name" : "dataId",
 158       "type" : "string",
 159       "desc" : "cutomer id",
 160       "memberOf" : "Roo.bootstrap.Component",
 161       "values" : [
 162       ]
 163     },
 164     {
 165       "name" : "name",
 166       "type" : "string",
 167       "desc" : "Specifies name attribute",
 168       "memberOf" : "Roo.bootstrap.Component",
 169       "values" : [
 170       ]
 171     },
 172     {
 173       "name" : "disableClass",
 174       "type" : "String",
 175       "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
 176       "memberOf" : "Roo.Component",
 177       "values" : [
 178       ]
 179     }
 180   ],
 181   "methods" : [
 182     {
 183       "name" : "tooltipEl",
 184       "desc" : "Fetch the element to display the tooltip on.",
 185       "isStatic" : false,
 186       "isConstructor" : false,
 187       "isPrivate" : false,
 188       "memberOf" : "Roo.bootstrap.Component",
 189       "example" : "",
 190       "deprecated" : "",
 191       "since" : "",
 192       "see" : "",
 193       "params" : [
 194       ],
 195       "returns" : [
 196         {
 197           "name" : "",
 198           "type" : "Roo.Element",
 199           "desc" : "defaults to this.el"
 200         }
 201       ]
 202     },
 203     {
 204       "name" : "hide",
 205       "desc" : "Hide a component - adds 'hidden' class",
 206       "isStatic" : false,
 207       "isConstructor" : false,
 208       "isPrivate" : false,
 209       "memberOf" : "Roo.bootstrap.Component",
 210       "example" : "",
 211       "deprecated" : "",
 212       "since" : "",
 213       "see" : "",
 214       "params" : [
 215       ],
 216       "returns" : [
 217       ]
 218     },
 219     {
 220       "name" : "show",
 221       "desc" : "Show a component - removes 'hidden' class",
 222       "isStatic" : false,
 223       "isConstructor" : false,
 224       "isPrivate" : false,
 225       "memberOf" : "Roo.bootstrap.Component",
 226       "example" : "",
 227       "deprecated" : "",
 228       "since" : "",
 229       "see" : "",
 230       "params" : [
 231       ],
 232       "returns" : [
 233       ]
 234     },
 235     {
 236       "name" : "xAddChildren",
 237       "desc" : "xAddChildren - the 'sub-compentized' version of the above idea..",
 238       "isStatic" : false,
 239       "isConstructor" : false,
 240       "isPrivate" : false,
 241       "memberOf" : "Roo.bootstrap.Component",
 242       "example" : "",
 243       "deprecated" : "",
 244       "since" : "",
 245       "see" : "",
 246       "params" : [
 247       ],
 248       "returns" : [
 249       ]
 250     },
 251     {
 252       "name" : "setVisibilityEl",
 253       "desc" : "Set the element that will be used to show or hide",
 254       "isStatic" : false,
 255       "isConstructor" : false,
 256       "isPrivate" : false,
 257       "memberOf" : "Roo.bootstrap.Component",
 258       "example" : "",
 259       "deprecated" : "",
 260       "since" : "",
 261       "see" : "",
 262       "params" : [
 263       ],
 264       "returns" : [
 265       ]
 266     },
 267     {
 268       "name" : "getVisibilityEl",
 269       "desc" : "Get the element that will be used to show or hide",
 270       "isStatic" : false,
 271       "isConstructor" : false,
 272       "isPrivate" : false,
 273       "memberOf" : "Roo.bootstrap.Component",
 274       "example" : "",
 275       "deprecated" : "",
 276       "since" : "",
 277       "see" : "",
 278       "params" : [
 279       ],
 280       "returns" : [
 281       ]
 282     },
 283     {
 284       "name" : "addxtype",
 285       "desc" : "This is really a wrapper for addxtypeChild\nit handles stuff relating to flexy:foreach / flexy:if\n= some of our projects use a flat rendering of the output, and try and overlay it with dynamic data.\n -- this is a bit of a nightmare... and is even more confusing to debug..",
 286       "isStatic" : false,
 287       "isConstructor" : false,
 288       "isPrivate" : false,
 289       "memberOf" : "Roo.bootstrap.Component",
 290       "example" : "",
 291       "deprecated" : "",
 292       "since" : "",
 293       "see" : "",
 294       "params" : [
 295       ],
 296       "returns" : [
 297       ]
 298     },
 299     {
 300       "name" : "xAdd",
 301       "desc" : "add a child to this element\n  - turn the child.cfg into a child_instance\n  - call child_instance.render( this { getContainerMethod()} )\n  - loop through the children, and call addxtype.. (reall this) on newly created child.",
 302       "isStatic" : false,
 303       "isConstructor" : false,
 304       "isPrivate" : false,
 305       "memberOf" : "Roo.bootstrap.Component",
 306       "example" : "",
 307       "deprecated" : "",
 308       "since" : "",
 309       "see" : "",
 310       "params" : [
 311       ],
 312       "returns" : [
 313       ]
 314     },
 315     {
 316       "name" : "addxtypeChild",
 317       "desc" : "add a child to this element\n  - turn the child.cfg into a child_instance\n  - call child_instance.render( this { getContainerMethod()} )\n  - loop through the children, and call addxtype.. (reall this) on newly created child.",
 318       "isStatic" : false,
 319       "isConstructor" : false,
 320       "isPrivate" : false,
 321       "memberOf" : "Roo.bootstrap.Component",
 322       "example" : "",
 323       "deprecated" : "",
 324       "since" : "",
 325       "see" : "",
 326       "params" : [
 327       ],
 328       "returns" : [
 329       ]
 330     },
 331     {
 332       "name" : "initEvents",
 333       "desc" : "Initialize Events for the element",
 334       "isStatic" : false,
 335       "isConstructor" : false,
 336       "isPrivate" : false,
 337       "memberOf" : "Roo.bootstrap.Component",
 338       "example" : "",
 339       "deprecated" : "",
 340       "since" : "",
 341       "see" : "",
 342       "params" : [
 343       ],
 344       "returns" : [
 345       ]
 346     },
 347     {
 348       "name" : "getChildContainer",
 349       "desc" : "Fetch the element to add children to",
 350       "isStatic" : false,
 351       "isConstructor" : false,
 352       "isPrivate" : false,
 353       "memberOf" : "Roo.bootstrap.Component",
 354       "example" : "",
 355       "deprecated" : "",
 356       "since" : "",
 357       "see" : "",
 358       "params" : [
 359       ],
 360       "returns" : [
 361         {
 362           "name" : "",
 363           "type" : "Roo.Element",
 364           "desc" : "defaults to this.el"
 365         }
 366       ]
 367     },
 368     {
 369       "name" : "addxtypeChildren",
 370       "desc" : "add a number of children to this object,\n    which in turn calls render...",
 371       "isStatic" : false,
 372       "isConstructor" : false,
 373       "isPrivate" : false,
 374       "memberOf" : "Roo.bootstrap.Component",
 375       "example" : "",
 376       "deprecated" : "",
 377       "since" : "",
 378       "see" : "",
 379       "params" : [
 380       ],
 381       "returns" : [
 382       ]
 383     },
 384     {
 385       "name" : "getId",
 386       "desc" : "Returns the id of this component.",
 387       "isStatic" : false,
 388       "isConstructor" : false,
 389       "isPrivate" : false,
 390       "memberOf" : "Roo.Component",
 391       "example" : "",
 392       "deprecated" : "",
 393       "since" : "",
 394       "see" : "",
 395       "params" : [
 396       ],
 397       "returns" : [
 398         {
 399           "name" : "",
 400           "type" : "String",
 401           "desc" : ""
 402         }
 403       ]
 404     },
 405     {
 406       "name" : "render",
 407       "desc" : "If this is a lazy rendering component, render it to its container element.",
 408       "isStatic" : false,
 409       "isConstructor" : false,
 410       "isPrivate" : false,
 411       "memberOf" : "Roo.Component",
 412       "example" : "",
 413       "deprecated" : "",
 414       "since" : "",
 415       "see" : "",
 416       "params" : [
 417         {
 418           "name" : "container",
 419           "type" : "String/HTMLElement/Element",
 420           "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
 421           "isOptional" : false
 422         }
 423       ],
 424       "returns" : [
 425       ]
 426     },
 427     {
 428       "name" : "destroy",
 429       "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
 430       "isStatic" : false,
 431       "isConstructor" : false,
 432       "isPrivate" : false,
 433       "memberOf" : "Roo.Component",
 434       "example" : "",
 435       "deprecated" : "",
 436       "since" : "",
 437       "see" : "",
 438       "params" : [
 439       ],
 440       "returns" : [
 441       ]
 442     },
 443     {
 444       "name" : "isVisible",
 445       "desc" : "Returns true if this component is visible.",
 446       "isStatic" : false,
 447       "isConstructor" : false,
 448       "isPrivate" : false,
 449       "memberOf" : "Roo.Component",
 450       "example" : "",
 451       "deprecated" : "",
 452       "since" : "",
 453       "see" : "",
 454       "params" : [
 455       ],
 456       "returns" : [
 457       ]
 458     },
 459     {
 460       "name" : "setDisabled",
 461       "desc" : "Convenience function for setting disabled/enabled by boolean.",
 462       "isStatic" : false,
 463       "isConstructor" : false,
 464       "isPrivate" : false,
 465       "memberOf" : "Roo.Component",
 466       "example" : "",
 467       "deprecated" : "",
 468       "since" : "",
 469       "see" : "",
 470       "params" : [
 471         {
 472           "name" : "disabled",
 473           "type" : "Boolean",
 474           "desc" : "",
 475           "isOptional" : false
 476         }
 477       ],
 478       "returns" : [
 479       ]
 480     },
 481     {
 482       "name" : "focus",
 483       "desc" : "Try to focus this component.",
 484       "isStatic" : false,
 485       "isConstructor" : false,
 486       "isPrivate" : false,
 487       "memberOf" : "Roo.Component",
 488       "example" : "",
 489       "deprecated" : "",
 490       "since" : "",
 491       "see" : "",
 492       "params" : [
 493         {
 494           "name" : "selectText",
 495           "type" : "Boolean",
 496           "desc" : "True to also select the text in this component (if applicable)",
 497           "isOptional" : false
 498         }
 499       ],
 500       "returns" : [
 501         {
 502           "name" : "",
 503           "type" : "Roo.Component",
 504           "desc" : "this"
 505         }
 506       ]
 507     },
 508     {
 509       "name" : "enable",
 510       "desc" : "Enable this component.",
 511       "isStatic" : false,
 512       "isConstructor" : false,
 513       "isPrivate" : false,
 514       "memberOf" : "Roo.Component",
 515       "example" : "",
 516       "deprecated" : "",
 517       "since" : "",
 518       "see" : "",
 519       "params" : [
 520       ],
 521       "returns" : [
 522         {
 523           "name" : "",
 524           "type" : "Roo.Component",
 525           "desc" : "this"
 526         }
 527       ]
 528     },
 529     {
 530       "name" : "setVisible",
 531       "desc" : "Convenience function to hide or show this component by boolean.",
 532       "isStatic" : false,
 533       "isConstructor" : false,
 534       "isPrivate" : false,
 535       "memberOf" : "Roo.Component",
 536       "example" : "",
 537       "deprecated" : "",
 538       "since" : "",
 539       "see" : "",
 540       "params" : [
 541         {
 542           "name" : "visible",
 543           "type" : "Boolean",
 544           "desc" : "True to show, false to hide",
 545           "isOptional" : false
 546         }
 547       ],
 548       "returns" : [
 549         {
 550           "name" : "",
 551           "type" : "Roo.Component",
 552           "desc" : "this"
 553         }
 554       ]
 555     },
 556     {
 557       "name" : "disable",
 558       "desc" : "Disable this component.",
 559       "isStatic" : false,
 560       "isConstructor" : false,
 561       "isPrivate" : false,
 562       "memberOf" : "Roo.Component",
 563       "example" : "",
 564       "deprecated" : "",
 565       "since" : "",
 566       "see" : "",
 567       "params" : [
 568       ],
 569       "returns" : [
 570         {
 571           "name" : "",
 572           "type" : "Roo.Component",
 573           "desc" : "this"
 574         }
 575       ]
 576     },
 577     {
 578       "name" : "getEl",
 579       "desc" : "Returns the underlying {@link Roo.Element}.",
 580       "isStatic" : false,
 581       "isConstructor" : false,
 582       "isPrivate" : false,
 583       "memberOf" : "Roo.Component",
 584       "example" : "",
 585       "deprecated" : "",
 586       "since" : "",
 587       "see" : "",
 588       "params" : [
 589       ],
 590       "returns" : [
 591         {
 592           "name" : "",
 593           "type" : "Roo.Element",
 594           "desc" : "The element"
 595         }
 596       ]
 597     },
 598     {
 599       "name" : "purgeListeners",
 600       "desc" : "Removes all listeners for this object",
 601       "isStatic" : false,
 602       "isConstructor" : false,
 603       "isPrivate" : false,
 604       "memberOf" : "Roo.util.Observable",
 605       "example" : "",
 606       "deprecated" : "",
 607       "since" : "",
 608       "see" : "",
 609       "params" : [
 610       ],
 611       "returns" : [
 612       ]
 613     },
 614     {
 615       "name" : "on",
 616       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 617       "isStatic" : false,
 618       "isConstructor" : false,
 619       "isPrivate" : false,
 620       "memberOf" : "Roo.util.Observable",
 621       "example" : "",
 622       "deprecated" : "",
 623       "since" : "",
 624       "see" : "",
 625       "params" : [
 626         {
 627           "name" : "eventName",
 628           "type" : "String",
 629           "desc" : "The type of event to listen for",
 630           "isOptional" : false
 631         },
 632         {
 633           "name" : "handler",
 634           "type" : "Function",
 635           "desc" : "The method the event invokes",
 636           "isOptional" : false
 637         },
 638         {
 639           "name" : "scope",
 640           "type" : "Object",
 641           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 642           "isOptional" : false
 643         },
 644         {
 645           "name" : "options",
 646           "type" : "Object",
 647           "desc" : "(optional)",
 648           "isOptional" : false
 649         }
 650       ],
 651       "returns" : [
 652       ]
 653     },
 654     {
 655       "name" : "un",
 656       "desc" : "Removes a listener (shorthand for removeListener)",
 657       "isStatic" : false,
 658       "isConstructor" : false,
 659       "isPrivate" : false,
 660       "memberOf" : "Roo.util.Observable",
 661       "example" : "",
 662       "deprecated" : "",
 663       "since" : "",
 664       "see" : "",
 665       "params" : [
 666         {
 667           "name" : "eventName",
 668           "type" : "String",
 669           "desc" : "The type of event to listen for",
 670           "isOptional" : false
 671         },
 672         {
 673           "name" : "handler",
 674           "type" : "Function",
 675           "desc" : "The handler to remove",
 676           "isOptional" : false
 677         },
 678         {
 679           "name" : "scope",
 680           "type" : "Object",
 681           "desc" : "(optional) The scope (this object) for the handler",
 682           "isOptional" : false
 683         }
 684       ],
 685       "returns" : [
 686       ]
 687     },
 688     {
 689       "name" : "addEvents",
 690       "desc" : "Used to define events on this Observable",
 691       "isStatic" : false,
 692       "isConstructor" : false,
 693       "isPrivate" : false,
 694       "memberOf" : "Roo.util.Observable",
 695       "example" : "",
 696       "deprecated" : "",
 697       "since" : "",
 698       "see" : "",
 699       "params" : [
 700         {
 701           "name" : "object",
 702           "type" : "Object",
 703           "desc" : "The object with the events defined",
 704           "isOptional" : false
 705         }
 706       ],
 707       "returns" : [
 708       ]
 709     },
 710     {
 711       "name" : "releaseCapture",
 712       "desc" : "Removes <b>all</b> added captures from the Observable.",
 713       "isStatic" : true,
 714       "isConstructor" : false,
 715       "isPrivate" : false,
 716       "memberOf" : "Roo.util.Observable",
 717       "example" : "",
 718       "deprecated" : "",
 719       "since" : "",
 720       "see" : "",
 721       "params" : [
 722         {
 723           "name" : "o",
 724           "type" : "Observable",
 725           "desc" : "The Observable to release",
 726           "isOptional" : false
 727         }
 728       ],
 729       "returns" : [
 730       ]
 731     },
 732     {
 733       "name" : "removeListener",
 734       "desc" : "Removes a listener",
 735       "isStatic" : false,
 736       "isConstructor" : false,
 737       "isPrivate" : false,
 738       "memberOf" : "Roo.util.Observable",
 739       "example" : "",
 740       "deprecated" : "",
 741       "since" : "",
 742       "see" : "",
 743       "params" : [
 744         {
 745           "name" : "eventName",
 746           "type" : "String",
 747           "desc" : "The type of event to listen for",
 748           "isOptional" : false
 749         },
 750         {
 751           "name" : "handler",
 752           "type" : "Function",
 753           "desc" : "The handler to remove",
 754           "isOptional" : false
 755         },
 756         {
 757           "name" : "scope",
 758           "type" : "Object",
 759           "desc" : "(optional) The scope (this object) for the handler",
 760           "isOptional" : false
 761         }
 762       ],
 763       "returns" : [
 764       ]
 765     },
 766     {
 767       "name" : "fireEvent",
 768       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 769       "isStatic" : false,
 770       "isConstructor" : false,
 771       "isPrivate" : false,
 772       "memberOf" : "Roo.util.Observable",
 773       "example" : "",
 774       "deprecated" : "",
 775       "since" : "",
 776       "see" : "",
 777       "params" : [
 778         {
 779           "name" : "eventName",
 780           "type" : "String",
 781           "desc" : "",
 782           "isOptional" : false
 783         },
 784         {
 785           "name" : "args",
 786           "type" : "Object...",
 787           "desc" : "Variable number of parameters are passed to handlers",
 788           "isOptional" : false
 789         }
 790       ],
 791       "returns" : [
 792         {
 793           "name" : "",
 794           "type" : "Boolean",
 795           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 796         }
 797       ]
 798     },
 799     {
 800       "name" : "hasListener",
 801       "desc" : "Checks to see if this object has any listeners for a specified event",
 802       "isStatic" : false,
 803       "isConstructor" : false,
 804       "isPrivate" : false,
 805       "memberOf" : "Roo.util.Observable",
 806       "example" : "",
 807       "deprecated" : "",
 808       "since" : "",
 809       "see" : "",
 810       "params" : [
 811         {
 812           "name" : "eventName",
 813           "type" : "String",
 814           "desc" : "The name of the event to check for",
 815           "isOptional" : false
 816         }
 817       ],
 818       "returns" : [
 819         {
 820           "name" : "",
 821           "type" : "Boolean",
 822           "desc" : "True if the event is being listened for, else false"
 823         }
 824       ]
 825     },
 826     {
 827       "name" : "capture",
 828       "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.",
 829       "isStatic" : true,
 830       "isConstructor" : false,
 831       "isPrivate" : false,
 832       "memberOf" : "Roo.util.Observable",
 833       "example" : "",
 834       "deprecated" : "",
 835       "since" : "",
 836       "see" : "",
 837       "params" : [
 838         {
 839           "name" : "o",
 840           "type" : "Observable",
 841           "desc" : "The Observable to capture",
 842           "isOptional" : false
 843         },
 844         {
 845           "name" : "fn",
 846           "type" : "Function",
 847           "desc" : "The function to call",
 848           "isOptional" : false
 849         },
 850         {
 851           "name" : "scope",
 852           "type" : "Object",
 853           "desc" : "(optional) The scope (this object) for the fn",
 854           "isOptional" : false
 855         }
 856       ],
 857       "returns" : [
 858       ]
 859     },
 860     {
 861       "name" : "addListener",
 862       "desc" : "Appends an event handler to this component",
 863       "isStatic" : false,
 864       "isConstructor" : false,
 865       "isPrivate" : false,
 866       "memberOf" : "Roo.util.Observable",
 867       "example" : "",
 868       "deprecated" : "",
 869       "since" : "",
 870       "see" : "",
 871       "params" : [
 872         {
 873           "name" : "eventName",
 874           "type" : "String",
 875           "desc" : "The type of event to listen for",
 876           "isOptional" : false
 877         },
 878         {
 879           "name" : "handler",
 880           "type" : "Function",
 881           "desc" : "The method the event invokes",
 882           "isOptional" : false
 883         },
 884         {
 885           "name" : "scope",
 886           "type" : "Object",
 887           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 888           "isOptional" : false
 889         },
 890         {
 891           "name" : "options",
 892           "type" : "Object",
 893           "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>",
 894           "isOptional" : false
 895         }
 896       ],
 897       "returns" : [
 898       ]
 899     }
 900   ],
 901   "events" : [
 902     {
 903       "name" : "click",
 904       "desc" : "When a element is chick",
 905       "memberOf" : "Roo.bootstrap.Element",
 906       "example" : "",
 907       "deprecated" : "",
 908       "since" : "",
 909       "see" : "",
 910       "params" : [
 911         {
 912           "name" : "this",
 913           "type" : "Roo.bootstrap.Element",
 914           "desc" : "",
 915           "isOptional" : false
 916         },
 917         {
 918           "name" : "e",
 919           "type" : "Roo.EventObject",
 920           "desc" : "",
 921           "isOptional" : false
 922         }
 923       ],
 924       "returns" : [
 925       ]
 926     },
 927     {
 928       "name" : "childrenrendered",
 929       "desc" : "Fires when the children have been rendered..",
 930       "memberOf" : "Roo.bootstrap.Component",
 931       "example" : "",
 932       "deprecated" : "",
 933       "since" : "",
 934       "see" : "",
 935       "params" : [
 936         {
 937           "name" : "this",
 938           "type" : "Roo.bootstrap.Component",
 939           "desc" : "",
 940           "isOptional" : false
 941         }
 942       ],
 943       "returns" : [
 944       ]
 945     },
 946     {
 947       "name" : "beforerender",
 948       "desc" : "Fires before the component is rendered. Return false to stop the render.",
 949       "memberOf" : "Roo.Component",
 950       "example" : "",
 951       "deprecated" : "",
 952       "since" : "",
 953       "see" : "",
 954       "params" : [
 955         {
 956           "name" : "this",
 957           "type" : "Roo.Component",
 958           "desc" : "",
 959           "isOptional" : false
 960         }
 961       ],
 962       "returns" : [
 963       ]
 964     },
 965     {
 966       "name" : "disable",
 967       "desc" : "Fires after the component is disabled.",
 968       "memberOf" : "Roo.Component",
 969       "example" : "",
 970       "deprecated" : "",
 971       "since" : "",
 972       "see" : "",
 973       "params" : [
 974         {
 975           "name" : "this",
 976           "type" : "Roo.Component",
 977           "desc" : "",
 978           "isOptional" : false
 979         }
 980       ],
 981       "returns" : [
 982       ]
 983     },
 984     {
 985       "name" : "render",
 986       "desc" : "Fires after the component is rendered.",
 987       "memberOf" : "Roo.Component",
 988       "example" : "",
 989       "deprecated" : "",
 990       "since" : "",
 991       "see" : "",
 992       "params" : [
 993         {
 994           "name" : "this",
 995           "type" : "Roo.Component",
 996           "desc" : "",
 997           "isOptional" : false
 998         }
 999       ],
1000       "returns" : [
1001       ]
1002     },
1003     {
1004       "name" : "destroy",
1005       "desc" : "Fires after the component is destroyed.",
1006       "memberOf" : "Roo.Component",
1007       "example" : "",
1008       "deprecated" : "",
1009       "since" : "",
1010       "see" : "",
1011       "params" : [
1012         {
1013           "name" : "this",
1014           "type" : "Roo.Component",
1015           "desc" : "",
1016           "isOptional" : false
1017         }
1018       ],
1019       "returns" : [
1020       ]
1021     },
1022     {
1023       "name" : "hide",
1024       "desc" : "Fires after the component is hidden.",
1025       "memberOf" : "Roo.Component",
1026       "example" : "",
1027       "deprecated" : "",
1028       "since" : "",
1029       "see" : "",
1030       "params" : [
1031         {
1032           "name" : "this",
1033           "type" : "Roo.Component",
1034           "desc" : "",
1035           "isOptional" : false
1036         }
1037       ],
1038       "returns" : [
1039       ]
1040     },
1041     {
1042       "name" : "beforehide",
1043       "desc" : "Fires before the component is hidden. Return false to stop the hide.",
1044       "memberOf" : "Roo.Component",
1045       "example" : "",
1046       "deprecated" : "",
1047       "since" : "",
1048       "see" : "",
1049       "params" : [
1050         {
1051           "name" : "this",
1052           "type" : "Roo.Component",
1053           "desc" : "",
1054           "isOptional" : false
1055         }
1056       ],
1057       "returns" : [
1058       ]
1059     },
1060     {
1061       "name" : "show",
1062       "desc" : "Fires after the component is shown.",
1063       "memberOf" : "Roo.Component",
1064       "example" : "",
1065       "deprecated" : "",
1066       "since" : "",
1067       "see" : "",
1068       "params" : [
1069         {
1070           "name" : "this",
1071           "type" : "Roo.Component",
1072           "desc" : "",
1073           "isOptional" : false
1074         }
1075       ],
1076       "returns" : [
1077       ]
1078     },
1079     {
1080       "name" : "beforeshow",
1081       "desc" : "Fires before the component is shown.  Return false to stop the show.",
1082       "memberOf" : "Roo.Component",
1083       "example" : "",
1084       "deprecated" : "",
1085       "since" : "",
1086       "see" : "",
1087       "params" : [
1088         {
1089           "name" : "this",
1090           "type" : "Roo.Component",
1091           "desc" : "",
1092           "isOptional" : false
1093         }
1094       ],
1095       "returns" : [
1096       ]
1097     },
1098     {
1099       "name" : "enable",
1100       "desc" : "Fires after the component is enabled.",
1101       "memberOf" : "Roo.Component",
1102       "example" : "",
1103       "deprecated" : "",
1104       "since" : "",
1105       "see" : "",
1106       "params" : [
1107         {
1108           "name" : "this",
1109           "type" : "Roo.Component",
1110           "desc" : "",
1111           "isOptional" : false
1112         }
1113       ],
1114       "returns" : [
1115       ]
1116     },
1117     {
1118       "name" : "beforedestroy",
1119       "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
1120       "memberOf" : "Roo.Component",
1121       "example" : "",
1122       "deprecated" : "",
1123       "since" : "",
1124       "see" : "",
1125       "params" : [
1126         {
1127           "name" : "this",
1128           "type" : "Roo.Component",
1129           "desc" : "",
1130           "isOptional" : false
1131         }
1132       ],
1133       "returns" : [
1134       ]
1135     }
1136   ]
1137 }