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