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

   1 {
   2   "name" : "Roo.HtmlEditorCore",
   3   "augments" : [
   4     "Roo.Component",
   5     "Roo.util.Observable"
   6   ],
   7   "childClasses" : {  },
   8   "tree_children" : [],
   9   "tree_parent" : [],
  10   "desc" : "Provides a the editing component for the HTML editors in Roo. (bootstrap and Roo.form)\n\nany element that has display set to 'none' can cause problems in Safari and Firefox.<br/><br/>",
  11   "isSingleton" : false,
  12   "isStatic" : false,
  13   "isBuiltin" : false,
  14   "isAbstract" : false,
  15   "isBuilderTop" : false,
  16   "memberOf" : "HtmlEditorCore",
  17   "example" : "",
  18   "deprecated" : "",
  19   "since" : "",
  20   "see" : "",
  21   "params" : [],
  22   "returns" : [],
  23   "throws" : "",
  24   "requires" : "",
  25   "config" : [
  26     {
  27       "name" : "listeners",
  28       "type" : "Object",
  29       "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>",
  30       "memberOf" : "Roo.util.Observable",
  31       "isOptional" : false,
  32       "optvals" : []
  33     },
  34     {
  35       "name" : "allowComments",
  36       "type" : "boolean",
  37       "desc" : "- default false - allow comments in HTML source\n         - by default they are stripped - if you are editing email you may need this.",
  38       "memberOf" : "",
  39       "isOptional" : false,
  40       "optvals" : []
  41     },
  42     {
  43       "name" : "autoClean",
  44       "type" : "boolean",
  45       "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",
  46       "memberOf" : "",
  47       "isOptional" : false,
  48       "optvals" : []
  49     },
  50     {
  51       "name" : "the",
  52       "type" : "Roo.form.HtmlEditor|Roo.bootstrap.HtmlEditor",
  53       "desc" : "owner field",
  54       "memberOf" : "",
  55       "isOptional" : false,
  56       "optvals" : []
  57     },
  58     {
  59       "name" : "hideMode",
  60       "type" : "String",
  61       "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",
  62       "memberOf" : "Roo.Component",
  63       "isOptional" : false,
  64       "optvals" : [
  65         "display",
  66         "visibility"
  67       ]
  68     },
  69     {
  70       "name" : "style",
  71       "type" : "String",
  72       "desc" : "css styles to add to component\neg. text-align:right;",
  73       "memberOf" : "Roo.Component",
  74       "isOptional" : false,
  75       "optvals" : []
  76     },
  77     {
  78       "name" : "allowDomMove",
  79       "type" : "Boolean",
  80       "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
  81       "memberOf" : "Roo.Component",
  82       "isOptional" : false,
  83       "optvals" : []
  84     },
  85     {
  86       "name" : "language",
  87       "type" : "String",
  88       "desc" : "default en - language of text (usefull for rtl languages)",
  89       "memberOf" : "",
  90       "isOptional" : false,
  91       "optvals" : []
  92     },
  93     {
  94       "name" : "css",
  95       "type" : "String",
  96       "desc" : "styling for resizing. (used on bootstrap only)",
  97       "memberOf" : "",
  98       "isOptional" : false,
  99       "optvals" : []
 100     },
 101     {
 102       "name" : "enableBlocks",
 103       "type" : "boolean",
 104       "desc" : "- default true - if the block editor (table and figure should be enabled)",
 105       "memberOf" : "",
 106       "isOptional" : false,
 107       "optvals" : []
 108     },
 109     {
 110       "name" : "actionMode",
 111       "type" : "String",
 112       "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",
 113       "memberOf" : "Roo.Component",
 114       "isOptional" : false,
 115       "optvals" : []
 116     },
 117     {
 118       "name" : "width",
 119       "type" : "Number",
 120       "desc" : "(in pixels)",
 121       "memberOf" : "",
 122       "isOptional" : false,
 123       "optvals" : []
 124     },
 125     {
 126       "name" : "height",
 127       "type" : "Number",
 128       "desc" : "(in pixels)",
 129       "memberOf" : "",
 130       "isOptional" : false,
 131       "optvals" : []
 132     },
 133     {
 134       "name" : "disableClass",
 135       "type" : "String",
 136       "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
 137       "memberOf" : "Roo.Component",
 138       "isOptional" : false,
 139       "optvals" : []
 140     },
 141     {
 142       "name" : "stylesheets",
 143       "type" : "Array",
 144       "desc" : "url of stylesheets. set to [] to disable stylesheets.",
 145       "memberOf" : "",
 146       "isOptional" : false,
 147       "optvals" : []
 148     }
 149   ],
 150   "methods" : [
 151     {
 152       "name" : "relayCmd",
 153       "type" : "function",
 154       "desc" : "Executes a Midas editor command on the editor document and performs necessary focus and\ntoolbar updates. <b>This should only be called after the editor is initialized.</b>",
 155       "sig" : "(cmd, value)",
 156       "static" : false,
 157       "memberOf" : "",
 158       "isStatic" : false,
 159       "isConstructor" : false,
 160       "isPrivate" : false,
 161       "example" : "",
 162       "deprecated" : "",
 163       "since" : "",
 164       "see" : "",
 165       "exceptions" : "",
 166       "requires" : "",
 167       "params" : [
 168         {
 169           "name" : "cmd",
 170           "type" : "String",
 171           "desc" : "The Midas command",
 172           "isOptional" : false
 173         },
 174         {
 175           "name" : "value",
 176           "type" : "String/Boolean",
 177           "desc" : "(optional) The value to pass to the command (defaults to null)",
 178           "isOptional" : false
 179         }
 180       ],
 181       "returns" : []
 182     },
 183     {
 184       "name" : "selectNode",
 185       "type" : "function",
 186       "desc" : "Select a dom node",
 187       "sig" : "(node)",
 188       "static" : false,
 189       "memberOf" : "",
 190       "isStatic" : false,
 191       "isConstructor" : false,
 192       "isPrivate" : false,
 193       "example" : "",
 194       "deprecated" : "",
 195       "since" : "",
 196       "see" : "",
 197       "exceptions" : "",
 198       "requires" : "",
 199       "params" : [
 200         {
 201           "name" : "node",
 202           "type" : "DomElement",
 203           "desc" : "the node to select",
 204           "isOptional" : false
 205         }
 206       ],
 207       "returns" : []
 208     },
 209     {
 210       "name" : "execCmd",
 211       "type" : "function",
 212       "desc" : "Executes a Midas editor command directly on the editor document.\nFor visual commands, you should use {@link #relayCmd} instead.\n<b>This should only be called after the editor is initialized.</b>",
 213       "sig" : "(cmd, value)",
 214       "static" : false,
 215       "memberOf" : "",
 216       "isStatic" : false,
 217       "isConstructor" : false,
 218       "isPrivate" : false,
 219       "example" : "",
 220       "deprecated" : "",
 221       "since" : "",
 222       "see" : "",
 223       "exceptions" : "",
 224       "requires" : "",
 225       "params" : [
 226         {
 227           "name" : "cmd",
 228           "type" : "String",
 229           "desc" : "The Midas command",
 230           "isOptional" : false
 231         },
 232         {
 233           "name" : "value",
 234           "type" : "String/Boolean",
 235           "desc" : "(optional) The value to pass to the command (defaults to null)",
 236           "isOptional" : false
 237         }
 238       ],
 239       "returns" : []
 240     },
 241     {
 242       "name" : "cleanWord",
 243       "type" : "function",
 244       "desc" : "Clean up MS wordisms...",
 245       "sig" : "()\n{\n\n}",
 246       "static" : false,
 247       "memberOf" : "",
 248       "isStatic" : false,
 249       "isConstructor" : false,
 250       "isPrivate" : false,
 251       "example" : "",
 252       "deprecated" : "This has been deprecated: - use filter directly",
 253       "since" : "",
 254       "see" : "",
 255       "exceptions" : "",
 256       "requires" : "",
 257       "params" : [],
 258       "returns" : []
 259     },
 260     {
 261       "name" : "syncValue",
 262       "type" : "function",
 263       "desc" : "HTML Editor -> Textarea\nProtected method that will not generally be called directly. Syncs the contents\nof the editor iframe with the textarea.",
 264       "sig" : "()\n{\n\n}",
 265       "static" : false,
 266       "memberOf" : "",
 267       "isStatic" : false,
 268       "isConstructor" : false,
 269       "isPrivate" : false,
 270       "example" : "",
 271       "deprecated" : "",
 272       "since" : "",
 273       "see" : "",
 274       "exceptions" : "",
 275       "requires" : "",
 276       "params" : [],
 277       "returns" : []
 278     },
 279     {
 280       "name" : "cleanTableWidths",
 281       "type" : "function",
 282       "desc" : "",
 283       "sig" : "()\n{\n\n}",
 284       "static" : false,
 285       "memberOf" : "",
 286       "isStatic" : false,
 287       "isConstructor" : false,
 288       "isPrivate" : false,
 289       "example" : "",
 290       "deprecated" : "This has been deprecated: - use filters",
 291       "since" : "",
 292       "see" : "",
 293       "exceptions" : "",
 294       "requires" : "",
 295       "params" : [],
 296       "returns" : []
 297     },
 298     {
 299       "name" : "cleanHtml",
 300       "type" : "function",
 301       "desc" : "Protected method that will not generally be called directly. If you need/want\ncustom HTML cleanup, this is the method you should override.",
 302       "sig" : "(html)",
 303       "static" : false,
 304       "memberOf" : "",
 305       "isStatic" : false,
 306       "isConstructor" : false,
 307       "isPrivate" : false,
 308       "example" : "",
 309       "deprecated" : "",
 310       "since" : "",
 311       "see" : "",
 312       "exceptions" : "",
 313       "requires" : "",
 314       "params" : [
 315         {
 316           "name" : "html",
 317           "type" : "String",
 318           "desc" : "The HTML to be cleaned\nreturn {String} The cleaned HTML",
 319           "isOptional" : false
 320         }
 321       ],
 322       "returns" : []
 323     },
 324     {
 325       "name" : "toggleSourceEdit",
 326       "type" : "function",
 327       "desc" : "Toggles the editor between standard and source edit mode.",
 328       "sig" : "(sourceEdit)",
 329       "static" : false,
 330       "memberOf" : "",
 331       "isStatic" : false,
 332       "isConstructor" : false,
 333       "isPrivate" : false,
 334       "example" : "",
 335       "deprecated" : "",
 336       "since" : "",
 337       "see" : "",
 338       "exceptions" : "",
 339       "requires" : "",
 340       "params" : [
 341         {
 342           "name" : "sourceEdit",
 343           "type" : "Boolean",
 344           "desc" : "(optional) True for source edit, false for standard",
 345           "isOptional" : false
 346         }
 347       ],
 348       "returns" : []
 349     },
 350     {
 351       "name" : "getDocMarkup",
 352       "type" : "function",
 353       "desc" : "Protected method that will not generally be called directly. It\nis called when the editor initializes the iframe with HTML contents. Override this method if you\nwant to change the initialization markup of the iframe (e.g. to add stylesheets).",
 354       "sig" : "()\n{\n\n}",
 355       "static" : false,
 356       "memberOf" : "",
 357       "isStatic" : false,
 358       "isConstructor" : false,
 359       "isPrivate" : false,
 360       "example" : "",
 361       "deprecated" : "",
 362       "since" : "",
 363       "see" : "",
 364       "exceptions" : "",
 365       "requires" : "",
 366       "params" : [],
 367       "returns" : []
 368     },
 369     {
 370       "name" : "pushValue",
 371       "type" : "function",
 372       "desc" : "TEXTAREA -> EDITABLE\nProtected method that will not generally be called directly. Pushes the value of the textarea\ninto the iframe editor.",
 373       "sig" : "()\n{\n\n}",
 374       "static" : false,
 375       "memberOf" : "",
 376       "isStatic" : false,
 377       "isConstructor" : false,
 378       "isPrivate" : false,
 379       "example" : "",
 380       "deprecated" : "",
 381       "since" : "",
 382       "see" : "",
 383       "exceptions" : "",
 384       "requires" : "",
 385       "params" : [],
 386       "returns" : []
 387     },
 388     {
 389       "name" : "rangeIntersectsNode",
 390       "type" : "function",
 391       "desc" : "Range intersection.. the hard stuff...\n '-1' = before\n '0' = hits..\n '1' = after.\n        [ -- selected range --- ]\n  [fail]                        [fail]\n\n   basically..\n     if end is before start or  hits it. fail.\n     if start is after end or hits it fail.\n\n  if either hits (but other is outside. - then it's not",
 392       "sig" : "()\n{\n\n}",
 393       "static" : false,
 394       "memberOf" : "",
 395       "isStatic" : false,
 396       "isConstructor" : false,
 397       "isPrivate" : false,
 398       "example" : "",
 399       "deprecated" : "",
 400       "since" : "",
 401       "see" : "",
 402       "exceptions" : "",
 403       "requires" : "",
 404       "params" : [],
 405       "returns" : []
 406     },
 407     {
 408       "name" : "insertAtCursor",
 409       "type" : "function",
 410       "desc" : "Inserts the passed text at the current cursor position. Note: the editor must be initialized and activated\nto insert tRoo.",
 411       "sig" : "(text)",
 412       "static" : false,
 413       "memberOf" : "",
 414       "isStatic" : false,
 415       "isConstructor" : false,
 416       "isPrivate" : false,
 417       "example" : "",
 418       "deprecated" : "",
 419       "since" : "",
 420       "see" : "",
 421       "exceptions" : "",
 422       "requires" : "",
 423       "params" : [
 424         {
 425           "name" : "text",
 426           "type" : "String",
 427           "desc" : "| dom node..",
 428           "isOptional" : false
 429         }
 430       ],
 431       "returns" : []
 432     },
 433     {
 434       "name" : "getId",
 435       "type" : "function",
 436       "desc" : "Returns the id of this component.",
 437       "sig" : "()\n{\n\n}",
 438       "static" : false,
 439       "memberOf" : "Roo.Component",
 440       "isStatic" : false,
 441       "isConstructor" : false,
 442       "isPrivate" : false,
 443       "example" : "",
 444       "deprecated" : "",
 445       "since" : "",
 446       "see" : "",
 447       "exceptions" : "",
 448       "requires" : "",
 449       "params" : [],
 450       "returns" : [
 451         {
 452           "name" : "",
 453           "type" : "String",
 454           "desc" : ""
 455         }
 456       ]
 457     },
 458     {
 459       "name" : "render",
 460       "type" : "function",
 461       "desc" : "If this is a lazy rendering component, render it to its container element.",
 462       "sig" : "(container)",
 463       "static" : false,
 464       "memberOf" : "Roo.Component",
 465       "isStatic" : false,
 466       "isConstructor" : false,
 467       "isPrivate" : false,
 468       "example" : "",
 469       "deprecated" : "",
 470       "since" : "",
 471       "see" : "",
 472       "exceptions" : "",
 473       "requires" : "",
 474       "params" : [
 475         {
 476           "name" : "container",
 477           "type" : "String/HTMLElement/Element",
 478           "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
 479           "isOptional" : false
 480         }
 481       ],
 482       "returns" : []
 483     },
 484     {
 485       "name" : "destroy",
 486       "type" : "function",
 487       "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}.",
 488       "sig" : "()\n{\n\n}",
 489       "static" : false,
 490       "memberOf" : "Roo.Component",
 491       "isStatic" : false,
 492       "isConstructor" : false,
 493       "isPrivate" : false,
 494       "example" : "",
 495       "deprecated" : "",
 496       "since" : "",
 497       "see" : "",
 498       "exceptions" : "",
 499       "requires" : "",
 500       "params" : [],
 501       "returns" : []
 502     },
 503     {
 504       "name" : "isVisible",
 505       "type" : "function",
 506       "desc" : "Returns true if this component is visible.",
 507       "sig" : "()\n{\n\n}",
 508       "static" : false,
 509       "memberOf" : "Roo.Component",
 510       "isStatic" : false,
 511       "isConstructor" : false,
 512       "isPrivate" : false,
 513       "example" : "",
 514       "deprecated" : "",
 515       "since" : "",
 516       "see" : "",
 517       "exceptions" : "",
 518       "requires" : "",
 519       "params" : [],
 520       "returns" : []
 521     },
 522     {
 523       "name" : "setDisabled",
 524       "type" : "function",
 525       "desc" : "Convenience function for setting disabled/enabled by boolean.",
 526       "sig" : "(disabled)",
 527       "static" : false,
 528       "memberOf" : "Roo.Component",
 529       "isStatic" : false,
 530       "isConstructor" : false,
 531       "isPrivate" : false,
 532       "example" : "",
 533       "deprecated" : "",
 534       "since" : "",
 535       "see" : "",
 536       "exceptions" : "",
 537       "requires" : "",
 538       "params" : [
 539         {
 540           "name" : "disabled",
 541           "type" : "Boolean",
 542           "desc" : "",
 543           "isOptional" : false
 544         }
 545       ],
 546       "returns" : []
 547     },
 548     {
 549       "name" : "hide",
 550       "type" : "function",
 551       "desc" : "Hide this component.",
 552       "sig" : "()\n{\n\n}",
 553       "static" : false,
 554       "memberOf" : "Roo.Component",
 555       "isStatic" : false,
 556       "isConstructor" : false,
 557       "isPrivate" : false,
 558       "example" : "",
 559       "deprecated" : "",
 560       "since" : "",
 561       "see" : "",
 562       "exceptions" : "",
 563       "requires" : "",
 564       "params" : [],
 565       "returns" : [
 566         {
 567           "name" : "",
 568           "type" : "Roo.Component",
 569           "desc" : "this"
 570         }
 571       ]
 572     },
 573     {
 574       "name" : "focus",
 575       "type" : "function",
 576       "desc" : "Try to focus this component.",
 577       "sig" : "(selectText)",
 578       "static" : false,
 579       "memberOf" : "Roo.Component",
 580       "isStatic" : false,
 581       "isConstructor" : false,
 582       "isPrivate" : false,
 583       "example" : "",
 584       "deprecated" : "",
 585       "since" : "",
 586       "see" : "",
 587       "exceptions" : "",
 588       "requires" : "",
 589       "params" : [
 590         {
 591           "name" : "selectText",
 592           "type" : "Boolean",
 593           "desc" : "True to also select the text in this component (if applicable)",
 594           "isOptional" : false
 595         }
 596       ],
 597       "returns" : [
 598         {
 599           "name" : "",
 600           "type" : "Roo.Component",
 601           "desc" : "this"
 602         }
 603       ]
 604     },
 605     {
 606       "name" : "show",
 607       "type" : "function",
 608       "desc" : "Show this component.",
 609       "sig" : "()\n{\n\n}",
 610       "static" : false,
 611       "memberOf" : "Roo.Component",
 612       "isStatic" : false,
 613       "isConstructor" : false,
 614       "isPrivate" : false,
 615       "example" : "",
 616       "deprecated" : "",
 617       "since" : "",
 618       "see" : "",
 619       "exceptions" : "",
 620       "requires" : "",
 621       "params" : [],
 622       "returns" : [
 623         {
 624           "name" : "",
 625           "type" : "Roo.Component",
 626           "desc" : "this"
 627         }
 628       ]
 629     },
 630     {
 631       "name" : "enable",
 632       "type" : "function",
 633       "desc" : "Enable this component.",
 634       "sig" : "()\n{\n\n}",
 635       "static" : false,
 636       "memberOf" : "Roo.Component",
 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           "name" : "",
 650           "type" : "Roo.Component",
 651           "desc" : "this"
 652         }
 653       ]
 654     },
 655     {
 656       "name" : "setVisible",
 657       "type" : "function",
 658       "desc" : "Convenience function to hide or show this component by boolean.",
 659       "sig" : "(visible)",
 660       "static" : false,
 661       "memberOf" : "Roo.Component",
 662       "isStatic" : false,
 663       "isConstructor" : false,
 664       "isPrivate" : false,
 665       "example" : "",
 666       "deprecated" : "",
 667       "since" : "",
 668       "see" : "",
 669       "exceptions" : "",
 670       "requires" : "",
 671       "params" : [
 672         {
 673           "name" : "visible",
 674           "type" : "Boolean",
 675           "desc" : "True to show, false to hide",
 676           "isOptional" : false
 677         }
 678       ],
 679       "returns" : [
 680         {
 681           "name" : "",
 682           "type" : "Roo.Component",
 683           "desc" : "this"
 684         }
 685       ]
 686     },
 687     {
 688       "name" : "disable",
 689       "type" : "function",
 690       "desc" : "Disable this component.",
 691       "sig" : "()\n{\n\n}",
 692       "static" : false,
 693       "memberOf" : "Roo.Component",
 694       "isStatic" : false,
 695       "isConstructor" : false,
 696       "isPrivate" : false,
 697       "example" : "",
 698       "deprecated" : "",
 699       "since" : "",
 700       "see" : "",
 701       "exceptions" : "",
 702       "requires" : "",
 703       "params" : [],
 704       "returns" : [
 705         {
 706           "name" : "",
 707           "type" : "Roo.Component",
 708           "desc" : "this"
 709         }
 710       ]
 711     },
 712     {
 713       "name" : "getEl",
 714       "type" : "function",
 715       "desc" : "Returns the underlying {@link Roo.Element}.",
 716       "sig" : "()\n{\n\n}",
 717       "static" : false,
 718       "memberOf" : "Roo.Component",
 719       "isStatic" : false,
 720       "isConstructor" : false,
 721       "isPrivate" : false,
 722       "example" : "",
 723       "deprecated" : "",
 724       "since" : "",
 725       "see" : "",
 726       "exceptions" : "",
 727       "requires" : "",
 728       "params" : [],
 729       "returns" : [
 730         {
 731           "name" : "",
 732           "type" : "Roo.Element",
 733           "desc" : "The element"
 734         }
 735       ]
 736     },
 737     {
 738       "name" : "purgeListeners",
 739       "type" : "function",
 740       "desc" : "Removes all listeners for this object",
 741       "sig" : "()\n{\n\n}",
 742       "static" : false,
 743       "memberOf" : "Roo.util.Observable",
 744       "isStatic" : false,
 745       "isConstructor" : false,
 746       "isPrivate" : false,
 747       "example" : "",
 748       "deprecated" : "",
 749       "since" : "",
 750       "see" : "",
 751       "exceptions" : "",
 752       "requires" : "",
 753       "params" : [],
 754       "returns" : []
 755     },
 756     {
 757       "name" : "on",
 758       "type" : "function",
 759       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 760       "sig" : "(eventName, handler, scope, options)",
 761       "static" : false,
 762       "memberOf" : "Roo.util.Observable",
 763       "isStatic" : false,
 764       "isConstructor" : false,
 765       "isPrivate" : false,
 766       "example" : "",
 767       "deprecated" : "",
 768       "since" : "",
 769       "see" : "",
 770       "exceptions" : "",
 771       "requires" : "",
 772       "params" : [
 773         {
 774           "name" : "eventName",
 775           "type" : "String",
 776           "desc" : "The type of event to listen for",
 777           "isOptional" : false
 778         },
 779         {
 780           "name" : "handler",
 781           "type" : "Function",
 782           "desc" : "The method the event invokes",
 783           "isOptional" : false
 784         },
 785         {
 786           "name" : "scope",
 787           "type" : "Object",
 788           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 789           "isOptional" : false
 790         },
 791         {
 792           "name" : "options",
 793           "type" : "Object",
 794           "desc" : "(optional)",
 795           "isOptional" : false
 796         }
 797       ],
 798       "returns" : []
 799     },
 800     {
 801       "name" : "un",
 802       "type" : "function",
 803       "desc" : "Removes a listener (shorthand for removeListener)",
 804       "sig" : "(eventName, handler, scope)",
 805       "static" : false,
 806       "memberOf" : "Roo.util.Observable",
 807       "isStatic" : false,
 808       "isConstructor" : false,
 809       "isPrivate" : false,
 810       "example" : "",
 811       "deprecated" : "",
 812       "since" : "",
 813       "see" : "",
 814       "exceptions" : "",
 815       "requires" : "",
 816       "params" : [
 817         {
 818           "name" : "eventName",
 819           "type" : "String",
 820           "desc" : "The type of event to listen for",
 821           "isOptional" : false
 822         },
 823         {
 824           "name" : "handler",
 825           "type" : "Function",
 826           "desc" : "The handler to remove",
 827           "isOptional" : false
 828         },
 829         {
 830           "name" : "scope",
 831           "type" : "Object",
 832           "desc" : "(optional) The scope (this object) for the handler",
 833           "isOptional" : false
 834         }
 835       ],
 836       "returns" : []
 837     },
 838     {
 839       "name" : "addEvents",
 840       "type" : "function",
 841       "desc" : "Used to define events on this Observable",
 842       "sig" : "(object)",
 843       "static" : false,
 844       "memberOf" : "Roo.util.Observable",
 845       "isStatic" : false,
 846       "isConstructor" : false,
 847       "isPrivate" : false,
 848       "example" : "",
 849       "deprecated" : "",
 850       "since" : "",
 851       "see" : "",
 852       "exceptions" : "",
 853       "requires" : "",
 854       "params" : [
 855         {
 856           "name" : "object",
 857           "type" : "Object",
 858           "desc" : "The object with the events defined",
 859           "isOptional" : false
 860         }
 861       ],
 862       "returns" : []
 863     },
 864     {
 865       "name" : "releaseCapture",
 866       "type" : "function",
 867       "desc" : "Removes <b>all</b> added captures from the Observable.",
 868       "sig" : "(o)",
 869       "static" : true,
 870       "memberOf" : "Roo.util.Observable",
 871       "isStatic" : true,
 872       "isConstructor" : false,
 873       "isPrivate" : false,
 874       "example" : "",
 875       "deprecated" : "",
 876       "since" : "",
 877       "see" : "",
 878       "exceptions" : "",
 879       "requires" : "",
 880       "params" : [
 881         {
 882           "name" : "o",
 883           "type" : "Observable",
 884           "desc" : "The Observable to release",
 885           "isOptional" : false
 886         }
 887       ],
 888       "returns" : []
 889     },
 890     {
 891       "name" : "removeListener",
 892       "type" : "function",
 893       "desc" : "Removes a listener",
 894       "sig" : "(eventName, handler, scope)",
 895       "static" : false,
 896       "memberOf" : "Roo.util.Observable",
 897       "isStatic" : false,
 898       "isConstructor" : false,
 899       "isPrivate" : false,
 900       "example" : "",
 901       "deprecated" : "",
 902       "since" : "",
 903       "see" : "",
 904       "exceptions" : "",
 905       "requires" : "",
 906       "params" : [
 907         {
 908           "name" : "eventName",
 909           "type" : "String",
 910           "desc" : "The type of event to listen for",
 911           "isOptional" : false
 912         },
 913         {
 914           "name" : "handler",
 915           "type" : "Function",
 916           "desc" : "The handler to remove",
 917           "isOptional" : false
 918         },
 919         {
 920           "name" : "scope",
 921           "type" : "Object",
 922           "desc" : "(optional) The scope (this object) for the handler",
 923           "isOptional" : false
 924         }
 925       ],
 926       "returns" : []
 927     },
 928     {
 929       "name" : "fireEvent",
 930       "type" : "function",
 931       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 932       "sig" : "(eventName, args)",
 933       "static" : false,
 934       "memberOf" : "Roo.util.Observable",
 935       "isStatic" : false,
 936       "isConstructor" : false,
 937       "isPrivate" : false,
 938       "example" : "",
 939       "deprecated" : "",
 940       "since" : "",
 941       "see" : "",
 942       "exceptions" : "",
 943       "requires" : "",
 944       "params" : [
 945         {
 946           "name" : "eventName",
 947           "type" : "String",
 948           "desc" : "",
 949           "isOptional" : false
 950         },
 951         {
 952           "name" : "args",
 953           "type" : "Object...",
 954           "desc" : "Variable number of parameters are passed to handlers",
 955           "isOptional" : false
 956         }
 957       ],
 958       "returns" : [
 959         {
 960           "name" : "",
 961           "type" : "Boolean",
 962           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 963         }
 964       ]
 965     },
 966     {
 967       "name" : "hasListener",
 968       "type" : "function",
 969       "desc" : "Checks to see if this object has any listeners for a specified event",
 970       "sig" : "(eventName)",
 971       "static" : false,
 972       "memberOf" : "Roo.util.Observable",
 973       "isStatic" : false,
 974       "isConstructor" : false,
 975       "isPrivate" : false,
 976       "example" : "",
 977       "deprecated" : "",
 978       "since" : "",
 979       "see" : "",
 980       "exceptions" : "",
 981       "requires" : "",
 982       "params" : [
 983         {
 984           "name" : "eventName",
 985           "type" : "String",
 986           "desc" : "The name of the event to check for",
 987           "isOptional" : false
 988         }
 989       ],
 990       "returns" : [
 991         {
 992           "name" : "",
 993           "type" : "Boolean",
 994           "desc" : "True if the event is being listened for, else false"
 995         }
 996       ]
 997     },
 998     {
 999       "name" : "capture",
1000       "type" : "function",
1001       "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.",
1002       "sig" : "(o, fn, scope)",
1003       "static" : true,
1004       "memberOf" : "Roo.util.Observable",
1005       "isStatic" : true,
1006       "isConstructor" : false,
1007       "isPrivate" : false,
1008       "example" : "",
1009       "deprecated" : "",
1010       "since" : "",
1011       "see" : "",
1012       "exceptions" : "",
1013       "requires" : "",
1014       "params" : [
1015         {
1016           "name" : "o",
1017           "type" : "Observable",
1018           "desc" : "The Observable to capture",
1019           "isOptional" : false
1020         },
1021         {
1022           "name" : "fn",
1023           "type" : "Function",
1024           "desc" : "The function to call",
1025           "isOptional" : false
1026         },
1027         {
1028           "name" : "scope",
1029           "type" : "Object",
1030           "desc" : "(optional) The scope (this object) for the fn",
1031           "isOptional" : false
1032         }
1033       ],
1034       "returns" : []
1035     },
1036     {
1037       "name" : "addListener",
1038       "type" : "function",
1039       "desc" : "Appends an event handler to this component",
1040       "sig" : "(eventName, handler, scope, options)",
1041       "static" : false,
1042       "memberOf" : "Roo.util.Observable",
1043       "isStatic" : false,
1044       "isConstructor" : false,
1045       "isPrivate" : false,
1046       "example" : "",
1047       "deprecated" : "",
1048       "since" : "",
1049       "see" : "",
1050       "exceptions" : "",
1051       "requires" : "",
1052       "params" : [
1053         {
1054           "name" : "eventName",
1055           "type" : "String",
1056           "desc" : "The type of event to listen for",
1057           "isOptional" : false
1058         },
1059         {
1060           "name" : "handler",
1061           "type" : "Function",
1062           "desc" : "The method the event invokes",
1063           "isOptional" : false
1064         },
1065         {
1066           "name" : "scope",
1067           "type" : "Object",
1068           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
1069           "isOptional" : false
1070         },
1071         {
1072           "name" : "options",
1073           "type" : "Object",
1074           "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>",
1075           "isOptional" : false
1076         }
1077       ],
1078       "returns" : []
1079     }
1080   ],
1081   "events" : [
1082     {
1083       "name" : "specialkey",
1084       "type" : "function",
1085       "desc" : "",
1086       "sig" : "function ()\n{\n\n}",
1087       "memberOf" : "",
1088       "example" : "",
1089       "deprecated" : "",
1090       "since" : "",
1091       "see" : "",
1092       "params" : [],
1093       "returns" : []
1094     },
1095     {
1096       "name" : "editorevent",
1097       "type" : "function",
1098       "desc" : "Fires when on any editor (mouse up/down cursor movement etc.) - used for toolbar hooks.",
1099       "sig" : "function (_self)\n{\n\n}",
1100       "memberOf" : "",
1101       "example" : "",
1102       "deprecated" : "",
1103       "since" : "",
1104       "see" : "",
1105       "params" : [
1106         {
1107           "name" : "this",
1108           "type" : "Roo.HtmlEditorCore",
1109           "desc" : "",
1110           "isOptional" : false
1111         }
1112       ],
1113       "returns" : []
1114     },
1115     {
1116       "name" : "beforepush",
1117       "type" : "function",
1118       "desc" : "Fires before the iframe editor is updated with content from the textarea. Return false\nto cancel the push.",
1119       "sig" : "function (_self, html)\n{\n\n}",
1120       "memberOf" : "",
1121       "example" : "",
1122       "deprecated" : "",
1123       "since" : "",
1124       "see" : "",
1125       "params" : [
1126         {
1127           "name" : "this",
1128           "type" : "Roo.HtmlEditorCore",
1129           "desc" : "",
1130           "isOptional" : false
1131         },
1132         {
1133           "name" : "html",
1134           "type" : "String",
1135           "desc" : "",
1136           "isOptional" : false
1137         }
1138       ],
1139       "returns" : []
1140     },
1141     {
1142       "name" : "activate",
1143       "type" : "function",
1144       "desc" : "Fires when the editor is first receives the focus. Any insertion must wait\nuntil after this event.",
1145       "sig" : "function (_self)\n{\n\n}",
1146       "memberOf" : "",
1147       "example" : "",
1148       "deprecated" : "",
1149       "since" : "",
1150       "see" : "",
1151       "params" : [
1152         {
1153           "name" : "this",
1154           "type" : "Roo.HtmlEditorCore",
1155           "desc" : "",
1156           "isOptional" : false
1157         }
1158       ],
1159       "returns" : []
1160     },
1161     {
1162       "name" : "initialize",
1163       "type" : "function",
1164       "desc" : "Fires when the editor is fully initialized (including the iframe)",
1165       "sig" : "function (_self)\n{\n\n}",
1166       "memberOf" : "",
1167       "example" : "",
1168       "deprecated" : "",
1169       "since" : "",
1170       "see" : "",
1171       "params" : [
1172         {
1173           "name" : "this",
1174           "type" : "Roo.HtmlEditorCore",
1175           "desc" : "",
1176           "isOptional" : false
1177         }
1178       ],
1179       "returns" : []
1180     },
1181     {
1182       "name" : "beforesync",
1183       "type" : "function",
1184       "desc" : "Fires before the textarea is updated with content from the editor iframe. Return false\nto cancel the sync.",
1185       "sig" : "function (_self, html)\n{\n\n}",
1186       "memberOf" : "",
1187       "example" : "",
1188       "deprecated" : "",
1189       "since" : "",
1190       "see" : "",
1191       "params" : [
1192         {
1193           "name" : "this",
1194           "type" : "Roo.HtmlEditorCore",
1195           "desc" : "",
1196           "isOptional" : false
1197         },
1198         {
1199           "name" : "html",
1200           "type" : "String",
1201           "desc" : "",
1202           "isOptional" : false
1203         }
1204       ],
1205       "returns" : []
1206     },
1207     {
1208       "name" : "push",
1209       "type" : "function",
1210       "desc" : "Fires when the iframe editor is updated with content from the textarea.",
1211       "sig" : "function (_self, html)\n{\n\n}",
1212       "memberOf" : "",
1213       "example" : "",
1214       "deprecated" : "",
1215       "since" : "",
1216       "see" : "",
1217       "params" : [
1218         {
1219           "name" : "this",
1220           "type" : "Roo.HtmlEditorCore",
1221           "desc" : "",
1222           "isOptional" : false
1223         },
1224         {
1225           "name" : "html",
1226           "type" : "String",
1227           "desc" : "",
1228           "isOptional" : false
1229         }
1230       ],
1231       "returns" : []
1232     },
1233     {
1234       "name" : "sync",
1235       "type" : "function",
1236       "desc" : "Fires when the textarea is updated with content from the editor iframe.",
1237       "sig" : "function (_self, html)\n{\n\n}",
1238       "memberOf" : "",
1239       "example" : "",
1240       "deprecated" : "",
1241       "since" : "",
1242       "see" : "",
1243       "params" : [
1244         {
1245           "name" : "this",
1246           "type" : "Roo.HtmlEditorCore",
1247           "desc" : "",
1248           "isOptional" : false
1249         },
1250         {
1251           "name" : "html",
1252           "type" : "String",
1253           "desc" : "",
1254           "isOptional" : false
1255         }
1256       ],
1257       "returns" : []
1258     },
1259     {
1260       "name" : "change",
1261       "type" : "function",
1262       "desc" : "",
1263       "sig" : "function ()\n{\n\n}",
1264       "memberOf" : "",
1265       "example" : "",
1266       "deprecated" : "",
1267       "since" : "",
1268       "see" : "",
1269       "params" : [],
1270       "returns" : []
1271     },
1272     {
1273       "name" : "blur",
1274       "type" : "function",
1275       "desc" : "",
1276       "sig" : "function ()\n{\n\n}",
1277       "memberOf" : "",
1278       "example" : "",
1279       "deprecated" : "",
1280       "since" : "",
1281       "see" : "",
1282       "params" : [],
1283       "returns" : []
1284     },
1285     {
1286       "name" : "focus",
1287       "type" : "function",
1288       "desc" : "",
1289       "sig" : "function ()\n{\n\n}",
1290       "memberOf" : "",
1291       "example" : "",
1292       "deprecated" : "",
1293       "since" : "",
1294       "see" : "",
1295       "params" : [],
1296       "returns" : []
1297     },
1298     {
1299       "name" : "beforerender",
1300       "type" : "function",
1301       "desc" : "Fires before the component is rendered. Return false to stop the render.",
1302       "sig" : "function (_self)\n{\n\n}",
1303       "memberOf" : "Roo.Component",
1304       "example" : "",
1305       "deprecated" : "",
1306       "since" : "",
1307       "see" : "",
1308       "params" : [
1309         {
1310           "name" : "this",
1311           "type" : "Roo.Component",
1312           "desc" : "",
1313           "isOptional" : false
1314         }
1315       ],
1316       "returns" : []
1317     },
1318     {
1319       "name" : "disable",
1320       "type" : "function",
1321       "desc" : "Fires after the component is disabled.",
1322       "sig" : "function (_self)\n{\n\n}",
1323       "memberOf" : "Roo.Component",
1324       "example" : "",
1325       "deprecated" : "",
1326       "since" : "",
1327       "see" : "",
1328       "params" : [
1329         {
1330           "name" : "this",
1331           "type" : "Roo.Component",
1332           "desc" : "",
1333           "isOptional" : false
1334         }
1335       ],
1336       "returns" : []
1337     },
1338     {
1339       "name" : "render",
1340       "type" : "function",
1341       "desc" : "Fires after the component is rendered.",
1342       "sig" : "function (_self)\n{\n\n}",
1343       "memberOf" : "Roo.Component",
1344       "example" : "",
1345       "deprecated" : "",
1346       "since" : "",
1347       "see" : "",
1348       "params" : [
1349         {
1350           "name" : "this",
1351           "type" : "Roo.Component",
1352           "desc" : "",
1353           "isOptional" : false
1354         }
1355       ],
1356       "returns" : []
1357     },
1358     {
1359       "name" : "destroy",
1360       "type" : "function",
1361       "desc" : "Fires after the component is destroyed.",
1362       "sig" : "function (_self)\n{\n\n}",
1363       "memberOf" : "Roo.Component",
1364       "example" : "",
1365       "deprecated" : "",
1366       "since" : "",
1367       "see" : "",
1368       "params" : [
1369         {
1370           "name" : "this",
1371           "type" : "Roo.Component",
1372           "desc" : "",
1373           "isOptional" : false
1374         }
1375       ],
1376       "returns" : []
1377     },
1378     {
1379       "name" : "hide",
1380       "type" : "function",
1381       "desc" : "Fires after the component is hidden.",
1382       "sig" : "function (_self)\n{\n\n}",
1383       "memberOf" : "Roo.Component",
1384       "example" : "",
1385       "deprecated" : "",
1386       "since" : "",
1387       "see" : "",
1388       "params" : [
1389         {
1390           "name" : "this",
1391           "type" : "Roo.Component",
1392           "desc" : "",
1393           "isOptional" : false
1394         }
1395       ],
1396       "returns" : []
1397     },
1398     {
1399       "name" : "beforehide",
1400       "type" : "function",
1401       "desc" : "Fires before the component is hidden. Return false to stop the hide.",
1402       "sig" : "function (_self)\n{\n\n}",
1403       "memberOf" : "Roo.Component",
1404       "example" : "",
1405       "deprecated" : "",
1406       "since" : "",
1407       "see" : "",
1408       "params" : [
1409         {
1410           "name" : "this",
1411           "type" : "Roo.Component",
1412           "desc" : "",
1413           "isOptional" : false
1414         }
1415       ],
1416       "returns" : []
1417     },
1418     {
1419       "name" : "show",
1420       "type" : "function",
1421       "desc" : "Fires after the component is shown.",
1422       "sig" : "function (_self)\n{\n\n}",
1423       "memberOf" : "Roo.Component",
1424       "example" : "",
1425       "deprecated" : "",
1426       "since" : "",
1427       "see" : "",
1428       "params" : [
1429         {
1430           "name" : "this",
1431           "type" : "Roo.Component",
1432           "desc" : "",
1433           "isOptional" : false
1434         }
1435       ],
1436       "returns" : []
1437     },
1438     {
1439       "name" : "beforeshow",
1440       "type" : "function",
1441       "desc" : "Fires before the component is shown.  Return false to stop the show.",
1442       "sig" : "function (_self)\n{\n\n}",
1443       "memberOf" : "Roo.Component",
1444       "example" : "",
1445       "deprecated" : "",
1446       "since" : "",
1447       "see" : "",
1448       "params" : [
1449         {
1450           "name" : "this",
1451           "type" : "Roo.Component",
1452           "desc" : "",
1453           "isOptional" : false
1454         }
1455       ],
1456       "returns" : []
1457     },
1458     {
1459       "name" : "enable",
1460       "type" : "function",
1461       "desc" : "Fires after the component is enabled.",
1462       "sig" : "function (_self)\n{\n\n}",
1463       "memberOf" : "Roo.Component",
1464       "example" : "",
1465       "deprecated" : "",
1466       "since" : "",
1467       "see" : "",
1468       "params" : [
1469         {
1470           "name" : "this",
1471           "type" : "Roo.Component",
1472           "desc" : "",
1473           "isOptional" : false
1474         }
1475       ],
1476       "returns" : []
1477     },
1478     {
1479       "name" : "beforedestroy",
1480       "type" : "function",
1481       "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
1482       "sig" : "function (_self)\n{\n\n}",
1483       "memberOf" : "Roo.Component",
1484       "example" : "",
1485       "deprecated" : "",
1486       "since" : "",
1487       "see" : "",
1488       "params" : [
1489         {
1490           "name" : "this",
1491           "type" : "Roo.Component",
1492           "desc" : "",
1493           "isOptional" : false
1494         }
1495       ],
1496       "returns" : []
1497     }
1498   ]
1499 }