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" : "setVisibilityEl",
 237       "desc" : "Set the element that will be used to show or hide",
 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" : "getVisibilityEl",
 253       "desc" : "Get 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" : "addxtype",
 269       "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..",
 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" : "addxtypeChild",
 285       "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.",
 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" : "initEvents",
 301       "desc" : "Initialize Events for the element",
 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" : "getChildContainer",
 317       "desc" : "Fetch the element to add children to",
 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           "name" : "",
 331           "type" : "Roo.Element",
 332           "desc" : "defaults to this.el"
 333         }
 334       ]
 335     },
 336     {
 337       "name" : "addxtypeChildren",
 338       "desc" : "add a number of children to this object,\n    which in turn calls render...",
 339       "isStatic" : false,
 340       "isConstructor" : false,
 341       "isPrivate" : false,
 342       "memberOf" : "Roo.bootstrap.Component",
 343       "example" : "",
 344       "deprecated" : "",
 345       "since" : "",
 346       "see" : "",
 347       "params" : [
 348       ],
 349       "returns" : [
 350       ]
 351     },
 352     {
 353       "name" : "getId",
 354       "desc" : "Returns the id of this component.",
 355       "isStatic" : false,
 356       "isConstructor" : false,
 357       "isPrivate" : false,
 358       "memberOf" : "Roo.Component",
 359       "example" : "",
 360       "deprecated" : "",
 361       "since" : "",
 362       "see" : "",
 363       "params" : [
 364       ],
 365       "returns" : [
 366         {
 367           "name" : "",
 368           "type" : "String",
 369           "desc" : ""
 370         }
 371       ]
 372     },
 373     {
 374       "name" : "render",
 375       "desc" : "If this is a lazy rendering component, render it to its container element.",
 376       "isStatic" : false,
 377       "isConstructor" : false,
 378       "isPrivate" : false,
 379       "memberOf" : "Roo.Component",
 380       "example" : "",
 381       "deprecated" : "",
 382       "since" : "",
 383       "see" : "",
 384       "params" : [
 385         {
 386           "name" : "container",
 387           "type" : "String/HTMLElement/Element",
 388           "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
 389           "isOptional" : false
 390         }
 391       ],
 392       "returns" : [
 393       ]
 394     },
 395     {
 396       "name" : "destroy",
 397       "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}.",
 398       "isStatic" : false,
 399       "isConstructor" : false,
 400       "isPrivate" : false,
 401       "memberOf" : "Roo.Component",
 402       "example" : "",
 403       "deprecated" : "",
 404       "since" : "",
 405       "see" : "",
 406       "params" : [
 407       ],
 408       "returns" : [
 409       ]
 410     },
 411     {
 412       "name" : "isVisible",
 413       "desc" : "Returns true if this component is visible.",
 414       "isStatic" : false,
 415       "isConstructor" : false,
 416       "isPrivate" : false,
 417       "memberOf" : "Roo.Component",
 418       "example" : "",
 419       "deprecated" : "",
 420       "since" : "",
 421       "see" : "",
 422       "params" : [
 423       ],
 424       "returns" : [
 425       ]
 426     },
 427     {
 428       "name" : "setDisabled",
 429       "desc" : "Convenience function for setting disabled/enabled by boolean.",
 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           "name" : "disabled",
 441           "type" : "Boolean",
 442           "desc" : "",
 443           "isOptional" : false
 444         }
 445       ],
 446       "returns" : [
 447       ]
 448     },
 449     {
 450       "name" : "focus",
 451       "desc" : "Try to focus this component.",
 452       "isStatic" : false,
 453       "isConstructor" : false,
 454       "isPrivate" : false,
 455       "memberOf" : "Roo.Component",
 456       "example" : "",
 457       "deprecated" : "",
 458       "since" : "",
 459       "see" : "",
 460       "params" : [
 461         {
 462           "name" : "selectText",
 463           "type" : "Boolean",
 464           "desc" : "True to also select the text in this component (if applicable)",
 465           "isOptional" : false
 466         }
 467       ],
 468       "returns" : [
 469         {
 470           "name" : "",
 471           "type" : "Roo.Component",
 472           "desc" : "this"
 473         }
 474       ]
 475     },
 476     {
 477       "name" : "enable",
 478       "desc" : "Enable this component.",
 479       "isStatic" : false,
 480       "isConstructor" : false,
 481       "isPrivate" : false,
 482       "memberOf" : "Roo.Component",
 483       "example" : "",
 484       "deprecated" : "",
 485       "since" : "",
 486       "see" : "",
 487       "params" : [
 488       ],
 489       "returns" : [
 490         {
 491           "name" : "",
 492           "type" : "Roo.Component",
 493           "desc" : "this"
 494         }
 495       ]
 496     },
 497     {
 498       "name" : "setVisible",
 499       "desc" : "Convenience function to hide or show this component by boolean.",
 500       "isStatic" : false,
 501       "isConstructor" : false,
 502       "isPrivate" : false,
 503       "memberOf" : "Roo.Component",
 504       "example" : "",
 505       "deprecated" : "",
 506       "since" : "",
 507       "see" : "",
 508       "params" : [
 509         {
 510           "name" : "visible",
 511           "type" : "Boolean",
 512           "desc" : "True to show, false to hide",
 513           "isOptional" : false
 514         }
 515       ],
 516       "returns" : [
 517         {
 518           "name" : "",
 519           "type" : "Roo.Component",
 520           "desc" : "this"
 521         }
 522       ]
 523     },
 524     {
 525       "name" : "disable",
 526       "desc" : "Disable this component.",
 527       "isStatic" : false,
 528       "isConstructor" : false,
 529       "isPrivate" : false,
 530       "memberOf" : "Roo.Component",
 531       "example" : "",
 532       "deprecated" : "",
 533       "since" : "",
 534       "see" : "",
 535       "params" : [
 536       ],
 537       "returns" : [
 538         {
 539           "name" : "",
 540           "type" : "Roo.Component",
 541           "desc" : "this"
 542         }
 543       ]
 544     },
 545     {
 546       "name" : "getEl",
 547       "desc" : "Returns the underlying {@link Roo.Element}.",
 548       "isStatic" : false,
 549       "isConstructor" : false,
 550       "isPrivate" : false,
 551       "memberOf" : "Roo.Component",
 552       "example" : "",
 553       "deprecated" : "",
 554       "since" : "",
 555       "see" : "",
 556       "params" : [
 557       ],
 558       "returns" : [
 559         {
 560           "name" : "",
 561           "type" : "Roo.Element",
 562           "desc" : "The element"
 563         }
 564       ]
 565     },
 566     {
 567       "name" : "purgeListeners",
 568       "desc" : "Removes all listeners for this object",
 569       "isStatic" : false,
 570       "isConstructor" : false,
 571       "isPrivate" : false,
 572       "memberOf" : "Roo.util.Observable",
 573       "example" : "",
 574       "deprecated" : "",
 575       "since" : "",
 576       "see" : "",
 577       "params" : [
 578       ],
 579       "returns" : [
 580       ]
 581     },
 582     {
 583       "name" : "on",
 584       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 585       "isStatic" : false,
 586       "isConstructor" : false,
 587       "isPrivate" : false,
 588       "memberOf" : "Roo.util.Observable",
 589       "example" : "",
 590       "deprecated" : "",
 591       "since" : "",
 592       "see" : "",
 593       "params" : [
 594         {
 595           "name" : "eventName",
 596           "type" : "String",
 597           "desc" : "The type of event to listen for",
 598           "isOptional" : false
 599         },
 600         {
 601           "name" : "handler",
 602           "type" : "Function",
 603           "desc" : "The method the event invokes",
 604           "isOptional" : false
 605         },
 606         {
 607           "name" : "scope",
 608           "type" : "Object",
 609           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 610           "isOptional" : false
 611         },
 612         {
 613           "name" : "options",
 614           "type" : "Object",
 615           "desc" : "(optional)",
 616           "isOptional" : false
 617         }
 618       ],
 619       "returns" : [
 620       ]
 621     },
 622     {
 623       "name" : "un",
 624       "desc" : "Removes a listener (shorthand for removeListener)",
 625       "isStatic" : false,
 626       "isConstructor" : false,
 627       "isPrivate" : false,
 628       "memberOf" : "Roo.util.Observable",
 629       "example" : "",
 630       "deprecated" : "",
 631       "since" : "",
 632       "see" : "",
 633       "params" : [
 634         {
 635           "name" : "eventName",
 636           "type" : "String",
 637           "desc" : "The type of event to listen for",
 638           "isOptional" : false
 639         },
 640         {
 641           "name" : "handler",
 642           "type" : "Function",
 643           "desc" : "The handler to remove",
 644           "isOptional" : false
 645         },
 646         {
 647           "name" : "scope",
 648           "type" : "Object",
 649           "desc" : "(optional) The scope (this object) for the handler",
 650           "isOptional" : false
 651         }
 652       ],
 653       "returns" : [
 654       ]
 655     },
 656     {
 657       "name" : "addEvents",
 658       "desc" : "Used to define events on this Observable",
 659       "isStatic" : false,
 660       "isConstructor" : false,
 661       "isPrivate" : false,
 662       "memberOf" : "Roo.util.Observable",
 663       "example" : "",
 664       "deprecated" : "",
 665       "since" : "",
 666       "see" : "",
 667       "params" : [
 668         {
 669           "name" : "object",
 670           "type" : "Object",
 671           "desc" : "The object with the events defined",
 672           "isOptional" : false
 673         }
 674       ],
 675       "returns" : [
 676       ]
 677     },
 678     {
 679       "name" : "releaseCapture",
 680       "desc" : "Removes <b>all</b> added captures from the Observable.",
 681       "isStatic" : true,
 682       "isConstructor" : false,
 683       "isPrivate" : false,
 684       "memberOf" : "Roo.util.Observable",
 685       "example" : "",
 686       "deprecated" : "",
 687       "since" : "",
 688       "see" : "",
 689       "params" : [
 690         {
 691           "name" : "o",
 692           "type" : "Observable",
 693           "desc" : "The Observable to release",
 694           "isOptional" : false
 695         }
 696       ],
 697       "returns" : [
 698       ]
 699     },
 700     {
 701       "name" : "removeListener",
 702       "desc" : "Removes a listener",
 703       "isStatic" : false,
 704       "isConstructor" : false,
 705       "isPrivate" : false,
 706       "memberOf" : "Roo.util.Observable",
 707       "example" : "",
 708       "deprecated" : "",
 709       "since" : "",
 710       "see" : "",
 711       "params" : [
 712         {
 713           "name" : "eventName",
 714           "type" : "String",
 715           "desc" : "The type of event to listen for",
 716           "isOptional" : false
 717         },
 718         {
 719           "name" : "handler",
 720           "type" : "Function",
 721           "desc" : "The handler to remove",
 722           "isOptional" : false
 723         },
 724         {
 725           "name" : "scope",
 726           "type" : "Object",
 727           "desc" : "(optional) The scope (this object) for the handler",
 728           "isOptional" : false
 729         }
 730       ],
 731       "returns" : [
 732       ]
 733     },
 734     {
 735       "name" : "fireEvent",
 736       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 737       "isStatic" : false,
 738       "isConstructor" : false,
 739       "isPrivate" : false,
 740       "memberOf" : "Roo.util.Observable",
 741       "example" : "",
 742       "deprecated" : "",
 743       "since" : "",
 744       "see" : "",
 745       "params" : [
 746         {
 747           "name" : "eventName",
 748           "type" : "String",
 749           "desc" : "",
 750           "isOptional" : false
 751         },
 752         {
 753           "name" : "args",
 754           "type" : "Object...",
 755           "desc" : "Variable number of parameters are passed to handlers",
 756           "isOptional" : false
 757         }
 758       ],
 759       "returns" : [
 760         {
 761           "name" : "",
 762           "type" : "Boolean",
 763           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 764         }
 765       ]
 766     },
 767     {
 768       "name" : "hasListener",
 769       "desc" : "Checks to see if this object has any listeners for a specified event",
 770       "isStatic" : false,
 771       "isConstructor" : false,
 772       "isPrivate" : false,
 773       "memberOf" : "Roo.util.Observable",
 774       "example" : "",
 775       "deprecated" : "",
 776       "since" : "",
 777       "see" : "",
 778       "params" : [
 779         {
 780           "name" : "eventName",
 781           "type" : "String",
 782           "desc" : "The name of the event to check for",
 783           "isOptional" : false
 784         }
 785       ],
 786       "returns" : [
 787         {
 788           "name" : "",
 789           "type" : "Boolean",
 790           "desc" : "True if the event is being listened for, else false"
 791         }
 792       ]
 793     },
 794     {
 795       "name" : "capture",
 796       "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.",
 797       "isStatic" : true,
 798       "isConstructor" : false,
 799       "isPrivate" : false,
 800       "memberOf" : "Roo.util.Observable",
 801       "example" : "",
 802       "deprecated" : "",
 803       "since" : "",
 804       "see" : "",
 805       "params" : [
 806         {
 807           "name" : "o",
 808           "type" : "Observable",
 809           "desc" : "The Observable to capture",
 810           "isOptional" : false
 811         },
 812         {
 813           "name" : "fn",
 814           "type" : "Function",
 815           "desc" : "The function to call",
 816           "isOptional" : false
 817         },
 818         {
 819           "name" : "scope",
 820           "type" : "Object",
 821           "desc" : "(optional) The scope (this object) for the fn",
 822           "isOptional" : false
 823         }
 824       ],
 825       "returns" : [
 826       ]
 827     },
 828     {
 829       "name" : "addListener",
 830       "desc" : "Appends an event handler to this component",
 831       "isStatic" : false,
 832       "isConstructor" : false,
 833       "isPrivate" : false,
 834       "memberOf" : "Roo.util.Observable",
 835       "example" : "",
 836       "deprecated" : "",
 837       "since" : "",
 838       "see" : "",
 839       "params" : [
 840         {
 841           "name" : "eventName",
 842           "type" : "String",
 843           "desc" : "The type of event to listen for",
 844           "isOptional" : false
 845         },
 846         {
 847           "name" : "handler",
 848           "type" : "Function",
 849           "desc" : "The method the event invokes",
 850           "isOptional" : false
 851         },
 852         {
 853           "name" : "scope",
 854           "type" : "Object",
 855           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 856           "isOptional" : false
 857         },
 858         {
 859           "name" : "options",
 860           "type" : "Object",
 861           "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>",
 862           "isOptional" : false
 863         }
 864       ],
 865       "returns" : [
 866       ]
 867     }
 868   ],
 869   "events" : [
 870     {
 871       "name" : "click",
 872       "desc" : "When a element is chick",
 873       "memberOf" : "Roo.bootstrap.Element",
 874       "example" : "",
 875       "deprecated" : "",
 876       "since" : "",
 877       "see" : "",
 878       "params" : [
 879         {
 880           "name" : "this",
 881           "type" : "Roo.bootstrap.Element",
 882           "desc" : "",
 883           "isOptional" : false
 884         },
 885         {
 886           "name" : "e",
 887           "type" : "Roo.EventObject",
 888           "desc" : "",
 889           "isOptional" : false
 890         }
 891       ],
 892       "returns" : [
 893       ]
 894     },
 895     {
 896       "name" : "childrenrendered",
 897       "desc" : "Fires when the children have been rendered..",
 898       "memberOf" : "Roo.bootstrap.Component",
 899       "example" : "",
 900       "deprecated" : "",
 901       "since" : "",
 902       "see" : "",
 903       "params" : [
 904         {
 905           "name" : "this",
 906           "type" : "Roo.bootstrap.Component",
 907           "desc" : "",
 908           "isOptional" : false
 909         }
 910       ],
 911       "returns" : [
 912       ]
 913     },
 914     {
 915       "name" : "beforerender",
 916       "desc" : "Fires before the component is rendered. Return false to stop the render.",
 917       "memberOf" : "Roo.Component",
 918       "example" : "",
 919       "deprecated" : "",
 920       "since" : "",
 921       "see" : "",
 922       "params" : [
 923         {
 924           "name" : "this",
 925           "type" : "Roo.Component",
 926           "desc" : "",
 927           "isOptional" : false
 928         }
 929       ],
 930       "returns" : [
 931       ]
 932     },
 933     {
 934       "name" : "disable",
 935       "desc" : "Fires after the component is disabled.",
 936       "memberOf" : "Roo.Component",
 937       "example" : "",
 938       "deprecated" : "",
 939       "since" : "",
 940       "see" : "",
 941       "params" : [
 942         {
 943           "name" : "this",
 944           "type" : "Roo.Component",
 945           "desc" : "",
 946           "isOptional" : false
 947         }
 948       ],
 949       "returns" : [
 950       ]
 951     },
 952     {
 953       "name" : "render",
 954       "desc" : "Fires after the component is rendered.",
 955       "memberOf" : "Roo.Component",
 956       "example" : "",
 957       "deprecated" : "",
 958       "since" : "",
 959       "see" : "",
 960       "params" : [
 961         {
 962           "name" : "this",
 963           "type" : "Roo.Component",
 964           "desc" : "",
 965           "isOptional" : false
 966         }
 967       ],
 968       "returns" : [
 969       ]
 970     },
 971     {
 972       "name" : "destroy",
 973       "desc" : "Fires after the component is destroyed.",
 974       "memberOf" : "Roo.Component",
 975       "example" : "",
 976       "deprecated" : "",
 977       "since" : "",
 978       "see" : "",
 979       "params" : [
 980         {
 981           "name" : "this",
 982           "type" : "Roo.Component",
 983           "desc" : "",
 984           "isOptional" : false
 985         }
 986       ],
 987       "returns" : [
 988       ]
 989     },
 990     {
 991       "name" : "hide",
 992       "desc" : "Fires after the component is hidden.",
 993       "memberOf" : "Roo.Component",
 994       "example" : "",
 995       "deprecated" : "",
 996       "since" : "",
 997       "see" : "",
 998       "params" : [
 999         {
1000           "name" : "this",
1001           "type" : "Roo.Component",
1002           "desc" : "",
1003           "isOptional" : false
1004         }
1005       ],
1006       "returns" : [
1007       ]
1008     },
1009     {
1010       "name" : "beforehide",
1011       "desc" : "Fires before the component is hidden. Return false to stop the hide.",
1012       "memberOf" : "Roo.Component",
1013       "example" : "",
1014       "deprecated" : "",
1015       "since" : "",
1016       "see" : "",
1017       "params" : [
1018         {
1019           "name" : "this",
1020           "type" : "Roo.Component",
1021           "desc" : "",
1022           "isOptional" : false
1023         }
1024       ],
1025       "returns" : [
1026       ]
1027     },
1028     {
1029       "name" : "show",
1030       "desc" : "Fires after the component is shown.",
1031       "memberOf" : "Roo.Component",
1032       "example" : "",
1033       "deprecated" : "",
1034       "since" : "",
1035       "see" : "",
1036       "params" : [
1037         {
1038           "name" : "this",
1039           "type" : "Roo.Component",
1040           "desc" : "",
1041           "isOptional" : false
1042         }
1043       ],
1044       "returns" : [
1045       ]
1046     },
1047     {
1048       "name" : "beforeshow",
1049       "desc" : "Fires before the component is shown.  Return false to stop the show.",
1050       "memberOf" : "Roo.Component",
1051       "example" : "",
1052       "deprecated" : "",
1053       "since" : "",
1054       "see" : "",
1055       "params" : [
1056         {
1057           "name" : "this",
1058           "type" : "Roo.Component",
1059           "desc" : "",
1060           "isOptional" : false
1061         }
1062       ],
1063       "returns" : [
1064       ]
1065     },
1066     {
1067       "name" : "enable",
1068       "desc" : "Fires after the component is enabled.",
1069       "memberOf" : "Roo.Component",
1070       "example" : "",
1071       "deprecated" : "",
1072       "since" : "",
1073       "see" : "",
1074       "params" : [
1075         {
1076           "name" : "this",
1077           "type" : "Roo.Component",
1078           "desc" : "",
1079           "isOptional" : false
1080         }
1081       ],
1082       "returns" : [
1083       ]
1084     },
1085     {
1086       "name" : "beforedestroy",
1087       "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
1088       "memberOf" : "Roo.Component",
1089       "example" : "",
1090       "deprecated" : "",
1091       "since" : "",
1092       "see" : "",
1093       "params" : [
1094         {
1095           "name" : "this",
1096           "type" : "Roo.Component",
1097           "desc" : "",
1098           "isOptional" : false
1099         }
1100       ],
1101       "returns" : [
1102       ]
1103     }
1104   ]
1105 }