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