git.roojs.org Git - roojs1/blob - docs/symbols/Roo.form.Layout.json

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