tinymce-EditorManager

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. Deprecated use tinymce.get() instead.	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

• editor (tinymce.Editor) - Editor instance to add to the collection.

Return value

• tinymce.Editor - The same instance that got passed in.

addI18n

addI18n(code:String, items:Object)

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

Parameters

• code (String) - Optional language code.
• items (Object) - Name/value object with translations.

createEditor

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

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

Parameters

• id (String) - Instance id to use for editor.
• settings (Object) - Editor instance settings.

Return value

• tinymce.Editor - Editor instance that got created.

execCommand

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

Executes a specific command on the currently active editor.

Parameters

• cmd (String) - Command to perform for example Bold.
• ui (Boolean) - Optional boolean state if a UI should be presented for the command or not.
• value (String) - Optional value parameter like for example an URL to a link.

Return value

• Boolean - true/false if the command was executed or not.

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

• name (String) - Name of the event to fire.
• args (Object?) - Event arguments.
• bubble (Boolean?) - True/false if the event is to be bubbled.

Return value

• Object - Event args instance passed in.

get

get(id:String):tinymce.Editor, Array

Returns a editor instance by id.

Examples

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

// Adds an onclick event to an editor by index
tinymce.get(0).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

• id (String) - Editor instance id or index to return.

Return value

• tinymce.Editor - Editor instance to return or array of editor instances.
• Array - Editor instance to return or array of editor instances.

hasEventListeners

hasEventListeners(name:String):Boolean

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

Parameters

• name (String) - Name of the event to check for.

Return value

• Boolean - true/false if the event exists or not.

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

• settings (Object) - Settings object to be passed to each editor instance.

Return value

• tinymce.util.Promise - Promise that gets resolved with an array of editors when all editor instances are initialized.

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

• name (String?) - Name of the event to unbind.
• callback (callback?) - Callback to unbind.

Return value

• Object - Current class instance.

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

• name (String) - Event name or space separated list of events to bind.
• callback (callback) - Callback to be executed when the event occurs.
• first (Boolean) - Optional flag if the event should be prepended. Use this with care.

Return value

• Object - Current class instance.

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

• name (String) - Name of the event to bind.
• callback (callback) - Callback to bind only once.

Return value

• Object - Current class instance.

overrideDefaults

overrideDefaults(defaultSettings:Object)

Overrides the default settings for editor instances.

Parameters

• defaultSettings (Object) - Defaults settings object.

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

• selector (tinymce.Editor) - CSS selector or editor instance to remove.

Return value

• tinymce.Editor - The editor that got passed in will be return if it was found otherwise null.

setActive

setActive(editor:tinymce.Editor)

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

Parameters

• editor (tinymce.Editor) - Editor instance to set as the active instance.

translate

translate(text:String):String

Translates the specified string using the language pack items.

Parameters

• text (String) - String to translate

Return value

• String - Translated string.

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();

Can't find what you're looking for? Let us know.

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.