namibia
df0489e1eeeeab5a9bd44e1d84fce49924fe1bac
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 |
/* Copyright (c) 2003-2011, CKSource - Frederico Knabben. All rights reserved. For licensing, see LICENSE.html or http://ckeditor.com/license */ /** * Creates a command class instance. * @class Represents a command that can be executed on an editor instance. * @param {CKEDITOR.editor} editor The editor instance this command will be * related to. * @param {CKEDITOR.commandDefinition} commandDefinition The command * definition. * @augments CKEDITOR.event * @example * var command = new CKEDITOR.command( editor, * { * exec : function( editor ) * { * alert( editor.document.getBody().getHtml() ); * } * }); */ CKEDITOR.command = function( editor, commandDefinition ) { /** * Lists UI items that are associated to this command. This list can be * used to interact with the UI on command execution (by the execution code * itself, for example). * @type Array * @example * alert( 'Number of UI items associated to this command: ' + command.<b>uiItems</b>.length ); */ this.uiItems = []; /** * Executes the command. * @param {Object} [data] Any data to pass to the command. Depends on the * command implementation and requirements. * @returns {Boolean} A boolean indicating that the command has been * successfully executed. * @example * command.<b>exec()</b>; // The command gets executed. */ this.exec = function( data ) { if ( this.state == CKEDITOR.TRISTATE_DISABLED ) return false; if ( this.editorFocus ) // Give editor focus if necessary (#4355). editor.focus(); return ( commandDefinition.exec.call( this, editor, data ) !== false ); }; CKEDITOR.tools.extend( this, commandDefinition, // Defaults /** @lends CKEDITOR.command.prototype */ { /** * The editor modes within which the command can be executed. The * execution will have no action if the current mode is not listed * in this property. * @type Object * @default { wysiwyg : 1 } * @see CKEDITOR.editor.prototype.mode * @example * // Enable the command in both WYSIWYG and Source modes. * command.<b>modes</b> = { wysiwyg : 1, source : 1 }; * @example * // Enable the command in Source mode only. * command.<b>modes</b> = { source : 1 }; */ modes : { wysiwyg : 1 }, /** * Indicates that the editor will get the focus before executing * the command. * @type Boolean * @default true * @example * // Do not force the editor to have focus when executing the command. * command.<b>editorFocus</b> = false; */ editorFocus : 1, /** * Indicates the editor state. Possible values are: * <ul> * <li>{@link CKEDITOR.TRISTATE_DISABLED}: the command is * disabled. It's execution will have no effect. Same as * {@link disable}.</li> * <li>{@link CKEDITOR.TRISTATE_ON}: the command is enabled * and currently active in the editor (for context sensitive commands, * for example).</li> * <li>{@link CKEDITOR.TRISTATE_OFF}: the command is enabled * and currently inactive in the editor (for context sensitive * commands, for example).</li> * </ul> * Do not set this property directly, using the {@link #setState} * method instead. * @type Number * @default {@link CKEDITOR.TRISTATE_OFF} * @example * if ( command.<b>state</b> == CKEDITOR.TRISTATE_DISABLED ) * alert( 'This command is disabled' ); */ state : CKEDITOR.TRISTATE_OFF }); // Call the CKEDITOR.event constructor to initialize this instance. CKEDITOR.event.call( this ); }; CKEDITOR.command.prototype = { /** * Enables the command for execution. The command state (see * {@link CKEDITOR.command.prototype.state}) available before disabling it * is restored. * @example * command.<b>enable()</b>; * command.exec(); // Execute the command. */ enable : function() { if ( this.state == CKEDITOR.TRISTATE_DISABLED ) this.setState( ( !this.preserveState || ( typeof this.previousState == 'undefined' ) ) ? CKEDITOR.TRISTATE_OFF : this.previousState ); }, /** * Disables the command for execution. The command state (see * {@link CKEDITOR.command.prototype.state}) will be set to * {@link CKEDITOR.TRISTATE_DISABLED}. * @example * command.<b>disable()</b>; * command.exec(); // "false" - Nothing happens. */ disable : function() { this.setState( CKEDITOR.TRISTATE_DISABLED ); }, /** * Sets the command state. * @param {Number} newState The new state. See {@link #state}. * @returns {Boolean} Returns "true" if the command state changed. * @example * command.<b>setState( CKEDITOR.TRISTATE_ON )</b>; * command.exec(); // Execute the command. * command.<b>setState( CKEDITOR.TRISTATE_DISABLED )</b>; * command.exec(); // "false" - Nothing happens. * command.<b>setState( CKEDITOR.TRISTATE_OFF )</b>; * command.exec(); // Execute the command. */ setState : function( newState ) { // Do nothing if there is no state change. if ( this.state == newState ) return false; this.previousState = this.state; // Set the new state. this.state = newState; // Fire the "state" event, so other parts of the code can react to the // change. this.fire( 'state' ); return true; }, /** * Toggles the on/off (active/inactive) state of the command. This is * mainly used internally by context sensitive commands. * @example * command.<b>toggleState()</b>; */ toggleState : function() { if ( this.state == CKEDITOR.TRISTATE_OFF ) this.setState( CKEDITOR.TRISTATE_ON ); else if ( this.state == CKEDITOR.TRISTATE_ON ) this.setState( CKEDITOR.TRISTATE_OFF ); } }; CKEDITOR.event.implementOn( CKEDITOR.command.prototype, true ); /** * Indicates the previous command state. * @name CKEDITOR.command.prototype.previousState * @type Number * @see #state * @example * alert( command.<b>previousState</b> ); */ /** * Fired when the command state changes. * @name CKEDITOR.command#state * @event * @example * command.on( <b>'state'</b> , function( e ) * { * // Alerts the new state. * alert( this.state ); * }); */ |
Commits for namibiapublic/scripts/ckeditor/_source/core/command.js
Revision | Author | Commited | Message |
---|---|---|---|
df0489 ... | Mark | Fri 14 Oct, 2016 10:01:00 +0000 | initial commit |