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