| Namespace | tinymce | 
| Class | Editor | 
| Property | Defined By | 
|---|---|
| URI object to current document that holds the TinyMCE editor instance. | Editor | 
| 
contentCSS : Array Array with CSS files to load into the iframe. | Editor | 
| Control manager instance for the editor. | Editor | 
| URI object to document configured for the TinyMCE instance. | Editor | 
| DOM instance for the editor. | Editor | 
| Formatter instance. | Editor | 
| 
id : String Editor instance id, normally the same as the div/textarea that was replaced. | Editor | 
| 
isNotDirty : Boolean State to force the editor to return false on a isDirty call. | Editor | 
| HTML parser will be used when contents is inserted into the editor. | Editor | 
| 
plugins : Object Name/Value object containting plugin instances. | Editor | 
| Schema instance, enables you to validate elements and it's children. | Editor | 
| Selection instance for the editor. | Editor | 
| DOM serializer for the editor. | Editor | 
| 
settings : Object Name/value collection with editor settings. | Editor | 
| Reference to the theme instance that was used to generate the UI. | Editor | 
| Undo manager instance, responsible for handling undo levels. | Editor | 
| Window manager reference, use this to open new windows and dialogs. | Editor | 
| Method | Defined By | 
|---|---|
| 
Editor(id:String, s:Object) Constructs a editor instance by id. | Editor | 
| 
addButton(n:String, s:Object):void Adds a button that later gets created by the ControlManager. | Editor | 
| 
addCommand(name:String, callback:tinymce.Editor.addCommandCallback, scope:Object):void Adds a custom command to the editor, you can also override existing commands with this method. | Editor | 
| 
addQueryStateHandler(name:String, callback:tinymce.Editor.addQueryStateHandlerCallback, scope:Object):void Adds a custom query state command to the editor, you can also override existing commands with this method. | Editor | 
| 
addQueryValueHandler(name:String, callback:tinymce.Editor.addQueryValueHandlerCallback, scope:Object):void Adds a custom query value command to the editor, you can also override existing commands with this method. | Editor | 
| 
addShortcut(pa:String, desc:String, cmd_func:String/Function, sc:Object):Boolean Adds a keyboard shortcut for some command or function. | Editor | 
| 
addVisual(e:Element):void Adds visual aid for tables, anchors etc so they can be more easily edited inside the editor. | Editor | 
| 
convertURL(u:string, n:string, Tag:string/HTMLElement):string URL converter function this gets executed each time a user adds an img, a or any other element that has a URL in it. | Editor | 
| 
destroy(s:Boolean):void Destroys the editor instance by removing all events, element references or other resources that could leak memory. | Editor | 
| 
execCallback(n:String):Object Executes a legacy callback. | Editor | 
| 
execCommand(cmd:String, ui:Boolean, val:mixed, a:Object):Boolean Executes a command on the current instance. | Editor | 
| 
focus(sf:Boolean):void Focuses/activates the editor. | Editor | 
| 
getBody():Element Returns the iframes body element. | Editor | 
| 
getContainer():Element Returns the editors container element. | Editor | 
| 
getContent(args:Object):String Gets the content from the editor instance, this will cleanup the content before it gets returned using the different cle... | Editor | 
| 
getContentAreaContainer():Element Returns the editors content area container element. | Editor | 
| 
getDoc():Document Returns the iframes document object. | Editor | 
| 
getElement():Element Returns the target element/textarea that got replaced with a TinyMCE editor instance. | Editor | 
| 
getLang(n:String, dv:String):void Returns a language pack item by name/key. | Editor | 
| 
getParam(n:String, dv:String, ty:String):String Returns a configuration parameter by name. | Editor | 
| 
getWin():Window Returns the iframes window object. | Editor | 
| 
hide():void Hides the editor and shows any textarea/div that the editor is supposed to replace. | Editor | 
| 
init():void Initializes the editor this will be called automatically when all plugins/themes and language packs are loaded by the re... | Editor | 
| 
isDirty():Boolean Returns true/false if the editor is dirty or not. | Editor | 
| 
isHidden():Boolean Returns true/false if the editor is hidden or not. | Editor | 
| 
load(o:Object):String Loads contents from the textarea or div element that got converted into an editor instance. | Editor | 
| 
nodeChanged(o:Object):void Distpaches out a onNodeChange event to all observers. | Editor | 
| 
queryCommandState(cmd:string):Boolean Returns a command specific state, for example if bold is enabled or not. | Editor | 
| 
queryCommandValue(c:string):Object Returns a command specific value, for example the current font size. | Editor | 
| 
remove():void Removes the editor from the dom and tinymce collection. | Editor | 
| 
render():void Renderes the editor/adds it to the page. | Editor | 
| 
save(o:Object):String Saves the contents from a editor out to the textarea or div element that got converted into an editor instance. | Editor | 
| 
setContent(content:String, args:Object):String Sets the specified content to the editor instance, this will cleanup the content before it gets set using the different ... | Editor | 
| 
setProgressState(b:Boolean, ti:Number, o:Object):Boolean Sets the progress state, this will display a throbber/progess for the editor. | Editor | 
| 
setupContentEditable():void Sets up the contentEditable mode. | Editor | 
| 
setupIframe():void This method get called by the init method ones the iframe is loaded. | Editor | 
| 
show():void Shows the editor and hides any textarea/div that the editor is supposed to replace. | Editor | 
| 
translate(s:String):String Translates the specified string by replacing variables with language pack items it will also check if there is a key mat... | Editor | 
| Event | Defined By | 
|---|---|
| 
onActivate(sender:Editor) Fires when the editor is activated. | Editor | 
| 
onBeforeExecCommand(sender:Editor) Fires before a command gets executed for example "Bold". | Editor | 
| 
onBeforeGetContent(sender:Editor, evt:Event) Fires before contents is extracted from the editor using for example getContent. | Editor | 
| 
onBeforeRenderUI(sender:Editor) Fires before the initialization of the editor. | Editor | 
| 
onBeforeSetContent(sender:Editor) Fires before new contents is added to the editor. | Editor | 
| Fires when a new undo level is added to the editor. | Editor | 
| Fires when something in the body of the editor is clicked. | Editor | 
| 
onContextMenu(sender:Editor, evt:Event) Fires when a contextmenu event is intercepted inside the editor. | Editor | 
| 
onDblClick(sender:Editor, evt:Event) Fires when a dblclick event is intercepted inside the editor. | Editor | 
| 
onDeactivate(sender:Editor) Fires when the editor is deactivated. | Editor | 
| Fires when a registered event is intercepted. | Editor | 
| 
onExecCommand(sender:Editor) Fires after a command is executed for example "Bold". | Editor | 
| 
onGetContent(sender:Editor) Fires after the contents has been extracted from the editor using for example getContent. | Editor | 
| Fires after the initialization of the editor is done. | Editor | 
| Fires when a keydown event is intercepted inside the editor. | Editor | 
| 
onKeyPress(sender:Editor, evt:Event) Fires when a keypress event is intercepted inside the editor. | Editor | 
| Fires when a keydown event is intercepted inside the editor. | Editor | 
| 
onLoadContent(sender:Editor) Fires when the editor gets loaded with contents for example when the load method is executed. | Editor | 
| 
onMouseDown(sender:Editor, evt:Event) Fires when a mousedown event is intercepted inside the editor. | Editor | 
| Fires when a mouseup event is intercepted inside the editor. | Editor | 
| 
onNodeChange(sender:Editor) Fires when the user changes node location using the mouse or keyboard. | Editor | 
| Fires when a paste event is intercepted inside the editor. | Editor | 
| 
onPostProcess(sender:Editor, obj:Object) Fires when the Serializer does a postProcess on the contents. | Editor | 
| 
onPostRender(sender:Editor) Fires after the rendering has completed. | Editor | 
| Fires before the initialization of the editor. | Editor | 
| 
onPreProcess(sender:Editor, obj:Object) Fires when the Serializer does a preProcess on the contents. | Editor | 
| Fires when the contents is redo:ed. | Editor | 
| Fires when the editor instance is removed from page. | Editor | 
| Fires when a form reset event is intercepted. | Editor | 
| 
onSaveContent(sender:Editor) Fires when the editor contents gets saved for example when the save method is executed. | Editor | 
| 
onSetContent(sender:Editor) Fires after the contents has been added to the editor using for example onSetContent. | Editor | 
| 
onSetProgressState(sender:Editor) Fires when the progress throbber is shown above the editor. | Editor | 
| Fires when a form submit event is intercepted. | Editor | 
| Fires when the contents is undo:ed. | Editor | 
| 
onVisualAid(sender:Editor) Fires when visual aids is enabled/disabled. | Editor | 
public baseURI : URI
public contentCSS : Array
public controlManager : ControlManager
public documentBaseURI : URI
public id : String
public isNotDirty : Boolean
public parser : DomParser
public plugins : Object
public schema : Schema
public serializer : Serializer
public settings : Object
public theme : Theme
public undoManager : UndoManager
public windowManager : WindowManager
public 
						function Editor(id:String, s:Object)
