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