2 Copyright (c) 2003-2011, CKSource - Frederico Knabben. All rights reserved.
3 For licensing, see LICENSE.html or http://ckeditor.com/license
7 * @fileOverview Defines the "virtual" {@link CKEDITOR.pluginDefinition} class, which
8 * contains the defintion of a plugin. This file is for documentation
13 * (Virtual Class) Do not call this constructor. This class is not really part
14 * of the API. It just illustrates the features of plugin objects to be
15 * passed to the {@link CKEDITOR.plugins.add} function.
16 * @name CKEDITOR.pluginDefinition
22 * A list of plugins that are required by this plugin. Note that this property
23 * doesn't guarantee the loading order of the plugins.
24 * @name CKEDITOR.pluginDefinition.prototype.requires
27 * CKEDITOR.plugins.add( 'sample',
29 * requires : [ 'button', 'selection' ]
34 * Function called on initialization of every editor instance created in the
35 * page before the init() call task. The beforeInit function will be called for
36 * all plugins, after that the init function is called for all of them. This
37 * feature makes it possible to initialize things that could be used in the
38 * init function of other plugins.
39 * @name CKEDITOR.pluginDefinition.prototype.beforeInit
41 * @param {CKEDITOR.editor} editor The editor instance being initialized.
43 * CKEDITOR.plugins.add( 'sample',
45 * beforeInit : function( editor )
47 * alert( 'Editor "' + editor.name + '" is to be initialized!' );
53 * Function called on initialization of every editor instance created in the
55 * @name CKEDITOR.pluginDefinition.prototype.init
57 * @param {CKEDITOR.editor} editor The editor instance being initialized.
59 * CKEDITOR.plugins.add( 'sample',
61 * init : function( editor )
63 * alert( 'Editor "' + editor.name + '" is being initialized!' );