| id:String | Unique id for the editor. | 
| s:Object | Optional settings string for the editor. | 
public 
						function addButton(n:String, s:Object):void
| n:String | Button name to add. | 
| s:Object | Settings object with title, cmd etc. | 
public 
						function addCommand(name:String, callback:tinymce.Editor.addCommandCallback, scope:Object):void
| name:String | Command name to add/override. | 
| callback:tinymce.Editor.addCommandCallback | Function to execute when the command occurs. | 
| scope:Object | Optional scope to execute the function in. | 
public 
						function addQueryStateHandler(name:String, callback:tinymce.Editor.addQueryStateHandlerCallback, scope:Object):void
| name:String | Command name to add/override. | 
| callback:tinymce.Editor.addQueryStateHandlerCallback | Function to execute when the command state retrival occurs. | 
| scope:Object | Optional scope to execute the function in. | 
public 
						function addQueryValueHandler(name:String, callback:tinymce.Editor.addQueryValueHandlerCallback, scope:Object):void
| name:String | Command name to add/override. | 
| callback:tinymce.Editor.addQueryValueHandlerCallback | Function to execute when the command value retrival occurs. | 
| scope:Object | Optional scope to execute the function in. | 
public 
						function addShortcut(pa:String, desc:String, cmd_func:String/Function, sc:Object):Boolean
