vanilla ckeditor-3.0

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

diff --git a/_source/core/commanddefinition.js b/_source/core/commanddefinition.js
new file mode 100644 (file)
index 0000000..b178498
--- /dev/null
+++ b/_source/core/commanddefinition.js
@@ -0,0 +1,72 @@
+/*\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.commandDefinition} class,\r
+ *             which contains the defintion of a command. This file is for\r
+ *             documentation 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 command objects to be\r
+ *             passed to the {@link CKEDITOR.editor.prototype.addCommand} function.\r
+ * @name CKEDITOR.commandDefinition\r
+ * @constructor\r
+ * @example\r
+ */\r
+\r
+ /**\r
+ * Executes the command.\r
+ * @name CKEDITOR.commandDefinition.prototype.exec\r
+ * @function\r
+ * @param {CKEDITOR.editor} editor The editor within which run the command.\r
+ * @param {Object} [data] Additional data to be used to execute the command.\r
+ * @returns {Boolean} Whether the command has been successfully executed.\r
+ *             Defaults to "true", if nothing is returned.\r
+ * @example\r
+ * editorInstance.addCommand( 'sample',\r
+ * {\r
+ *     exec : function( editor )\r
+ *     {\r
+ *         alert( 'Executing a command for the editor name "' + editor.name + '"!' );\r
+ *     }\r
+ * });\r
+ */\r
+\r
+/**\r
+ * Whether the command need to be hooked into the redo/undo system.\r
+ * @name  CKEDITOR.commandDefinition.canUndo\r
+ * @type {Boolean} If not defined or 'true' both hook into undo system, set it\r
+ *             to 'false' explicitly  keep it out.\r
+ * @field\r
+ * @example\r
+ * editorInstance.addCommand( 'alertName',\r
+ * {\r
+ *     exec : function( editor )\r
+ *     {\r
+ *         alert( editor.name );\r
+ *     },\r
+ *     canUndo : false    // No support for undo/redo\r
+ * });\r
+ */\r
+\r
+/**\r
+ * Whether the command is asynchronous, which means the 'afterCommandExec' event\r
+ * will be fired by the command itself manually, and the 'exec' function return value\r
+ * of this command is not to be returned.\r
+ * @name  CKEDITOR.commandDefinition.async\r
+ * @type {Boolean} If defined as 'true', the command is asynchronous.\r
+ * @example\r
+ * editorInstance.addCommand( 'alertName',\r
+ * {\r
+ *     exec : function( editor )\r
+ *     {\r
+ *         // Asynchronous operation below.\r
+ *         CKEDITOR.ajax.loadXml( 'data.xml' );\r
+ *     },\r
+ *     async : true    // The command need some time to complete after exec function returns.\r
+ * });\r
+ */\r