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