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

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