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

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