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