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