_source/core/plugindefinition.js

   1 /*\r
   2 Copyright (c) 2003-2009, CKSource - Frederico Knabben. All rights reserved.\r
   3 For licensing, see LICENSE.html or http://ckeditor.com/license\r
   4 */\r
   5 \r
   6 /**\r
   7  * @fileOverview Defines the "virtual" {@link CKEDITOR.pluginDefinition} class, which\r
   8  *              contains the defintion of a plugin. This file is for documentation\r
   9  *              purposes only.\r
  10  */\r
  11 \r
  12 /**\r
  13  * (Virtual Class) Do not call this constructor. This class is not really part\r
  14  *              of the API. It just illustrates the features of plugin objects to be\r
  15  *              passed to the {@link CKEDITOR.plugins.add} function.\r
  16  * @name CKEDITOR.pluginDefinition\r
  17  * @constructor\r
  18  * @example\r
  19  */\r
  20 \r
  21 /**\r
  22  * A list of plugins that are required by this plugin. Note that this property\r
  23  * doesn't guarantee the loading order of the plugins.\r
  24  * @name CKEDITOR.pluginDefinition.prototype.requires\r
  25  * @type Array\r
  26  * @example\r
  27  * CKEDITOR.plugins.add( 'sample',\r
  28  * {\r
  29  *     requires : [ 'button', 'selection' ]\r
  30  * });\r
  31  */\r
  32 \r
  33  /**\r
  34  * Function called on initialization of every editor instance created in the\r
  35  * page before the init() call task. The beforeInit function will be called for\r
  36  * all plugins, after that the init function is called for all of them. This\r
  37  * feature makes it possible to initialize things that could be used in the\r
  38  * init function of other plugins.\r
  39  * @name CKEDITOR.pluginDefinition.prototype.beforeInit\r
  40  * @function\r
  41  * @param {CKEDITOR.editor} editor The editor instance being initialized.\r
  42  * @example\r
  43  * CKEDITOR.plugins.add( 'sample',\r
  44  * {\r
  45  *     beforeInit : function( editor )\r
  46  *     {\r
  47  *         alert( 'Editor "' + editor.name + '" is to be initialized!' );\r
  48  *     }\r
  49  * });\r
  50  */\r
  51 \r
  52  /**\r
  53  * Function called on initialization of every editor instance created in the\r
  54  * page.\r
  55  * @name CKEDITOR.pluginDefinition.prototype.init\r
  56  * @function\r
  57  * @param {CKEDITOR.editor} editor The editor instance being initialized.\r
  58  * @example\r
  59  * CKEDITOR.plugins.add( 'sample',\r
  60  * {\r
  61  *     init : function( editor )\r
  62  *     {\r
  63  *         alert( 'Editor "' + editor.name + '" is being initialized!' );\r
  64  *     }\r
  65  * });\r
  66  */\r