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

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