| pa:String | Shortcut pattern. Like for example: ctrl+alt+o. | 
| desc:String | Text description for the command. | 
| cmd_func:String/Function | Command name string or function to execute when the key is pressed. | 
| sc:Object | Optional scope to execute the function in. | 
public 
						function addVisual(e:Element):void
| e:Element | Optional root element to loop though to find tables etc that needs the visual aid. | 
public 
						function convertURL(u:string, n:string, Tag:string/HTMLElement):string
| u:string | URL to convert. | 
| n:string | Attribute name src, href etc. | 
| Tag:string/HTMLElement | name or HTML DOM element depending on HTML or DOM insert. | 
public 
						function destroy(s:Boolean):void
| s:Boolean | Optional state if the destroy is an automatic destroy or user called one. | 
public 
						function execCallback(n:String):Object
| n:String | Name of the callback to execute. | 
public 
						function execCommand(cmd:String, ui:Boolean, val:mixed, a:Object):Boolean
| cmd:String | Command name to execute, for example mceLink or Bold. | 
| ui:Boolean | True/false state if a UI (dialog) should be presented or not. | 
| val:mixed | Optional command value, this can be anything. | 
| a:Object | Optional arguments object. | 
public 
						function focus(sf:Boolean):void
| sf:Boolean | Skip DOM focus. Just set is as the active editor. | 
public 
						function getBody():Element
public 
						function getContainer():Element
public 
						function getContent(args:Object):String
| args:Object | Optional content object, this gets passed around through the whole get process. | 
public 
						function getContentAreaContainer():Element
public 
						function getDoc():Document
public 
						function getElement():Element
public 
						function getLang(n:String, dv:String):void
| n:String | Name/key to get from the language pack. | 
| dv:String | Optional default value to retrive. | 
public 
						function getParam(n:String, dv:String, ty:String):String
| n:String | Configruation parameter to retrive. | 
| dv:String | Optional default value to return. | 
| ty:String | Optional type parameter. | 
public 
						function getWin():Window
public 
						function hide():void
public 
						function init():void
public 
						function isDirty():Boolean
public 
						function isHidden():Boolean
public 
						function load(o:Object):String
| o:Object | Optional content object, this gets passed around through the whole load process. | 
public 
						function nodeChanged(o:Object):void
| o:Object | Optional object to pass along for the node changed event. | 
public 
						function queryCommandState(cmd:string):Boolean
| cmd:string | Command to query state from. | 
public 
						function queryCommandValue(c:string):Object
| c:string | Command to query value from. | 
public 
						function remove():void
public 
						function render():void
public 
						function save(o:Object):String
| o:Object | Optional content object, this gets passed around through the whole save process. | 
public 
						function setContent(content:String, args:Object):String
| content:String | Content to set to editor, normally HTML contents but can be other formats as well. | 
| args:Object | Optional content object, this gets passed around through the whole set process. | 
public 
						function setProgressState(b:Boolean, ti:Number, o:Object):Boolean
| b:Boolean | Boolean state if the progress should be shown or hidden. | 
| ti:Number | Optional time to wait before the progress gets shown. | 
| o:Object | Optional object to pass to the progress observers. | 
public 
						function setupContentEditable():void
public 
						function setupIframe():void
