1 /* 2 * CKEditor - The text editor for Internet - http://ckeditor.com 3 * Copyright (C) 2003-2008 Frederico Caldeira Knabben 4 * 5 * == BEGIN LICENSE == 6 * 7 * Licensed under the terms of any of the following licenses at your 8 * choice: 9 * 10 * - GNU General Public License Version 2 or later (the "GPL") 11 * http://www.gnu.org/licenses/gpl.html 12 * 13 * - GNU Lesser General Public License Version 2.1 or later (the "LGPL") 14 * http://www.gnu.org/licenses/lgpl.html 15 * 16 * - Mozilla Public License Version 1.1 or later (the "MPL") 17 * http://www.mozilla.org/MPL/MPL-1.1.html 18 * 19 * == END LICENSE == 20 */ 21 22 /** 23 * @fileOverview Defines the "virtual" {@link CKEDITOR.pluginDefinition} class, which 24 * contains the defintion of a plugin. This file is for documentation 25 * purposes only. 26 */ 27 28 /** 29 * (Virtual Class) Do not call this constructor. This class is not really part 30 * of the API. It just illustrates the features of plugin objects to be 31 * passed to the {@link CKEDITOR.plugins.add} function. 32 * @name CKEDITOR.pluginDefinition 33 * @constructor 34 * @example 35 */ 36 37 /** 38 * Function called on initialization of every editor instance created in the 39 * page before the init() call task. The beforeInit function will be called for 40 * all plugins, after that the init function is called for all of them. This 41 * feature makes it possible to initialize things that could be used in the 42 * init function of other plugins. 43 * @name CKEDITOR.pluginDefinition.prototype.beforeInit 44 * @function 45 * @param {CKEDITOR.editor} editor The editor instance being initialized. 46 * @param {String} pluginPath The URL path for the plugin installation folder. 47 * @example 48 * CKEDITOR.plugins.add( 'sample', 49 * { 50 * beforeInit : function( editor, pluginPath ) 51 * { 52 * alert( 'Editor "' + editor.name + '" is to be initialized!' ); 53 * } 54 * }); 55 */ 56 57 /** 58 * Function called on initialization of every editor instance created in the 59 * page. 60 * @name CKEDITOR.pluginDefinition.prototype.init 61 * @function 62 * @param {CKEDITOR.editor} editor The editor instance being initialized. 63 * @param {String} pluginPath The URL path for the plugin installation folder. 64 * @example 65 * CKEDITOR.plugins.add( 'sample', 66 * { 67 * init : function( editor, pluginPath ) 68 * { 69 * alert( 'Editor "' + editor.name + '" is being initialized!' ); 70 * } 71 * }); 72 */ 73