Namespace: ckeditor

Drupal.editors.ckeditor

Methods

(static) _loadExternalPlugins(format)

Loads the required external plugins for the editor.

Parameters:
Name Type Description
format object

The text format used in the editor.

Source:

(static) attach(element, format) → {bool}

Editor attach callback.

Parameters:
Name Type Description
element HTMLElement

The element to attach the editor to.

format string

The text format for the editor.

Source:
Returns:

Whether the call to CKEDITOR.replace() created an editor or not.

Type
bool

(static) attachInlineEditor(element, format, mainToolbarIdopt, floatedToolbarIdopt) → {bool}

Attaches an inline editor to a DOM element.

Parameters:
Name Type Attributes Description
element HTMLElement

The element to attach the editor to.

format object

The text format used in the editor.

mainToolbarId string <optional>

The id attribute for the main editor toolbar, if any.

floatedToolbarId string <optional>

The id attribute for the floated editor toolbar, if any.

Source:
Returns:

Whether the call to CKEDITOR.replace() created an editor or not.

Type
bool

(static) detach(element, format, trigger) → {bool}

Editor detach callback.

Parameters:
Name Type Description
element HTMLElement

The element to detach the editor from.

format string

The text format used for the editor.

trigger string

The event trigger for the detach.

Source:
Returns:

Whether the call to CKEDITOR.dom.element.get(element).getEditor() found an editor or not.

Type
bool

(static) onChange(element, callback) → {bool}

Reacts on a change in the editor element.

Parameters:
Name Type Description
element HTMLElement

The element where the change occurred.

callback function

Callback called with the value of the editor.

Source:
Returns:

Whether the call to CKEDITOR.dom.element.get(element).getEditor() found an editor or not.

Type
bool