@ckeditor/ckeditor5-core 35.2.1 → 35.3.0

package/src/multicommand.js

@@ -2,15 +2,11 @@
  * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-
 import Command from './command';
-
 import insertToPriorityArray from '@ckeditor/ckeditor5-utils/src/inserttopriorityarray';
-
 /**
  * @module core/multicommand
  */
-
 /**
  * A CKEditor command that aggregates other commands.
  *
@@ -36,73 +32,63 @@ import insertToPriorityArray from '@ckeditor/ckeditor5-utils/src/inserttopriorit
  * @extends module:core/command~Command
  */
 export default class MultiCommand extends Command {
-	/**
-	 * @inheritDoc
-	 */
-	constructor( editor ) {
-		super( editor );
-
-		/**
-		 * Registered child commands definitions.
-		 *
-		 * @type {Array.<Object>}
-		 * @private
-		 */
-		this._childCommandsDefinitions = [];
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	refresh() {
-		// Override base command refresh(): the command's state is changed when one of child commands changes states.
-	}
-
-	/**
-	 * Executes the first enabled command which has the highest priority of all registered child commands.
-	 *
-	 * @returns {*} The value returned by the {@link module:core/command~Command#execute `command.execute()`}.
-	 */
-	execute( ...args ) {
-		const command = this._getFirstEnabledCommand();
-
-		return !!command && command.execute( args );
-	}
-
-	/**
-	 * Registers a child command.
-	 *
-	 * @param {module:core/command~Command} command
-	 * @param {Object} options An object with configuration options.
-	 * @param {module:utils/priorities~PriorityString} [options.priority='normal'] Priority of a command to register.
-	 */
-	registerChildCommand( command, options = { priority: 'normal' } ) {
-		insertToPriorityArray( this._childCommandsDefinitions, { command, priority: options.priority } );
-
-		// Change multi command enabled state when one of registered commands changes state.
-		command.on( 'change:isEnabled', () => this._checkEnabled() );
-
-		this._checkEnabled();
-	}
-
-	/**
-	 * Checks if any of child commands is enabled.
-	 *
-	 * @private
-	 */
-	_checkEnabled() {
-		this.isEnabled = !!this._getFirstEnabledCommand();
-	}
-
-	/**
-	 * Returns a first enabled command with the highest priority or `undefined` if none of them is enabled.
-	 *
-	 * @returns {module:core/command~Command|undefined}
-	 * @private
-	 */
-	_getFirstEnabledCommand() {
-		const commandDefinition = this._childCommandsDefinitions.find( ( { command } ) => command.isEnabled );
-
-		return commandDefinition && commandDefinition.command;
-	}
+    /**
+     * @inheritDoc
+     */
+    constructor(editor) {
+        super(editor);
+        /**
+         * Registered child commands definitions.
+         *
+         * @type {Array.<Object>}
+         * @private
+         */
+        this._childCommandsDefinitions = [];
+    }
+    /**
+     * @inheritDoc
+     */
+    refresh() {
+        // Override base command refresh(): the command's state is changed when one of child commands changes states.
+    }
+    /**
+     * Executes the first enabled command which has the highest priority of all registered child commands.
+     *
+     * @returns {*} The value returned by the {@link module:core/command~Command#execute `command.execute()`}.
+     */
+    execute(...args) {
+        const command = this._getFirstEnabledCommand();
+        return !!command && command.execute(args);
+    }
+    /**
+     * Registers a child command.
+     *
+     * @param {module:core/command~Command} command
+     * @param {Object} options An object with configuration options.
+     * @param {module:utils/priorities~PriorityString} [options.priority='normal'] Priority of a command to register.
+     */
+    registerChildCommand(command, options = {}) {
+        insertToPriorityArray(this._childCommandsDefinitions, { command, priority: options.priority || 'normal' });
+        // Change multi command enabled state when one of registered commands changes state.
+        command.on('change:isEnabled', () => this._checkEnabled());
+        this._checkEnabled();
+    }
+    /**
+     * Checks if any of child commands is enabled.
+     *
+     * @private
+     */
+    _checkEnabled() {
+        this.isEnabled = !!this._getFirstEnabledCommand();
+    }
+    /**
+     * Returns a first enabled command with the highest priority or `undefined` if none of them is enabled.
+     *
+     * @returns {module:core/command~Command|undefined}
+     * @private
+     */
+    _getFirstEnabledCommand() {
+        const commandDefinition = this._childCommandsDefinitions.find(({ command }) => command.isEnabled);
+        return commandDefinition && commandDefinition.command;
+    }
 }

package/src/pendingactions.js

@@ -2,16 +2,13 @@
  * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-
 /**
  * @module core/pendingactions
  */
-
 import ContextPlugin from './contextplugin';
-import ObservableMixin from '@ckeditor/ckeditor5-utils/src/observablemixin';
+import { Observable } from '@ckeditor/ckeditor5-utils/src/observablemixin';
 import Collection from '@ckeditor/ckeditor5-utils/src/collection';
 import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
-
 /**
  * The list of pending editor actions.
  *
@@ -53,103 +50,80 @@ import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
  * @extends module:core/contextplugin~ContextPlugin
  */
 export default class PendingActions extends ContextPlugin {
-	/**
-	 * @inheritDoc
-	 */
-	static get pluginName() {
-		return 'PendingActions';
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	init() {
-		/**
-		 * Defines whether there is any registered pending action.
-		 *
-		 * @readonly
-		 * @observable
-		 * @member {Boolean} #hasAny
-		 */
-		this.set( 'hasAny', false );
-
-		/**
-		 * A list of pending actions.
-		 *
-		 * @private
-		 * @type {module:utils/collection~Collection}
-		 */
-		this._actions = new Collection( { idProperty: '_id' } );
-		this._actions.delegate( 'add', 'remove' ).to( this );
-	}
-
-	/**
-	 * Adds an action to the list of pending actions.
-	 *
-	 * This method returns an action object with an observable message property.
-	 * The action object can be later used in the {@link #remove} method. It also allows you to change the message.
-	 *
-	 * @param {String} message The action message.
-	 * @returns {Object} An observable object that represents a pending action.
-	 */
-	add( message ) {
-		if ( typeof message !== 'string' ) {
-			/**
-			 * The message must be a string.
-			 *
-			 * @error pendingactions-add-invalid-message
-			 */
-			throw new CKEditorError( 'pendingactions-add-invalid-message', this );
-		}
-
-		const action = Object.create( ObservableMixin );
-
-		action.set( 'message', message );
-		this._actions.add( action );
-		this.hasAny = true;
-
-		return action;
-	}
-
-	/**
-	 * Removes an action from the list of pending actions.
-	 *
-	 * @param {Object} action An action object.
-	 */
-	remove( action ) {
-		this._actions.remove( action );
-		this.hasAny = !!this._actions.length;
-	}
-
-	/**
-	 * Returns the first action from the list or null when list is empty
-	 *
-	 * returns {Object|null} The pending action object.
-	 */
-	get first() {
-		return this._actions.get( 0 );
-	}
-
-	/**
-	 * Iterable interface.
-	 *
-	 * @returns {Iterable.<*>}
-	 */
-	[ Symbol.iterator ]() {
-		return this._actions[ Symbol.iterator ]();
-	}
-
-	/**
-	 * Fired when an action is added to the list.
-	 *
-	 * @event add
-	 * @param {Object} action The added action.
-	 */
-
-	/**
-	 * Fired when an action is removed from the list.
-	 *
-	 * @event remove
-	 * @param {Object} action The removed action.
-	 */
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'PendingActions';
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        /**
+         * Defines whether there is any registered pending action.
+         *
+         * @readonly
+         * @observable
+         * @member {Boolean} #hasAny
+         */
+        this.set('hasAny', false);
+        /**
+         * A list of pending actions.
+         *
+         * @private
+         * @type {module:utils/collection~Collection}
+         */
+        this._actions = new Collection({ idProperty: '_id' });
+        this._actions.delegate('add', 'remove').to(this);
+    }
+    /**
+     * Adds an action to the list of pending actions.
+     *
+     * This method returns an action object with an observable message property.
+     * The action object can be later used in the {@link #remove} method. It also allows you to change the message.
+     *
+     * @param {String} message The action message.
+     * @returns {Object} An observable object that represents a pending action.
+     */
+    add(message) {
+        if (typeof message !== 'string') {
+            /**
+             * The message must be a string.
+             *
+             * @error pendingactions-add-invalid-message
+             */
+            throw new CKEditorError('pendingactions-add-invalid-message', this);
+        }
+        const action = new Observable();
+        action.set('message', message);
+        this._actions.add(action);
+        this.hasAny = true;
+        return action;
+    }
+    /**
+     * Removes an action from the list of pending actions.
+     *
+     * @param {Object} action An action object.
+     */
+    remove(action) {
+        this._actions.remove(action);
+        this.hasAny = !!this._actions.length;
+    }
+    /**
+     * Returns the first action from the list or null when list is empty
+     *
+     * returns {Object|null} The pending action object.
+     */
+    get first() {
+        return this._actions.get(0);
+    }
+    /**
+     * Iterable interface.
+     *
+     * @returns {Iterable.<*>}
+     */
+    [Symbol.iterator]() {
+        return this._actions[Symbol.iterator]();
+    }
 }