Class CKEDITOR.pluginDefinition

Defined in: core/plugindefinition.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	CKEDITOR.pluginDefinition() (Virtual Class) Do not call this constructor.

Field Summary
Field Attributes	Field Name and Description
	requires A list of plugins that are required by this plugin.

Method Summary
Method Attributes	Method Name and Description
	beforeInit(editor, pluginPath) Function called on initialization of every editor instance created in the page before the init() call task.
	init(editor, pluginPath) Function called on initialization of every editor instance created in the page.

Class Detail

CKEDITOR.pluginDefinition()

Since: 3.0

(Virtual Class) Do not call this constructor. This class is not really part of the API. It just illustrates the features of plugin objects to be passed to the CKEDITOR.plugins.add function.

Field Detail

{Array} requires

Since: 3.0

A list of plugins that are required by this plugin. Note that this property doesn't guarantee the loading order of the plugins.

CKEDITOR.plugins.add( 'sample',
{
    requires : [ 'button', 'selection' ]
});

Method Detail

{Undefined} beforeInit(editor, pluginPath)

Since: 3.0

Function called on initialization of every editor instance created in the page before the init() call task. The beforeInit function will be called for all plugins, after that the init function is called for all of them. This feature makes it possible to initialize things that could be used in the init function of other plugins.

CKEDITOR.plugins.add( 'sample',
{
    beforeInit : function( editor, pluginPath )
    {
        alert( 'Editor "' + editor.name + '" is to be initialized!' );
    }
});

Parameters:
{CKEDITOR.editor} editor: The editor instance being initialized.
{String} pluginPath: The URL path for the plugin installation folder.

{Undefined} init(editor, pluginPath)

Since: 3.0

Function called on initialization of every editor instance created in the page.

CKEDITOR.plugins.add( 'sample',
{
    init : function( editor, pluginPath )
    {
        alert( 'Editor "' + editor.name + '" is being initialized!' );
    }
});

Parameters:
{CKEDITOR.editor} editor: The editor instance being initialized.
{String} pluginPath: The URL path for the plugin installation folder.

CKEditor 3.0 JavaScript API Documentation

Namespaces

Classes

Class CKEDITOR.pluginDefinition