vanilla ckeditor-3.0

[ckeditor.git] / _source / core / plugindefinition.js

diff --git a/_source/core/plugindefinition.js b/_source/core/plugindefinition.js
new file mode 100644 (file)
index 0000000..d8e4c1c
--- /dev/null
+++ b/_source/core/plugindefinition.js
@@ -0,0 +1,66 @@
+/*\r
+Copyright (c) 2003-2009, CKSource - Frederico Knabben. All rights reserved.\r
+For licensing, see LICENSE.html or http://ckeditor.com/license\r
+*/\r
+\r
+/**\r
+ * @fileOverview Defines the "virtual" {@link CKEDITOR.pluginDefinition} class, which\r
+ *             contains the defintion of a plugin. This file is for documentation\r
+ *             purposes only.\r
+ */\r
+\r
+/**\r
+ * (Virtual Class) Do not call this constructor. This class is not really part\r
+ *             of the API. It just illustrates the features of plugin objects to be\r
+ *             passed to the {@link CKEDITOR.plugins.add} function.\r
+ * @name CKEDITOR.pluginDefinition\r
+ * @constructor\r
+ * @example\r
+ */\r
+\r
+/**\r
+ * A list of plugins that are required by this plugin. Note that this property\r
+ * doesn't guarantee the loading order of the plugins.\r
+ * @name CKEDITOR.pluginDefinition.prototype.requires\r
+ * @type Array\r
+ * @example\r
+ * CKEDITOR.plugins.add( 'sample',\r
+ * {\r
+ *     requires : [ 'button', 'selection' ]\r
+ * });\r
+ */\r
+\r
+ /**\r
+ * Function called on initialization of every editor instance created in the\r
+ * page before the init() call task. The beforeInit function will be called for\r
+ * all plugins, after that the init function is called for all of them. This\r
+ * feature makes it possible to initialize things that could be used in the\r
+ * init function of other plugins.\r
+ * @name CKEDITOR.pluginDefinition.prototype.beforeInit\r
+ * @function\r
+ * @param {CKEDITOR.editor} editor The editor instance being initialized.\r
+ * @example\r
+ * CKEDITOR.plugins.add( 'sample',\r
+ * {\r
+ *     beforeInit : function( editor )\r
+ *     {\r
+ *         alert( 'Editor "' + editor.name + '" is to be initialized!' );\r
+ *     }\r
+ * });\r
+ */\r
+\r
+ /**\r
+ * Function called on initialization of every editor instance created in the\r
+ * page.\r
+ * @name CKEDITOR.pluginDefinition.prototype.init\r
+ * @function\r
+ * @param {CKEDITOR.editor} editor The editor instance being initialized.\r
+ * @example\r
+ * CKEDITOR.plugins.add( 'sample',\r
+ * {\r
+ *     init : function( editor )\r
+ *     {\r
+ *         alert( 'Editor "' + editor.name + '" is being initialized!' );\r
+ *     }\r
+ * });\r
+ */\r