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

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