2 Copyright (c) 2003-2011, CKSource - Frederico Knabben. All rights reserved.
\r
3 For licensing, see LICENSE.html or http://ckeditor.com/license
\r
7 * @fileOverview Defines the "virtual" {@link CKEDITOR.commandDefinition} class,
\r
8 * which contains the defintion of a command. This file is for
\r
9 * documentation purposes only.
\r
13 * (Virtual Class) Do not call this constructor. This class is not really part
\r
15 * @name CKEDITOR.commandDefinition
\r
16 * @class Virtual class that illustrates the features of command objects to be
\r
17 * passed to the {@link CKEDITOR.editor.prototype.addCommand} function.
\r
22 * The function to be fired when the commend is executed.
\r
23 * @name CKEDITOR.commandDefinition.prototype.exec
\r
25 * @param {CKEDITOR.editor} editor The editor within which run the command.
\r
26 * @param {Object} [data] Additional data to be used to execute the command.
\r
27 * @returns {Boolean} Whether the command has been successfully executed.
\r
28 * Defaults to "true", if nothing is returned.
\r
30 * editorInstance.addCommand( 'sample',
\r
32 * exec : function( editor )
\r
34 * alert( 'Executing a command for the editor name "' + editor.name + '"!' );
\r
40 * Whether the command need to be hooked into the redo/undo system.
\r
41 * @name CKEDITOR.commandDefinition.prototype.canUndo
\r
46 * editorInstance.addCommand( 'alertName',
\r
48 * exec : function( editor )
\r
50 * alert( editor.name );
\r
52 * canUndo : false // No support for undo/redo
\r
57 * Whether the command is asynchronous, which means that the
\r
58 * {@link CKEDITOR.editor#event:afterCommandExec} event will be fired by the
\r
59 * command itself manually, and that the return value of this command is not to
\r
60 * be returned by the {@link CKEDITOR.command#exec} function.
\r
61 * @name CKEDITOR.commandDefinition.prototype.async
\r
65 * editorInstance.addCommand( 'loadOptions',
\r
67 * exec : function( editor )
\r
69 * // Asynchronous operation below.
\r
70 * CKEDITOR.ajax.loadXml( 'data.xml', function()
\r
72 * editor.fire( 'afterCommandExec' );
\r
75 * async : true // The command need some time to complete after exec function returns.
\r
80 * Whether the command should give focus to the editor before execution.
\r
81 * @name CKEDITOR.commandDefinition.prototype.editorFocus
\r
84 * @see CKEDITOR.command#editorFocus
\r
86 * editorInstance.addCommand( 'maximize',
\r
88 * exec : function( editor )
\r
92 * editorFocus : false // The command doesn't require focusing the editing document.
\r
98 * Whether the command state should be set to {@link CKEDITOR.TRISTATE_DISABLED} on startup.
\r
99 * @name CKEDITOR.commandDefinition.prototype.startDisabled
\r
103 * editorInstance.addCommand( 'unlink',
\r
105 * exec : function( editor )
\r
109 * startDisabled : true // Command is unavailable until selection is inside a link.
\r
114 * The editor modes within which the command can be executed. The execution
\r
115 * will have no action if the current mode is not listed in this property.
\r
116 * @name CKEDITOR.commandDefinition.prototype.modes
\r
118 * @default { wysiwyg : 1 }
\r
119 * @see CKEDITOR.command#modes
\r
121 * editorInstance.addCommand( 'link',
\r
123 * exec : function( editor )
\r
127 * modes : { wysiwyg : 1 } // Command is available in wysiwyg mode only.
\r