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