tinymce.EditorManager

This class used as a factory for manager for tinymce.Editor instances.

Examples

tinymce.EditorManager.init({});

Properties

name type summary defined by
$ tinymce.dom.DomQuery Dom query instance. tinymce.EditorManager
activeEditor tinymce.Editor Currently active editor instance. tinymce.EditorManager
baseURI tinymce.util.URI Absolute baseURI for the installation path of TinyMCE. tinymce.EditorManager
baseURL String Base URL where the root directory if TinyMCE is located. tinymce.EditorManager
documentBaseURL String Document base URL where the current document is located. tinymce.EditorManager
editors Object Collection of editor instances. tinymce.EditorManager
i18n Object Collection of language pack data. tinymce.EditorManager
majorVersion String Major version of TinyMCE build. tinymce.EditorManager
minorVersion String Minor version of TinyMCE build. tinymce.EditorManager
releaseDate String Release date of TinyMCE build. tinymce.EditorManager
suffix String Current suffix to add to each plugin/theme that gets loaded for example ".min". tinymce.EditorManager

Methods

name summary defined by
add() Adds an editor instance to the editor collection. This will also set it as the active editor. tinymce.EditorManager
addI18n() Adds a language pack, this gets called by the loaded language files like en.js. tinymce.EditorManager
createEditor() Creates an editor instance and adds it to the EditorManager collection. tinymce.EditorManager
execCommand() Executes a specific command on the currently active editor. tinymce.EditorManager
fire() Fires the specified event by name. Consult the event reference for more details on each event. tinymce.util.Observable
get() Returns a editor instance by id. tinymce.EditorManager
hasEventListeners() Returns true/false if the object has a event of the specified name. tinymce.util.Observable
init() Initializes a set of editors. This method will create editors based on various settings. tinymce.EditorManager
off() Unbinds an event listener to a specific event by name. Consult the event reference for more details on each event. tinymce.util.Observable
on() Binds an event listener to a specific event by name. Consult the event reference for more details on each event. tinymce.util.Observable
once() Bind the event callback and once it fires the callback is removed. Consult the event reference for more details on each event. tinymce.util.Observable
overrideDefaults() Overrides the default settings for editor instances. tinymce.EditorManager
remove() Removes a editor or editors form page. tinymce.EditorManager
setActive() Sets the active editor instance and fires the deactivate/activate events. tinymce.EditorManager
translate() Translates the specified string using the language pack items. tinymce.EditorManager
triggerSave() Calls the save method on all editor instances in the collection. This can be useful when a form is to be submitted. tinymce.EditorManager

Methods

add

add(editor:tinymce.Editor):tinymce.Editor

Adds an editor instance to the editor collection. This will also set it as the active editor.

Parameters
Return value

addI18n

addI18n(code:String, items:Object)

Adds a language pack, this gets called by the loaded language files like en.js.

Parameters

createEditor

createEditor(id:String, settings:Object):tinymce.Editor

Creates an editor instance and adds it to the EditorManager collection.

Parameters
Return value

execCommand

execCommand(cmd:String, ui:Boolean, value:String):Boolean

Executes a specific command on the currently active editor.

Parameters
Return value

fire

fire(name:String, args:Object?, bubble:Boolean?):Object

Fires the specified event by name. Consult the event reference for more details on each event.

Examples
instance.fire('event', {...});
Parameters
Return value

get

get(id:String):tinymce.Editor

Returns a editor instance by id.

Examples
// Adds an onclick event to an editor by id (shorter version)
tinymce.get('mytextbox').on('click', function(e) {
   ed.windowManager.alert('Hello world!');
});

// Adds an onclick event to an editor by id (longer version)
tinymce.EditorManager.get('mytextbox').on('click', function(e) {
   ed.windowManager.alert('Hello world!');
});
Parameters
Return value

hasEventListeners

hasEventListeners(name:String):Boolean

Returns true/false if the object has a event of the specified name.

Parameters
Return value

init

init(settings:Object):tinymce.util.Promise

Initializes a set of editors. This method will create editors based on various settings.

Examples
// Initializes a editor using the longer method
tinymce.EditorManager.init({
   some_settings : 'some value'
});

// Initializes a editor instance using the shorter version and with a promise
tinymce.init({
   some_settings : 'some value'
}).then(function(editors) {
   ...
});
Parameters
Return value

off

off(name:String?, callback:callback?):Object

Unbinds an event listener to a specific event by name. Consult the event reference for more details on each event.

Examples
// Unbind specific callback
instance.off('event', handler);

// Unbind all listeners by name
instance.off('event');

// Unbind all events
instance.off();
Parameters
Return value

on

on(name:String, callback:callback, first:Boolean):Object

Binds an event listener to a specific event by name. Consult the event reference for more details on each event.

Examples
instance.on('event', function(e) {
    // Callback logic
});
Parameters
Return value

once

once(name:String, callback:callback):Object

Bind the event callback and once it fires the callback is removed. Consult the event reference for more details on each event.

Parameters
Return value

overrideDefaults

overrideDefaults(defaultSettings:Object)

Overrides the default settings for editor instances.

Parameters

remove

remove(selector:tinymce.Editor):tinymce.Editor

Removes a editor or editors form page.

Examples
// Remove all editors bound to divs
tinymce.remove('div');

// Remove all editors bound to textareas
tinymce.remove('textarea');

// Remove all editors
tinymce.remove();

// Remove specific instance by id
tinymce.remove('#id');
Parameters
Return value

setActive

setActive(editor:tinymce.Editor)

Sets the active editor instance and fires the deactivate/activate events.

Parameters

translate

translate(text:String):String

Translates the specified string using the language pack items.

Parameters
Return value

triggerSave

triggerSave()

Calls the save method on all editor instances in the collection. This can be useful when a form is to be submitted.

Examples
// Saves all contents
tinyMCE.triggerSave();

Except as otherwise noted, the content of this page is licensed under the Creative Commons BY-NC-SA 3.0 License, and code samples are licensed under the Apache 2.0 License.