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

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