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

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