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