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

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