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