diff options
| author | Lester Caine <lester@lsces.co.uk> | 2009-11-24 23:57:24 +0000 |
|---|---|---|
| committer | Lester Caine <lester@lsces.co.uk> | 2009-11-24 23:57:24 +0000 |
| commit | 8630f2bc4d63b3320f5469d9532a1cba1dddb7a3 (patch) | |
| tree | f3c3122e110458a94aae544164b82fd67f1ae5e0 /_source/core/plugindefinition.js | |
| parent | e24cb83aa7f7685a4811e5c8d39541bae7b15cb2 (diff) | |
| download | ckeditor-8630f2bc4d63b3320f5469d9532a1cba1dddb7a3.tar.gz ckeditor-8630f2bc4d63b3320f5469d9532a1cba1dddb7a3.tar.bz2 ckeditor-8630f2bc4d63b3320f5469d9532a1cba1dddb7a3.zip | |
ckeditor 3.0.1 'raw' - needs reordering a little, but samples currently functional
Diffstat (limited to '_source/core/plugindefinition.js')
| -rw-r--r-- | _source/core/plugindefinition.js | 66 |
1 files changed, 66 insertions, 0 deletions
diff --git a/_source/core/plugindefinition.js b/_source/core/plugindefinition.js new file mode 100644 index 0000000..42a5740 --- /dev/null +++ b/_source/core/plugindefinition.js @@ -0,0 +1,66 @@ +/* +Copyright (c) 2003-2009, CKSource - Frederico Knabben. All rights reserved. +For licensing, see LICENSE.html or http://ckeditor.com/license +*/ + +/** + * @fileOverview Defines the "virtual" {@link CKEDITOR.pluginDefinition} class, which + * contains the defintion of a plugin. This file is for documentation + * purposes only. + */ + +/** + * (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 {@link CKEDITOR.plugins.add} function. + * @name CKEDITOR.pluginDefinition + * @constructor + * @example + */ + +/** + * A list of plugins that are required by this plugin. Note that this property + * doesn't guarantee the loading order of the plugins. + * @name CKEDITOR.pluginDefinition.prototype.requires + * @type Array + * @example + * CKEDITOR.plugins.add( 'sample', + * { + * requires : [ 'button', 'selection' ] + * }); + */ + + /** + * 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. + * @name CKEDITOR.pluginDefinition.prototype.beforeInit + * @function + * @param {CKEDITOR.editor} editor The editor instance being initialized. + * @example + * CKEDITOR.plugins.add( 'sample', + * { + * beforeInit : function( editor ) + * { + * alert( 'Editor "' + editor.name + '" is to be initialized!' ); + * } + * }); + */ + + /** + * Function called on initialization of every editor instance created in the + * page. + * @name CKEDITOR.pluginDefinition.prototype.init + * @function + * @param {CKEDITOR.editor} editor The editor instance being initialized. + * @example + * CKEDITOR.plugins.add( 'sample', + * { + * init : function( editor ) + * { + * alert( 'Editor "' + editor.name + '" is being initialized!' ); + * } + * }); + */ |