public 
						function show():void
public 
						function translate(s:String):String
| s:String | String to translate by the language pack data. | 
public 
						event onActivate(sender:Editor)
| sender:Editor | Editor instance. | 
public 
						event onBeforeExecCommand(sender:Editor)
| sender:Editor | Editor instance. | 
public 
						event onBeforeGetContent(sender:Editor, evt:Event)
| sender:Editor | Editor instance. | 
| evt:Event | W3C DOM Event instance. | 
public 
						event onBeforeRenderUI(sender:Editor)
| sender:Editor | Editor instance. | 
public 
						event onBeforeSetContent(sender:Editor)
| sender:Editor | Editor instance. | 
public 
						event onChange(sender:Editor)
| sender:Editor | Editor instance. | 
public 
						event onClick(sender:Editor, evt:Event)
| sender:Editor | Editor instance. | 
| evt:Event | W3C DOM Event instance. | 
public 
						event onContextMenu(sender:Editor, evt:Event)
| sender:Editor | Editor instance. | 
| evt:Event | W3C DOM Event instance. | 
public 
						event onDblClick(sender:Editor, evt:Event)
| sender:Editor | Editor instance. | 
| evt:Event | W3C DOM Event instance. | 
public 
						event onDeactivate(sender:Editor)
| sender:Editor | Editor instance. | 
public 
						event onEvent(sender:Editor, evt:Event)
| sender:Editor | Editor instance. | 
| evt:Event | W3C DOM Event instance. | 
public 
						event onExecCommand(sender:Editor)
| sender:Editor | Editor instance. | 
public 
						event onGetContent(sender:Editor)
| sender:Editor | Editor instance. | 
public 
						event onInit(sender:Editor)
| sender:Editor | Editor instance. | 
public 
						event onKeyDown(sender:Editor, evt:Event)
| sender:Editor | Editor instance. | 
| evt:Event | W3C DOM Event instance. | 
public 
						event onKeyPress(sender:Editor, evt:Event)
| sender:Editor | Editor instance. | 
| evt:Event | W3C DOM Event instance. | 
public 
						event onKeyUp(sender:Editor, evt:Event)
| sender:Editor | Editor instance. | 
| evt:Event | W3C DOM Event instance. | 
public 
						event onLoadContent(sender:Editor)
| sender:Editor | Editor instance. | 
public 
						event onMouseDown(sender:Editor, evt:Event)
| sender:Editor | Editor instance. | 
| evt:Event | W3C DOM Event instance. | 
public 
						event onMouseUp(sender:Editor, evt:Event)
| sender:Editor | Editor instance. | 
| evt:Event | W3C DOM Event instance. | 
public 
						event onNodeChange(sender:Editor)
| sender:Editor | Editor instance. | 
public 
						event onPaste(sender:Editor, evt:Event)
| sender:Editor | Editor instance. | 
| evt:Event | W3C DOM Event instance. | 
public 
						event onPostProcess(sender:Editor, obj:Object)
| sender:Editor | Editor instance. | 
| obj:Object | PreProcess object. | 
public 
						event onPostRender(sender:Editor)
| sender:Editor | Editor instance. | 
public 
						event onPreInit(sender:Editor)
| sender:Editor | Editor instance. | 
public 
						event onPreProcess(sender:Editor, obj:Object)
| sender:Editor | Editor instance. | 
| obj:Object | PreProcess object. | 
public 
						event onRedo(sender:Editor, level:Object)
| sender:Editor | Editor instance. | 
| level:Object | Undo level object. | 
public 
						event onRemove(sender:Editor)
| sender:Editor | Editor instance. | 
public 
						event onReset(sender:Editor, evt:Event)
| sender:Editor | Editor instance. | 
| evt:Event | W3C DOM Event instance. | 
public 
						event onSaveContent(sender:Editor)
| sender:Editor | Editor instance. | 
public 
						event onSetContent(sender:Editor)
| sender:Editor | Editor instance. | 
public 
						event onSetProgressState(sender:Editor)
| sender:Editor | Editor instance. | 
public 
						event onSubmit(sender:Editor, evt:Event)
| sender:Editor | Editor instance. | 
| evt:Event | W3C DOM Event instance. | 
public 
						event onUndo(sender:Editor, level:Object)
| sender:Editor | Editor instance. | 
| level:Object | {Object} level Undo level object. @ example // Adds an observer to the onUndo event using tinyMCE.init tinyMCE.init({ ... setup : function(ed) { ed.onUndo.add(function(ed, level) { console.debug('Undo was performed: ' + level.content); }); } }); |