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

   1 {
   2   "name" : "Roo.form.Radio",
   3   "augments" : [
   4     "Roo.form.Checkbox",
   5     "Roo.form.Field",
   6     "Roo.BoxComponent",
   7     "Roo.Component",
   8     "Roo.util.Observable"
   9   ],
  10   "childClasses" : {  },
  11   "tree_children" : [],
  12   "tree_parent" : [],
  13   "desc" : "Single radio field.  Same as Checkbox, but provided as a convenience for automatically setting the input type.\nRadio grouping is handled automatically by the browser if you give each radio in a group the same name.",
  14   "isSingleton" : false,
  15   "isStatic" : false,
  16   "isBuiltin" : false,
  17   "isAbstract" : false,
  18   "isBuilderTop" : false,
  19   "memberOf" : "Radio",
  20   "example" : "",
  21   "deprecated" : "",
  22   "since" : "",
  23   "see" : "",
  24   "params" : [
  25     {
  26       "name" : "config",
  27       "type" : "Object",
  28       "desc" : "Configuration options",
  29       "isOptional" : false
  30     }
  31   ],
  32   "returns" : [],
  33   "throws" : "",
  34   "requires" : "",
  35   "config" : [
  36     {
  37       "name" : "inputType",
  38       "type" : "String",
  39       "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
  40       "memberOf" : "Roo.form.Field",
  41       "isOptional" : false,
  42       "optvalues" : []
  43     },
  44     {
  45       "name" : "listeners",
  46       "type" : "Object",
  47       "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>",
  48       "memberOf" : "Roo.util.Observable",
  49       "isOptional" : false,
  50       "optvalues" : []
  51     },
  52     {
  53       "name" : "msgFx",
  54       "type" : "String",
  55       "desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
  56       "memberOf" : "Roo.form.Field",
  57       "isOptional" : false,
  58       "optvalues" : []
  59     },
  60     {
  61       "name" : "inputValue",
  62       "type" : "String",
  63       "desc" : "The value that should go into the generated input element's value attribute",
  64       "memberOf" : "Roo.form.Checkbox",
  65       "isOptional" : false,
  66       "optvalues" : []
  67     },
  68     {
  69       "name" : "fieldLabel",
  70       "type" : "String",
  71       "desc" : "Label to use when rendering a form.",
  72       "memberOf" : "Roo.form.Field",
  73       "isOptional" : false,
  74       "optvalues" : []
  75     },
  76     {
  77       "name" : "validationDelay",
  78       "type" : "Number",
  79       "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
  80       "memberOf" : "Roo.form.Field",
  81       "isOptional" : false,
  82       "optvalues" : []
  83     },
  84     {
  85       "name" : "msgTarget",
  86       "type" : "String",
  87       "desc" : "The location where error text should display.  Should be one of the following values (defaults to 'qtip'):\n<pre>\nValue         Description\n-----------   ----------------------------------------------------------------------\nqtip          Display a quick tip when the user hovers over the field\ntitle         Display a default browser title attribute popup\nunder         Add a block div beneath the field containing the error text\nside          Add an error icon to the right of the field with a popup on hover\n[element id]  Add the error text directly to the innerHTML of the specified element\n</pre>",
  88       "memberOf" : "Roo.form.Field",
  89       "isOptional" : false,
  90       "optvalues" : []
  91     },
  92     {
  93       "name" : "hideMode",
  94       "type" : "String",
  95       "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",
  96       "memberOf" : "Roo.Component",
  97       "isOptional" : false,
  98       "optvalues" : [
  99         "display",
 100         "visibility"
 101       ]
 102     },
 103     {
 104       "name" : "disabled",
 105       "type" : "Boolean",
 106       "desc" : "True to disable the field (defaults to false).",
 107       "memberOf" : "Roo.form.Field",
 108       "isOptional" : false,
 109       "optvalues" : []
 110     },
 111     {
 112       "name" : "value",
 113       "type" : "Mixed",
 114       "desc" : "A value to initialize this field with.",
 115       "memberOf" : "Roo.form.Field",
 116       "isOptional" : false,
 117       "optvalues" : []
 118     },
 119     {
 120       "name" : "allowDomMove",
 121       "type" : "Boolean",
 122       "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
 123       "memberOf" : "Roo.Component",
 124       "isOptional" : false,
 125       "optvalues" : []
 126     },
 127     {
 128       "name" : "tabIndex",
 129       "type" : "Number",
 130       "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
 131       "memberOf" : "Roo.form.Field",
 132       "isOptional" : false,
 133       "optvalues" : []
 134     },
 135     {
 136       "name" : "readOnly",
 137       "type" : "Boolean",
 138       "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
 139       "memberOf" : "Roo.form.Field",
 140       "isOptional" : false,
 141       "optvalues" : []
 142     },
 143     {
 144       "name" : "invalidClass",
 145       "type" : "String",
 146       "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
 147       "memberOf" : "Roo.form.Field",
 148       "isOptional" : false,
 149       "optvalues" : []
 150     },
 151     {
 152       "name" : "cls",
 153       "type" : "String",
 154       "desc" : "A CSS class to apply to the field's underlying element.",
 155       "memberOf" : "Roo.form.Field",
 156       "isOptional" : false,
 157       "optvalues" : []
 158     },
 159     {
 160       "name" : "autoCreate",
 161       "type" : "String/Object",
 162       "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})",
 163       "memberOf" : "Roo.form.Checkbox",
 164       "isOptional" : false,
 165       "optvalues" : []
 166     },
 167     {
 168       "name" : "valueOff",
 169       "type" : "String",
 170       "desc" : "The value that should go into the generated input element's value when unchecked.",
 171       "memberOf" : "Roo.form.Checkbox",
 172       "isOptional" : false,
 173       "optvalues" : []
 174     },
 175     {
 176       "name" : "invalidText",
 177       "type" : "String",
 178       "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
 179       "memberOf" : "Roo.form.Field",
 180       "isOptional" : false,
 181       "optvalues" : []
 182     },
 183     {
 184       "name" : "actionMode",
 185       "type" : "String",
 186       "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",
 187       "memberOf" : "Roo.Component",
 188       "isOptional" : false,
 189       "optvalues" : []
 190     },
 191     {
 192       "name" : "boxLabel",
 193       "type" : "String",
 194       "desc" : "The text that appears beside the checkbox",
 195       "memberOf" : "Roo.form.Checkbox",
 196       "isOptional" : false,
 197       "optvalues" : []
 198     },
 199     {
 200       "name" : "width",
 201       "type" : "Number",
 202       "desc" : "width (optional) size of component",
 203       "memberOf" : "Roo.BoxComponent",
 204       "isOptional" : false,
 205       "optvalues" : []
 206     },
 207     {
 208       "name" : "validateOnBlur",
 209       "type" : "Boolean",
 210       "desc" : "Whether the field should validate when it loses focus (defaults to true).",
 211       "memberOf" : "Roo.form.Field",
 212       "isOptional" : false,
 213       "optvalues" : []
 214     },
 215     {
 216       "name" : "validationEvent",
 217       "type" : "String/Boolean",
 218       "desc" : "The event that should initiate field validation. Set to false to disable\n      automatic validation (defaults to \"keyup\").",
 219       "memberOf" : "Roo.form.Field",
 220       "isOptional" : false,
 221       "optvalues" : []
 222     },
 223     {
 224       "name" : "fieldClass",
 225       "type" : "String",
 226       "desc" : "The default CSS class for the checkbox (defaults to \"x-form-field\")",
 227       "memberOf" : "Roo.form.Checkbox",
 228       "isOptional" : false,
 229       "optvalues" : []
 230     },
 231     {
 232       "name" : "checked",
 233       "type" : "Boolean",
 234       "desc" : "True if the the checkbox should render already checked (defaults to false)",
 235       "memberOf" : "Roo.form.Checkbox",
 236       "isOptional" : false,
 237       "optvalues" : []
 238     },
 239     {
 240       "name" : "focusClass",
 241       "type" : "String",
 242       "desc" : "The CSS class to use when the checkbox receives focus (defaults to undefined)",
 243       "memberOf" : "Roo.form.Checkbox",
 244       "isOptional" : false,
 245       "optvalues" : []
 246     },
 247     {
 248       "name" : "name",
 249       "type" : "String",
 250       "desc" : "The field's HTML name attribute.",
 251       "memberOf" : "Roo.form.Field",
 252       "isOptional" : false,
 253       "optvalues" : []
 254     },
 255     {
 256       "name" : "qtip",
 257       "type" : "String",
 258       "desc" : "Mouse over tip",
 259       "memberOf" : "Roo.form.Field",
 260       "isOptional" : false,
 261       "optvalues" : []
 262     },
 263     {
 264       "name" : "height",
 265       "type" : "Number",
 266       "desc" : "height (optional) size of component",
 267       "memberOf" : "Roo.BoxComponent",
 268       "isOptional" : false,
 269       "optvalues" : []
 270     },
 271     {
 272       "name" : "disableClass",
 273       "type" : "String",
 274       "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
 275       "memberOf" : "Roo.Component",
 276       "isOptional" : false,
 277       "optvalues" : []
 278     }
 279   ],
 280   "methods" : [
 281     {
 282       "name" : "getGroupValue",
 283       "type" : "function",
 284       "desc" : "If this radio is part of a group, it will return the selected value",
 285       "sig" : "()\n{\n\n}",
 286       "static" : false,
 287       "memberOf" : "",
 288       "isStatic" : false,
 289       "isConstructor" : false,
 290       "isPrivate" : false,
 291       "example" : "",
 292       "deprecated" : "",
 293       "since" : "",
 294       "see" : "",
 295       "exceptions" : "",
 296       "requires" : "",
 297       "params" : [],
 298       "returns" : [
 299         {
 300           "name" : "",
 301           "type" : "String",
 302           "desc" : ""
 303         }
 304       ]
 305     },
 306     {
 307       "name" : "setValue",
 308       "type" : "function",
 309       "desc" : "Sets the checked state of the checkbox.\nOn is always based on a string comparison between inputValue and the param.",
 310       "sig" : "(value, suppressEvent)",
 311       "static" : false,
 312       "memberOf" : "Roo.form.Checkbox",
 313       "isStatic" : false,
 314       "isConstructor" : false,
 315       "isPrivate" : false,
 316       "example" : "",
 317       "deprecated" : "",
 318       "since" : "",
 319       "see" : "",
 320       "exceptions" : "",
 321       "requires" : "",
 322       "params" : [
 323         {
 324           "name" : "value",
 325           "type" : "Boolean/String",
 326           "desc" : "- the value to set",
 327           "isOptional" : false
 328         },
 329         {
 330           "name" : "suppressEvent",
 331           "type" : "Boolean/String",
 332           "desc" : "- whether to suppress the checkchange event.",
 333           "isOptional" : false
 334         }
 335       ],
 336       "returns" : []
 337     },
 338     {
 339       "name" : "getValue",
 340       "type" : "function",
 341       "desc" : "Returns the checked state of the checkbox.",
 342       "sig" : "()\n{\n\n}",
 343       "static" : false,
 344       "memberOf" : "Roo.form.Checkbox",
 345       "isStatic" : false,
 346       "isConstructor" : false,
 347       "isPrivate" : false,
 348       "example" : "",
 349       "deprecated" : "",
 350       "since" : "",
 351       "see" : "",
 352       "exceptions" : "",
 353       "requires" : "",
 354       "params" : [],
 355       "returns" : [
 356         {
 357           "name" : "",
 358           "type" : "Boolean",
 359           "desc" : "True if checked, else false"
 360         }
 361       ]
 362     },
 363     {
 364       "name" : "validate",
 365       "type" : "function",
 366       "desc" : "Validates the field value",
 367       "sig" : "()\n{\n\n}",
 368       "static" : false,
 369       "memberOf" : "Roo.form.Field",
 370       "isStatic" : false,
 371       "isConstructor" : false,
 372       "isPrivate" : false,
 373       "example" : "",
 374       "deprecated" : "",
 375       "since" : "",
 376       "see" : "",
 377       "exceptions" : "",
 378       "requires" : "",
 379       "params" : [],
 380       "returns" : [
 381         {
 382           "name" : "",
 383           "type" : "Boolean",
 384           "desc" : "True if the value is valid, else false"
 385         }
 386       ]
 387     },
 388     {
 389       "name" : "getName",
 390       "type" : "function",
 391       "desc" : "Returns the name attribute of the field if available",
 392       "sig" : "()\n{\n\n}",
 393       "static" : false,
 394       "memberOf" : "Roo.form.Field",
 395       "isStatic" : false,
 396       "isConstructor" : false,
 397       "isPrivate" : false,
 398       "example" : "",
 399       "deprecated" : "",
 400       "since" : "",
 401       "see" : "",
 402       "exceptions" : "",
 403       "requires" : "",
 404       "params" : [],
 405       "returns" : [
 406         {
 407           "name" : "",
 408           "type" : "String",
 409           "desc" : "name The field name"
 410         }
 411       ]
 412     },
 413     {
 414       "name" : "markInvalid",
 415       "type" : "function",
 416       "desc" : "Mark this field as invalid",
 417       "sig" : "(msg)",
 418       "static" : false,
 419       "memberOf" : "Roo.form.Field",
 420       "isStatic" : false,
 421       "isConstructor" : false,
 422       "isPrivate" : false,
 423       "example" : "",
 424       "deprecated" : "",
 425       "since" : "",
 426       "see" : "",
 427       "exceptions" : "",
 428       "requires" : "",
 429       "params" : [
 430         {
 431           "name" : "msg",
 432           "type" : "String",
 433           "desc" : "The validation message",
 434           "isOptional" : false
 435         }
 436       ],
 437       "returns" : []
 438     },
 439     {
 440       "name" : "getRawValue",
 441       "type" : "function",
 442       "desc" : "Returns the raw data value which may or may not be a valid, defined value.  To return a normalized value see {@link #getValue}.",
 443       "sig" : "()\n{\n\n}",
 444       "static" : false,
 445       "memberOf" : "Roo.form.Field",
 446       "isStatic" : false,
 447       "isConstructor" : false,
 448       "isPrivate" : false,
 449       "example" : "",
 450       "deprecated" : "",
 451       "since" : "",
 452       "see" : "",
 453       "exceptions" : "",
 454       "requires" : "",
 455       "params" : [],
 456       "returns" : [
 457         {
 458           "name" : "",
 459           "type" : "Mixed",
 460           "desc" : "value The field value"
 461         }
 462       ]
 463     },
 464     {
 465       "name" : "applyTo",
 466       "type" : "function",
 467       "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
 468       "sig" : "(el)",
 469       "static" : false,
 470       "memberOf" : "Roo.form.Field",
 471       "isStatic" : false,
 472       "isConstructor" : false,
 473       "isPrivate" : false,
 474       "example" : "",
 475       "deprecated" : "",
 476       "since" : "",
 477       "see" : "",
 478       "exceptions" : "",
 479       "requires" : "",
 480       "params" : [
 481         {
 482           "name" : "el",
 483           "type" : "String/HTMLElement/Element",
 484           "desc" : "The id of the node, a DOM node or an existing Element",
 485           "isOptional" : false
 486         }
 487       ],
 488       "returns" : [
 489         {
 490           "name" : "",
 491           "type" : "Roo.form.Field",
 492           "desc" : "this"
 493         }
 494       ]
 495     },
 496     {
 497       "name" : "resetHasChanged",
 498       "type" : "function",
 499       "desc" : "stores the current value in loadedValue",
 500       "sig" : "()\n{\n\n}",
 501       "static" : false,
 502       "memberOf" : "Roo.form.Field",
 503       "isStatic" : false,
 504       "isConstructor" : false,
 505       "isPrivate" : false,
 506       "example" : "",
 507       "deprecated" : "",
 508       "since" : "",
 509       "see" : "",
 510       "exceptions" : "",
 511       "requires" : "",
 512       "params" : [],
 513       "returns" : []
 514     },
 515     {
 516       "name" : "isDirty",
 517       "type" : "function",
 518       "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED  - it never worked well - use hasChanged/resetHasChanged.",
 519       "sig" : "()\n{\n\n}",
 520       "static" : false,
 521       "memberOf" : "Roo.form.Field",
 522       "isStatic" : false,
 523       "isConstructor" : false,
 524       "isPrivate" : false,
 525       "example" : "",
 526       "deprecated" : "",
 527       "since" : "",
 528       "see" : "",
 529       "exceptions" : "",
 530       "requires" : "",
 531       "params" : [],
 532       "returns" : []
 533     },
 534     {
 535       "name" : "setRawValue",
 536       "type" : "function",
 537       "desc" : "Sets the underlying DOM field's value directly, bypassing validation.  To set the value with validation see {@link #setValue}.",
 538       "sig" : "(value)",
 539       "static" : false,
 540       "memberOf" : "Roo.form.Field",
 541       "isStatic" : false,
 542       "isConstructor" : false,
 543       "isPrivate" : false,
 544       "example" : "",
 545       "deprecated" : "",
 546       "since" : "",
 547       "see" : "",
 548       "exceptions" : "",
 549       "requires" : "",
 550       "params" : [
 551         {
 552           "name" : "value",
 553           "type" : "Mixed",
 554           "desc" : "The value to set",
 555           "isOptional" : false
 556         }
 557       ],
 558       "returns" : []
 559     },
 560     {
 561       "name" : "clearInvalid",
 562       "type" : "function",
 563       "desc" : "Clear any invalid styles/messages for this field",
 564       "sig" : "()\n{\n\n}",
 565       "static" : false,
 566       "memberOf" : "Roo.form.Field",
 567       "isStatic" : false,
 568       "isConstructor" : false,
 569       "isPrivate" : false,
 570       "example" : "",
 571       "deprecated" : "",
 572       "since" : "",
 573       "see" : "",
 574       "exceptions" : "",
 575       "requires" : "",
 576       "params" : [],
 577       "returns" : []
 578     },
 579     {
 580       "name" : "isValid",
 581       "type" : "function",
 582       "desc" : "Returns whether or not the field value is currently valid",
 583       "sig" : "(preventMark)",
 584       "static" : false,
 585       "memberOf" : "Roo.form.Field",
 586       "isStatic" : false,
 587       "isConstructor" : false,
 588       "isPrivate" : false,
 589       "example" : "",
 590       "deprecated" : "",
 591       "since" : "",
 592       "see" : "",
 593       "exceptions" : "",
 594       "requires" : "",
 595       "params" : [
 596         {
 597           "name" : "preventMark",
 598           "type" : "Boolean",
 599           "desc" : "True to disable marking the field invalid",
 600           "isOptional" : false
 601         }
 602       ],
 603       "returns" : [
 604         {
 605           "name" : "",
 606           "type" : "Boolean",
 607           "desc" : "True if the value is valid, else false"
 608         }
 609       ]
 610     },
 611     {
 612       "name" : "reset",
 613       "type" : "function",
 614       "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
 615       "sig" : "()\n{\n\n}",
 616       "static" : false,
 617       "memberOf" : "Roo.form.Field",
 618       "isStatic" : false,
 619       "isConstructor" : false,
 620       "isPrivate" : false,
 621       "example" : "",
 622       "deprecated" : "",
 623       "since" : "",
 624       "see" : "",
 625       "exceptions" : "",
 626       "requires" : "",
 627       "params" : [],
 628       "returns" : []
 629     },
 630     {
 631       "name" : "hasChanged",
 632       "type" : "function",
 633       "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
 634       "sig" : "()\n{\n\n}",
 635       "static" : false,
 636       "memberOf" : "Roo.form.Field",
 637       "isStatic" : false,
 638       "isConstructor" : false,
 639       "isPrivate" : false,
 640       "example" : "",
 641       "deprecated" : "",
 642       "since" : "",
 643       "see" : "",
 644       "exceptions" : "",
 645       "requires" : "",
 646       "params" : [],
 647       "returns" : []
 648     },
 649     {
 650       "name" : "updateBox",
 651       "type" : "function",
 652       "desc" : "Sets the current box measurements of the component's underlying element.",
 653       "sig" : "(box)",
 654       "static" : false,
 655       "memberOf" : "Roo.BoxComponent",
 656       "isStatic" : false,
 657       "isConstructor" : false,
 658       "isPrivate" : false,
 659       "example" : "",
 660       "deprecated" : "",
 661       "since" : "",
 662       "see" : "",
 663       "exceptions" : "",
 664       "requires" : "",
 665       "params" : [
 666         {
 667           "name" : "box",
 668           "type" : "Object",
 669           "desc" : "An object in the format {x, y, width, height}",
 670           "isOptional" : false
 671         }
 672       ],
 673       "returns" : []
 674     },
 675     {
 676       "name" : "setPagePosition",
 677       "type" : "function",
 678       "desc" : "Sets the page XY position of the component.  To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.",
 679       "sig" : "(x, y)",
 680       "static" : false,
 681       "memberOf" : "Roo.BoxComponent",
 682       "isStatic" : false,
 683       "isConstructor" : false,
 684       "isPrivate" : false,
 685       "example" : "",
 686       "deprecated" : "",
 687       "since" : "",
 688       "see" : "",
 689       "exceptions" : "",
 690       "requires" : "",
 691       "params" : [
 692         {
 693           "name" : "x",
 694           "type" : "Number",
 695           "desc" : "The new x position",
 696           "isOptional" : false
 697         },
 698         {
 699           "name" : "y",
 700           "type" : "Number",
 701           "desc" : "The new y position",
 702           "isOptional" : false
 703         }
 704       ],
 705       "returns" : []
 706     },
 707     {
 708       "name" : "syncSize",
 709       "type" : "function",
 710       "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.",
 711       "sig" : "()\n{\n\n}",
 712       "static" : false,
 713       "memberOf" : "Roo.BoxComponent",
 714       "isStatic" : false,
 715       "isConstructor" : false,
 716       "isPrivate" : false,
 717       "example" : "",
 718       "deprecated" : "",
 719       "since" : "",
 720       "see" : "",
 721       "exceptions" : "",
 722       "requires" : "",
 723       "params" : [],
 724       "returns" : []
 725     },
 726     {
 727       "name" : "setSize",
 728       "type" : "function",
 729       "desc" : "Sets the width and height of the component.  This method fires the resize event.  This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.",
 730       "sig" : "(width, height)",
 731       "static" : false,
 732       "memberOf" : "Roo.BoxComponent",
 733       "isStatic" : false,
 734       "isConstructor" : false,
 735       "isPrivate" : false,
 736       "example" : "",
 737       "deprecated" : "",
 738       "since" : "",
 739       "see" : "",
 740       "exceptions" : "",
 741       "requires" : "",
 742       "params" : [
 743         {
 744           "name" : "width",
 745           "type" : "Number/Object",
 746           "desc" : "The new width to set, or a size object in the format {width, height}",
 747           "isOptional" : false
 748         },
 749         {
 750           "name" : "height",
 751           "type" : "Number",
 752           "desc" : "The new height to set (not required if a size object is passed as the first arg)",
 753           "isOptional" : false
 754         }
 755       ],
 756       "returns" : [
 757         {
 758           "name" : "",
 759           "type" : "Roo.BoxComponent",
 760           "desc" : "this"
 761         }
 762       ]
 763     },
 764     {
 765       "name" : "getPosition",
 766       "type" : "function",
 767       "desc" : "Gets the current XY position of the component's underlying element.",
 768       "sig" : "(local)",
 769       "static" : false,
 770       "memberOf" : "Roo.BoxComponent",
 771       "isStatic" : false,
 772       "isConstructor" : false,
 773       "isPrivate" : false,
 774       "example" : "",
 775       "deprecated" : "",
 776       "since" : "",
 777       "see" : "",
 778       "exceptions" : "",
 779       "requires" : "",
 780       "params" : [
 781         {
 782           "name" : "local",
 783           "type" : "Boolean",
 784           "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
 785           "isOptional" : false
 786         }
 787       ],
 788       "returns" : [
 789         {
 790           "name" : "",
 791           "type" : "Array",
 792           "desc" : "The XY position of the element (e.g., [100, 200])"
 793         }
 794       ]
 795     },
 796     {
 797       "name" : "onResize",
 798       "type" : "function",
 799       "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.",
 800       "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)",
 801       "static" : false,
 802       "memberOf" : "Roo.BoxComponent",
 803       "isStatic" : false,
 804       "isConstructor" : false,
 805       "isPrivate" : false,
 806       "example" : "",
 807       "deprecated" : "",
 808       "since" : "",
 809       "see" : "",
 810       "exceptions" : "",
 811       "requires" : "",
 812       "params" : [
 813         {
 814           "name" : "adjWidth",
 815           "type" : "Number",
 816           "desc" : "The box-adjusted width that was set",
 817           "isOptional" : false
 818         },
 819         {
 820           "name" : "adjHeight",
 821           "type" : "Number",
 822           "desc" : "The box-adjusted height that was set",
 823           "isOptional" : false
 824         },
 825         {
 826           "name" : "rawWidth",
 827           "type" : "Number",
 828           "desc" : "The width that was originally specified",
 829           "isOptional" : false
 830         },
 831         {
 832           "name" : "rawHeight",
 833           "type" : "Number",
 834           "desc" : "The height that was originally specified",
 835           "isOptional" : false
 836         }
 837       ],
 838       "returns" : []
 839     },
 840     {
 841       "name" : "getBox",
 842       "type" : "function",
 843       "desc" : "Gets the current box measurements of the component's underlying element.",
 844       "sig" : "(local)",
 845       "static" : false,
 846       "memberOf" : "Roo.BoxComponent",
 847       "isStatic" : false,
 848       "isConstructor" : false,
 849       "isPrivate" : false,
 850       "example" : "",
 851       "deprecated" : "",
 852       "since" : "",
 853       "see" : "",
 854       "exceptions" : "",
 855       "requires" : "",
 856       "params" : [
 857         {
 858           "name" : "local",
 859           "type" : "Boolean",
 860           "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
 861           "isOptional" : false
 862         }
 863       ],
 864       "returns" : []
 865     },
 866     {
 867       "name" : "getSize",
 868       "type" : "function",
 869       "desc" : "Gets the current size of the component's underlying element.",
 870       "sig" : "()\n{\n\n}",
 871       "static" : false,
 872       "memberOf" : "Roo.BoxComponent",
 873       "isStatic" : false,
 874       "isConstructor" : false,
 875       "isPrivate" : false,
 876       "example" : "",
 877       "deprecated" : "",
 878       "since" : "",
 879       "see" : "",
 880       "exceptions" : "",
 881       "requires" : "",
 882       "params" : [],
 883       "returns" : [
 884         {
 885           "name" : "",
 886           "type" : "Object",
 887           "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
 888         }
 889       ]
 890     },
 891     {
 892       "name" : "onPosition",
 893       "type" : "function",
 894       "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.",
 895       "sig" : "(x, y)",
 896       "static" : false,
 897       "memberOf" : "Roo.BoxComponent",
 898       "isStatic" : false,
 899       "isConstructor" : false,
 900       "isPrivate" : false,
 901       "example" : "",
 902       "deprecated" : "",
 903       "since" : "",
 904       "see" : "",
 905       "exceptions" : "",
 906       "requires" : "",
 907       "params" : [
 908         {
 909           "name" : "x",
 910           "type" : "Number",
 911           "desc" : "The new x position",
 912           "isOptional" : false
 913         },
 914         {
 915           "name" : "y",
 916           "type" : "Number",
 917           "desc" : "The new y position",
 918           "isOptional" : false
 919         }
 920       ],
 921       "returns" : []
 922     },
 923     {
 924       "name" : "setPosition",
 925       "type" : "function",
 926       "desc" : "Sets the left and top of the component.  To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.",
 927       "sig" : "(left, top)",
 928       "static" : false,
 929       "memberOf" : "Roo.BoxComponent",
 930       "isStatic" : false,
 931       "isConstructor" : false,
 932       "isPrivate" : false,
 933       "example" : "",
 934       "deprecated" : "",
 935       "since" : "",
 936       "see" : "",
 937       "exceptions" : "",
 938       "requires" : "",
 939       "params" : [
 940         {
 941           "name" : "left",
 942           "type" : "Number",
 943           "desc" : "The new left",
 944           "isOptional" : false
 945         },
 946         {
 947           "name" : "top",
 948           "type" : "Number",
 949           "desc" : "The new top",
 950           "isOptional" : false
 951         }
 952       ],
 953       "returns" : []
 954     },
 955     {
 956       "name" : "getId",
 957       "type" : "function",
 958       "desc" : "Returns the id of this component.",
 959       "sig" : "()\n{\n\n}",
 960       "static" : false,
 961       "memberOf" : "Roo.Component",
 962       "isStatic" : false,
 963       "isConstructor" : false,
 964       "isPrivate" : false,
 965       "example" : "",
 966       "deprecated" : "",
 967       "since" : "",
 968       "see" : "",
 969       "exceptions" : "",
 970       "requires" : "",
 971       "params" : [],
 972       "returns" : [
 973         {
 974           "name" : "",
 975           "type" : "String",
 976           "desc" : ""
 977         }
 978       ]
 979     },
 980     {
 981       "name" : "render",
 982       "type" : "function",
 983       "desc" : "If this is a lazy rendering component, render it to its container element.",
 984       "sig" : "(container)",
 985       "static" : false,
 986       "memberOf" : "Roo.Component",
 987       "isStatic" : false,
 988       "isConstructor" : false,
 989       "isPrivate" : false,
 990       "example" : "",
 991       "deprecated" : "",
 992       "since" : "",
 993       "see" : "",
 994       "exceptions" : "",
 995       "requires" : "",
 996       "params" : [
 997         {
 998           "name" : "container",
 999           "type" : "String/HTMLElement/Element",
1000           "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
1001           "isOptional" : false
1002         }
1003       ],
1004       "returns" : []
1005     },
1006     {
1007       "name" : "destroy",
1008       "type" : "function",
1009       "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}.",
1010       "sig" : "()\n{\n\n}",
1011       "static" : false,
1012       "memberOf" : "Roo.Component",
1013       "isStatic" : false,
1014       "isConstructor" : false,
1015       "isPrivate" : false,
1016       "example" : "",
1017       "deprecated" : "",
1018       "since" : "",
1019       "see" : "",
1020       "exceptions" : "",
1021       "requires" : "",
1022       "params" : [],
1023       "returns" : []
1024     },
1025     {
1026       "name" : "isVisible",
1027       "type" : "function",
1028       "desc" : "Returns true if this component is visible.",
1029       "sig" : "()\n{\n\n}",
1030       "static" : false,
1031       "memberOf" : "Roo.Component",
1032       "isStatic" : false,
1033       "isConstructor" : false,
1034       "isPrivate" : false,
1035       "example" : "",
1036       "deprecated" : "",
1037       "since" : "",
1038       "see" : "",
1039       "exceptions" : "",
1040       "requires" : "",
1041       "params" : [],
1042       "returns" : []
1043     },
1044     {
1045       "name" : "setDisabled",
1046       "type" : "function",
1047       "desc" : "Convenience function for setting disabled/enabled by boolean.",
1048       "sig" : "(disabled)",
1049       "static" : false,
1050       "memberOf" : "Roo.Component",
1051       "isStatic" : false,
1052       "isConstructor" : false,
1053       "isPrivate" : false,
1054       "example" : "",
1055       "deprecated" : "",
1056       "since" : "",
1057       "see" : "",
1058       "exceptions" : "",
1059       "requires" : "",
1060       "params" : [
1061         {
1062           "name" : "disabled",
1063           "type" : "Boolean",
1064           "desc" : "",
1065           "isOptional" : false
1066         }
1067       ],
1068       "returns" : []
1069     },
1070     {
1071       "name" : "hide",
1072       "type" : "function",
1073       "desc" : "Hide this component.",
1074       "sig" : "()\n{\n\n}",
1075       "static" : false,
1076       "memberOf" : "Roo.Component",
1077       "isStatic" : false,
1078       "isConstructor" : false,
1079       "isPrivate" : false,
1080       "example" : "",
1081       "deprecated" : "",
1082       "since" : "",
1083       "see" : "",
1084       "exceptions" : "",
1085       "requires" : "",
1086       "params" : [],
1087       "returns" : [
1088         {
1089           "name" : "",
1090           "type" : "Roo.Component",
1091           "desc" : "this"
1092         }
1093       ]
1094     },
1095     {
1096       "name" : "focus",
1097       "type" : "function",
1098       "desc" : "Try to focus this component.",
1099       "sig" : "(selectText)",
1100       "static" : false,
1101       "memberOf" : "Roo.Component",
1102       "isStatic" : false,
1103       "isConstructor" : false,
1104       "isPrivate" : false,
1105       "example" : "",
1106       "deprecated" : "",
1107       "since" : "",
1108       "see" : "",
1109       "exceptions" : "",
1110       "requires" : "",
1111       "params" : [
1112         {
1113           "name" : "selectText",
1114           "type" : "Boolean",
1115           "desc" : "True to also select the text in this component (if applicable)",
1116           "isOptional" : false
1117         }
1118       ],
1119       "returns" : [
1120         {
1121           "name" : "",
1122           "type" : "Roo.Component",
1123           "desc" : "this"
1124         }
1125       ]
1126     },
1127     {
1128       "name" : "show",
1129       "type" : "function",
1130       "desc" : "Show this component.",
1131       "sig" : "()\n{\n\n}",
1132       "static" : false,
1133       "memberOf" : "Roo.Component",
1134       "isStatic" : false,
1135       "isConstructor" : false,
1136       "isPrivate" : false,
1137       "example" : "",
1138       "deprecated" : "",
1139       "since" : "",
1140       "see" : "",
1141       "exceptions" : "",
1142       "requires" : "",
1143       "params" : [],
1144       "returns" : [
1145         {
1146           "name" : "",
1147           "type" : "Roo.Component",
1148           "desc" : "this"
1149         }
1150       ]
1151     },
1152     {
1153       "name" : "enable",
1154       "type" : "function",
1155       "desc" : "Enable this component.",
1156       "sig" : "()\n{\n\n}",
1157       "static" : false,
1158       "memberOf" : "Roo.Component",
1159       "isStatic" : false,
1160       "isConstructor" : false,
1161       "isPrivate" : false,
1162       "example" : "",
1163       "deprecated" : "",
1164       "since" : "",
1165       "see" : "",
1166       "exceptions" : "",
1167       "requires" : "",
1168       "params" : [],
1169       "returns" : [
1170         {
1171           "name" : "",
1172           "type" : "Roo.Component",
1173           "desc" : "this"
1174         }
1175       ]
1176     },
1177     {
1178       "name" : "setVisible",
1179       "type" : "function",
1180       "desc" : "Convenience function to hide or show this component by boolean.",
1181       "sig" : "(visible)",
1182       "static" : false,
1183       "memberOf" : "Roo.Component",
1184       "isStatic" : false,
1185       "isConstructor" : false,
1186       "isPrivate" : false,
1187       "example" : "",
1188       "deprecated" : "",
1189       "since" : "",
1190       "see" : "",
1191       "exceptions" : "",
1192       "requires" : "",
1193       "params" : [
1194         {
1195           "name" : "visible",
1196           "type" : "Boolean",
1197           "desc" : "True to show, false to hide",
1198           "isOptional" : false
1199         }
1200       ],
1201       "returns" : [
1202         {
1203           "name" : "",
1204           "type" : "Roo.Component",
1205           "desc" : "this"
1206         }
1207       ]
1208     },
1209     {
1210       "name" : "disable",
1211       "type" : "function",
1212       "desc" : "Disable this component.",
1213       "sig" : "()\n{\n\n}",
1214       "static" : false,
1215       "memberOf" : "Roo.Component",
1216       "isStatic" : false,
1217       "isConstructor" : false,
1218       "isPrivate" : false,
1219       "example" : "",
1220       "deprecated" : "",
1221       "since" : "",
1222       "see" : "",
1223       "exceptions" : "",
1224       "requires" : "",
1225       "params" : [],
1226       "returns" : [
1227         {
1228           "name" : "",
1229           "type" : "Roo.Component",
1230           "desc" : "this"
1231         }
1232       ]
1233     },
1234     {
1235       "name" : "getEl",
1236       "type" : "function",
1237       "desc" : "Returns the underlying {@link Roo.Element}.",
1238       "sig" : "()\n{\n\n}",
1239       "static" : false,
1240       "memberOf" : "Roo.Component",
1241       "isStatic" : false,
1242       "isConstructor" : false,
1243       "isPrivate" : false,
1244       "example" : "",
1245       "deprecated" : "",
1246       "since" : "",
1247       "see" : "",
1248       "exceptions" : "",
1249       "requires" : "",
1250       "params" : [],
1251       "returns" : [
1252         {
1253           "name" : "",
1254           "type" : "Roo.Element",
1255           "desc" : "The element"
1256         }
1257       ]
1258     },
1259     {
1260       "name" : "purgeListeners",
1261       "type" : "function",
1262       "desc" : "Removes all listeners for this object",
1263       "sig" : "()\n{\n\n}",
1264       "static" : false,
1265       "memberOf" : "Roo.util.Observable",
1266       "isStatic" : false,
1267       "isConstructor" : false,
1268       "isPrivate" : false,
1269       "example" : "",
1270       "deprecated" : "",
1271       "since" : "",
1272       "see" : "",
1273       "exceptions" : "",
1274       "requires" : "",
1275       "params" : [],
1276       "returns" : []
1277     },
1278     {
1279       "name" : "on",
1280       "type" : "function",
1281       "desc" : "Appends an event handler to this element (shorthand for addListener)",
1282       "sig" : "(eventName, handler, scope, options)",
1283       "static" : false,
1284       "memberOf" : "Roo.util.Observable",
1285       "isStatic" : false,
1286       "isConstructor" : false,
1287       "isPrivate" : false,
1288       "example" : "",
1289       "deprecated" : "",
1290       "since" : "",
1291       "see" : "",
1292       "exceptions" : "",
1293       "requires" : "",
1294       "params" : [
1295         {
1296           "name" : "eventName",
1297           "type" : "String",
1298           "desc" : "The type of event to listen for",
1299           "isOptional" : false
1300         },
1301         {
1302           "name" : "handler",
1303           "type" : "Function",
1304           "desc" : "The method the event invokes",
1305           "isOptional" : false
1306         },
1307         {
1308           "name" : "scope",
1309           "type" : "Object",
1310           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1311           "isOptional" : false
1312         },
1313         {
1314           "name" : "options",
1315           "type" : "Object",
1316           "desc" : "(optional)",
1317           "isOptional" : false
1318         }
1319       ],
1320       "returns" : []
1321     },
1322     {
1323       "name" : "un",
1324       "type" : "function",
1325       "desc" : "Removes a listener (shorthand for removeListener)",
1326       "sig" : "(eventName, handler, scope)",
1327       "static" : false,
1328       "memberOf" : "Roo.util.Observable",
1329       "isStatic" : false,
1330       "isConstructor" : false,
1331       "isPrivate" : false,
1332       "example" : "",
1333       "deprecated" : "",
1334       "since" : "",
1335       "see" : "",
1336       "exceptions" : "",
1337       "requires" : "",
1338       "params" : [
1339         {
1340           "name" : "eventName",
1341           "type" : "String",
1342           "desc" : "The type of event to listen for",
1343           "isOptional" : false
1344         },
1345         {
1346           "name" : "handler",
1347           "type" : "Function",
1348           "desc" : "The handler to remove",
1349           "isOptional" : false
1350         },
1351         {
1352           "name" : "scope",
1353           "type" : "Object",
1354           "desc" : "(optional) The scope (this object) for the handler",
1355           "isOptional" : false
1356         }
1357       ],
1358       "returns" : []
1359     },
1360     {
1361       "name" : "addEvents",
1362       "type" : "function",
1363       "desc" : "Used to define events on this Observable",
1364       "sig" : "(object)",
1365       "static" : false,
1366       "memberOf" : "Roo.util.Observable",
1367       "isStatic" : false,
1368       "isConstructor" : false,
1369       "isPrivate" : false,
1370       "example" : "",
1371       "deprecated" : "",
1372       "since" : "",
1373       "see" : "",
1374       "exceptions" : "",
1375       "requires" : "",
1376       "params" : [
1377         {
1378           "name" : "object",
1379           "type" : "Object",
1380           "desc" : "The object with the events defined",
1381           "isOptional" : false
1382         }
1383       ],
1384       "returns" : []
1385     },
1386     {
1387       "name" : "releaseCapture",
1388       "type" : "function",
1389       "desc" : "Removes <b>all</b> added captures from the Observable.",
1390       "sig" : "(o)",
1391       "static" : true,
1392       "memberOf" : "Roo.util.Observable",
1393       "isStatic" : true,
1394       "isConstructor" : false,
1395       "isPrivate" : false,
1396       "example" : "",
1397       "deprecated" : "",
1398       "since" : "",
1399       "see" : "",
1400       "exceptions" : "",
1401       "requires" : "",
1402       "params" : [
1403         {
1404           "name" : "o",
1405           "type" : "Observable",
1406           "desc" : "The Observable to release",
1407           "isOptional" : false
1408         }
1409       ],
1410       "returns" : []
1411     },
1412     {
1413       "name" : "removeListener",
1414       "type" : "function",
1415       "desc" : "Removes a listener",
1416       "sig" : "(eventName, handler, scope)",
1417       "static" : false,
1418       "memberOf" : "Roo.util.Observable",
1419       "isStatic" : false,
1420       "isConstructor" : false,
1421       "isPrivate" : false,
1422       "example" : "",
1423       "deprecated" : "",
1424       "since" : "",
1425       "see" : "",
1426       "exceptions" : "",
1427       "requires" : "",
1428       "params" : [
1429         {
1430           "name" : "eventName",
1431           "type" : "String",
1432           "desc" : "The type of event to listen for",
1433           "isOptional" : false
1434         },
1435         {
1436           "name" : "handler",
1437           "type" : "Function",
1438           "desc" : "The handler to remove",
1439           "isOptional" : false
1440         },
1441         {
1442           "name" : "scope",
1443           "type" : "Object",
1444           "desc" : "(optional) The scope (this object) for the handler",
1445           "isOptional" : false
1446         }
1447       ],
1448       "returns" : []
1449     },
1450     {
1451       "name" : "fireEvent",
1452       "type" : "function",
1453       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
1454       "sig" : "(eventName, args)",
1455       "static" : false,
1456       "memberOf" : "Roo.util.Observable",
1457       "isStatic" : false,
1458       "isConstructor" : false,
1459       "isPrivate" : false,
1460       "example" : "",
1461       "deprecated" : "",
1462       "since" : "",
1463       "see" : "",
1464       "exceptions" : "",
1465       "requires" : "",
1466       "params" : [
1467         {
1468           "name" : "eventName",
1469           "type" : "String",
1470           "desc" : "",
1471           "isOptional" : false
1472         },
1473         {
1474           "name" : "args",
1475           "type" : "Object...",
1476           "desc" : "Variable number of parameters are passed to handlers",
1477           "isOptional" : false
1478         }
1479       ],
1480       "returns" : [
1481         {
1482           "name" : "",
1483           "type" : "Boolean",
1484           "desc" : "returns false if any of the handlers return false otherwise it returns true"
1485         }
1486       ]
1487     },
1488     {
1489       "name" : "hasListener",
1490       "type" : "function",
1491       "desc" : "Checks to see if this object has any listeners for a specified event",
1492       "sig" : "(eventName)",
1493       "static" : false,
1494       "memberOf" : "Roo.util.Observable",
1495       "isStatic" : false,
1496       "isConstructor" : false,
1497       "isPrivate" : false,
1498       "example" : "",
1499       "deprecated" : "",
1500       "since" : "",
1501       "see" : "",
1502       "exceptions" : "",
1503       "requires" : "",
1504       "params" : [
1505         {
1506           "name" : "eventName",
1507           "type" : "String",
1508           "desc" : "The name of the event to check for",
1509           "isOptional" : false
1510         }
1511       ],
1512       "returns" : [
1513         {
1514           "name" : "",
1515           "type" : "Boolean",
1516           "desc" : "True if the event is being listened for, else false"
1517         }
1518       ]
1519     },
1520     {
1521       "name" : "capture",
1522       "type" : "function",
1523       "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.",
1524       "sig" : "(o, fn, scope)",
1525       "static" : true,
1526       "memberOf" : "Roo.util.Observable",
1527       "isStatic" : true,
1528       "isConstructor" : false,
1529       "isPrivate" : false,
1530       "example" : "",
1531       "deprecated" : "",
1532       "since" : "",
1533       "see" : "",
1534       "exceptions" : "",
1535       "requires" : "",
1536       "params" : [
1537         {
1538           "name" : "o",
1539           "type" : "Observable",
1540           "desc" : "The Observable to capture",
1541           "isOptional" : false
1542         },
1543         {
1544           "name" : "fn",
1545           "type" : "Function",
1546           "desc" : "The function to call",
1547           "isOptional" : false
1548         },
1549         {
1550           "name" : "scope",
1551           "type" : "Object",
1552           "desc" : "(optional) The scope (this object) for the fn",
1553           "isOptional" : false
1554         }
1555       ],
1556       "returns" : []
1557     },
1558     {
1559       "name" : "addListener",
1560       "type" : "function",
1561       "desc" : "Appends an event handler to this component",
1562       "sig" : "(eventName, handler, scope, options)",
1563       "static" : false,
1564       "memberOf" : "Roo.util.Observable",
1565       "isStatic" : false,
1566       "isConstructor" : false,
1567       "isPrivate" : false,
1568       "example" : "",
1569       "deprecated" : "",
1570       "since" : "",
1571       "see" : "",
1572       "exceptions" : "",
1573       "requires" : "",
1574       "params" : [
1575         {
1576           "name" : "eventName",
1577           "type" : "String",
1578           "desc" : "The type of event to listen for",
1579           "isOptional" : false
1580         },
1581         {
1582           "name" : "handler",
1583           "type" : "Function",
1584           "desc" : "The method the event invokes",
1585           "isOptional" : false
1586         },
1587         {
1588           "name" : "scope",
1589           "type" : "Object",
1590           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1591           "isOptional" : false
1592         },
1593         {
1594           "name" : "options",
1595           "type" : "Object",
1596           "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>",
1597           "isOptional" : false
1598         }
1599       ],
1600       "returns" : []
1601     }
1602   ],
1603   "events" : [
1604     {
1605       "name" : "check",
1606       "type" : "function",
1607       "desc" : "Fires when the checkbox is checked or unchecked.",
1608       "sig" : "function (_self, checked)\n{\n\n}",
1609       "memberOf" : "Roo.form.Checkbox",
1610       "example" : "",
1611       "deprecated" : "",
1612       "since" : "",
1613       "see" : "",
1614       "params" : [
1615         {
1616           "name" : "this",
1617           "type" : "Roo.form.Checkbox",
1618           "desc" : "This checkbox",
1619           "isOptional" : false
1620         },
1621         {
1622           "name" : "checked",
1623           "type" : "Boolean",
1624           "desc" : "The new checked value",
1625           "isOptional" : false
1626         }
1627       ],
1628       "returns" : []
1629     },
1630     {
1631       "name" : "blur",
1632       "type" : "function",
1633       "desc" : "Fires when this field loses input focus.",
1634       "sig" : "function (_self)\n{\n\n}",
1635       "memberOf" : "Roo.form.Field",
1636       "example" : "",
1637       "deprecated" : "",
1638       "since" : "",
1639       "see" : "",
1640       "params" : [
1641         {
1642           "name" : "this",
1643           "type" : "Roo.form.Field",
1644           "desc" : "",
1645           "isOptional" : false
1646         }
1647       ],
1648       "returns" : []
1649     },
1650     {
1651       "name" : "valid",
1652       "type" : "function",
1653       "desc" : "Fires after the field has been validated with no errors.",
1654       "sig" : "function (_self)\n{\n\n}",
1655       "memberOf" : "Roo.form.Field",
1656       "example" : "",
1657       "deprecated" : "",
1658       "since" : "",
1659       "see" : "",
1660       "params" : [
1661         {
1662           "name" : "this",
1663           "type" : "Roo.form.Field",
1664           "desc" : "",
1665           "isOptional" : false
1666         }
1667       ],
1668       "returns" : []
1669     },
1670     {
1671       "name" : "specialkey",
1672       "type" : "function",
1673       "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed.  You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
1674       "sig" : "function (_self, e)\n{\n\n}",
1675       "memberOf" : "Roo.form.Field",
1676       "example" : "",
1677       "deprecated" : "",
1678       "since" : "",
1679       "see" : "",
1680       "params" : [
1681         {
1682           "name" : "this",
1683           "type" : "Roo.form.Field",
1684           "desc" : "",
1685           "isOptional" : false
1686         },
1687         {
1688           "name" : "e",
1689           "type" : "Roo.EventObject",
1690           "desc" : "The event object",
1691           "isOptional" : false
1692         }
1693       ],
1694       "returns" : []
1695     },
1696     {
1697       "name" : "focus",
1698       "type" : "function",
1699       "desc" : "Fires when this field receives input focus.",
1700       "sig" : "function (_self)\n{\n\n}",
1701       "memberOf" : "Roo.form.Field",
1702       "example" : "",
1703       "deprecated" : "",
1704       "since" : "",
1705       "see" : "",
1706       "params" : [
1707         {
1708           "name" : "this",
1709           "type" : "Roo.form.Field",
1710           "desc" : "",
1711           "isOptional" : false
1712         }
1713       ],
1714       "returns" : []
1715     },
1716     {
1717       "name" : "keyup",
1718       "type" : "function",
1719       "desc" : "Fires after the key up",
1720       "sig" : "function (_self, e)\n{\n\n}",
1721       "memberOf" : "Roo.form.Field",
1722       "example" : "",
1723       "deprecated" : "",
1724       "since" : "",
1725       "see" : "",
1726       "params" : [
1727         {
1728           "name" : "this",
1729           "type" : "Roo.form.Field",
1730           "desc" : "",
1731           "isOptional" : false
1732         },
1733         {
1734           "name" : "e",
1735           "type" : "Roo.EventObject",
1736           "desc" : "The event Object",
1737           "isOptional" : false
1738         }
1739       ],
1740       "returns" : []
1741     },
1742     {
1743       "name" : "invalid",
1744       "type" : "function",
1745       "desc" : "Fires after the field has been marked as invalid.",
1746       "sig" : "function (_self, msg)\n{\n\n}",
1747       "memberOf" : "Roo.form.Field",
1748       "example" : "",
1749       "deprecated" : "",
1750       "since" : "",
1751       "see" : "",
1752       "params" : [
1753         {
1754           "name" : "this",
1755           "type" : "Roo.form.Field",
1756           "desc" : "",
1757           "isOptional" : false
1758         },
1759         {
1760           "name" : "msg",
1761           "type" : "String",
1762           "desc" : "The validation message",
1763           "isOptional" : false
1764         }
1765       ],
1766       "returns" : []
1767     },
1768     {
1769       "name" : "change",
1770       "type" : "function",
1771       "desc" : "Fires just before the field blurs if the field value has changed.",
1772       "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
1773       "memberOf" : "Roo.form.Field",
1774       "example" : "",
1775       "deprecated" : "",
1776       "since" : "",
1777       "see" : "",
1778       "params" : [
1779         {
1780           "name" : "this",
1781           "type" : "Roo.form.Field",
1782           "desc" : "",
1783           "isOptional" : false
1784         },
1785         {
1786           "name" : "newValue",
1787           "type" : "Mixed",
1788           "desc" : "The new value",
1789           "isOptional" : false
1790         },
1791         {
1792           "name" : "oldValue",
1793           "type" : "Mixed",
1794           "desc" : "The original value",
1795           "isOptional" : false
1796         }
1797       ],
1798       "returns" : []
1799     },
1800     {
1801       "name" : "move",
1802       "type" : "function",
1803       "desc" : "Fires after the component is moved.",
1804       "sig" : "function (_self, x, y)\n{\n\n}",
1805       "memberOf" : "Roo.BoxComponent",
1806       "example" : "",
1807       "deprecated" : "",
1808       "since" : "",
1809       "see" : "",
1810       "params" : [
1811         {
1812           "name" : "this",
1813           "type" : "Roo.Component",
1814           "desc" : "",
1815           "isOptional" : false
1816         },
1817         {
1818           "name" : "x",
1819           "type" : "Number",
1820           "desc" : "The new x position",
1821           "isOptional" : false
1822         },
1823         {
1824           "name" : "y",
1825           "type" : "Number",
1826           "desc" : "The new y position",
1827           "isOptional" : false
1828         }
1829       ],
1830       "returns" : []
1831     },
1832     {
1833       "name" : "resize",
1834       "type" : "function",
1835       "desc" : "Fires after the component is resized.",
1836       "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
1837       "memberOf" : "Roo.BoxComponent",
1838       "example" : "",
1839       "deprecated" : "",
1840       "since" : "",
1841       "see" : "",
1842       "params" : [
1843         {
1844           "name" : "this",
1845           "type" : "Roo.Component",
1846           "desc" : "",
1847           "isOptional" : false
1848         },
1849         {
1850           "name" : "adjWidth",
1851           "type" : "Number",
1852           "desc" : "The box-adjusted width that was set",
1853           "isOptional" : false
1854         },
1855         {
1856           "name" : "adjHeight",
1857           "type" : "Number",
1858           "desc" : "The box-adjusted height that was set",
1859           "isOptional" : false
1860         },
1861         {
1862           "name" : "rawWidth",
1863           "type" : "Number",
1864           "desc" : "The width that was originally specified",
1865           "isOptional" : false
1866         },
1867         {
1868           "name" : "rawHeight",
1869           "type" : "Number",
1870           "desc" : "The height that was originally specified",
1871           "isOptional" : false
1872         }
1873       ],
1874       "returns" : []
1875     },
1876     {
1877       "name" : "beforerender",
1878       "type" : "function",
1879       "desc" : "Fires before the component is rendered. Return false to stop the render.",
1880       "sig" : "function (_self)\n{\n\n}",
1881       "memberOf" : "Roo.Component",
1882       "example" : "",
1883       "deprecated" : "",
1884       "since" : "",
1885       "see" : "",
1886       "params" : [
1887         {
1888           "name" : "this",
1889           "type" : "Roo.Component",
1890           "desc" : "",
1891           "isOptional" : false
1892         }
1893       ],
1894       "returns" : []
1895     },
1896     {
1897       "name" : "disable",
1898       "type" : "function",
1899       "desc" : "Fires after the component is disabled.",
1900       "sig" : "function (_self)\n{\n\n}",
1901       "memberOf" : "Roo.Component",
1902       "example" : "",
1903       "deprecated" : "",
1904       "since" : "",
1905       "see" : "",
1906       "params" : [
1907         {
1908           "name" : "this",
1909           "type" : "Roo.Component",
1910           "desc" : "",
1911           "isOptional" : false
1912         }
1913       ],
1914       "returns" : []
1915     },
1916     {
1917       "name" : "render",
1918       "type" : "function",
1919       "desc" : "Fires after the component is rendered.",
1920       "sig" : "function (_self)\n{\n\n}",
1921       "memberOf" : "Roo.Component",
1922       "example" : "",
1923       "deprecated" : "",
1924       "since" : "",
1925       "see" : "",
1926       "params" : [
1927         {
1928           "name" : "this",
1929           "type" : "Roo.Component",
1930           "desc" : "",
1931           "isOptional" : false
1932         }
1933       ],
1934       "returns" : []
1935     },
1936     {
1937       "name" : "destroy",
1938       "type" : "function",
1939       "desc" : "Fires after the component is destroyed.",
1940       "sig" : "function (_self)\n{\n\n}",
1941       "memberOf" : "Roo.Component",
1942       "example" : "",
1943       "deprecated" : "",
1944       "since" : "",
1945       "see" : "",
1946       "params" : [
1947         {
1948           "name" : "this",
1949           "type" : "Roo.Component",
1950           "desc" : "",
1951           "isOptional" : false
1952         }
1953       ],
1954       "returns" : []
1955     },
1956     {
1957       "name" : "hide",
1958       "type" : "function",
1959       "desc" : "Fires after the component is hidden.",
1960       "sig" : "function (_self)\n{\n\n}",
1961       "memberOf" : "Roo.Component",
1962       "example" : "",
1963       "deprecated" : "",
1964       "since" : "",
1965       "see" : "",
1966       "params" : [
1967         {
1968           "name" : "this",
1969           "type" : "Roo.Component",
1970           "desc" : "",
1971           "isOptional" : false
1972         }
1973       ],
1974       "returns" : []
1975     },
1976     {
1977       "name" : "beforehide",
1978       "type" : "function",
1979       "desc" : "Fires before the component is hidden. Return false to stop the hide.",
1980       "sig" : "function (_self)\n{\n\n}",
1981       "memberOf" : "Roo.Component",
1982       "example" : "",
1983       "deprecated" : "",
1984       "since" : "",
1985       "see" : "",
1986       "params" : [
1987         {
1988           "name" : "this",
1989           "type" : "Roo.Component",
1990           "desc" : "",
1991           "isOptional" : false
1992         }
1993       ],
1994       "returns" : []
1995     },
1996     {
1997       "name" : "show",
1998       "type" : "function",
1999       "desc" : "Fires after the component is shown.",
2000       "sig" : "function (_self)\n{\n\n}",
2001       "memberOf" : "Roo.Component",
2002       "example" : "",
2003       "deprecated" : "",
2004       "since" : "",
2005       "see" : "",
2006       "params" : [
2007         {
2008           "name" : "this",
2009           "type" : "Roo.Component",
2010           "desc" : "",
2011           "isOptional" : false
2012         }
2013       ],
2014       "returns" : []
2015     },
2016     {
2017       "name" : "beforeshow",
2018       "type" : "function",
2019       "desc" : "Fires before the component is shown.  Return false to stop the show.",
2020       "sig" : "function (_self)\n{\n\n}",
2021       "memberOf" : "Roo.Component",
2022       "example" : "",
2023       "deprecated" : "",
2024       "since" : "",
2025       "see" : "",
2026       "params" : [
2027         {
2028           "name" : "this",
2029           "type" : "Roo.Component",
2030           "desc" : "",
2031           "isOptional" : false
2032         }
2033       ],
2034       "returns" : []
2035     },
2036     {
2037       "name" : "enable",
2038       "type" : "function",
2039       "desc" : "Fires after the component is enabled.",
2040       "sig" : "function (_self)\n{\n\n}",
2041       "memberOf" : "Roo.Component",
2042       "example" : "",
2043       "deprecated" : "",
2044       "since" : "",
2045       "see" : "",
2046       "params" : [
2047         {
2048           "name" : "this",
2049           "type" : "Roo.Component",
2050           "desc" : "",
2051           "isOptional" : false
2052         }
2053       ],
2054       "returns" : []
2055     },
2056     {
2057       "name" : "beforedestroy",
2058       "type" : "function",
2059       "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
2060       "sig" : "function (_self)\n{\n\n}",
2061       "memberOf" : "Roo.Component",
2062       "example" : "",
2063       "deprecated" : "",
2064       "since" : "",
2065       "see" : "",
2066       "params" : [
2067         {
2068           "name" : "this",
2069           "type" : "Roo.Component",
2070           "desc" : "",
2071           "isOptional" : false
2072         }
2073       ],
2074       "returns" : []
2075     }
2076   ]
2077 }