-
Notifications
You must be signed in to change notification settings - Fork 3.6k
/
multicommand.ts
99 lines (86 loc) · 2.97 KB
/
multicommand.ts
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
/**
* @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
*/
/**
* @module core/multicommand
*/
import Command from './command.js';
import {
insertToPriorityArray,
type PriorityString,
type ObservableChangeEvent
} from '@ckeditor/ckeditor5-utils';
/**
* A CKEditor command that aggregates other commands.
*
* This command is used to proxy multiple commands. The multi-command is enabled when
* at least one of its registered child commands is enabled.
* When executing a multi-command, the first enabled command with highest priority will be executed.
*
* ```ts
* const multiCommand = new MultiCommand( editor );
*
* const commandFoo = new Command( editor );
* const commandBar = new Command( editor );
*
* // Register a child command.
* multiCommand.registerChildCommand( commandFoo );
* // Register a child command with a low priority.
* multiCommand.registerChildCommand( commandBar, { priority: 'low' } );
*
* // Enable one of the commands.
* commandBar.isEnabled = true;
*
* multiCommand.execute(); // Will execute commandBar.
* ```
*/
export default class MultiCommand extends Command {
/**
* Registered child commands definitions.
*/
private _childCommandsDefinitions: Array<{ command: Command; priority: PriorityString }> = [];
/**
* @inheritDoc
*/
public override refresh(): void {
// 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()`}.
*/
public override execute( ...args: Array<unknown> ): unknown {
const command = this._getFirstEnabledCommand();
return !!command && command.execute( args );
}
/**
* Registers a child command.
*
* @param options An object with configuration options.
* @param options.priority Priority of a command to register.
*/
public registerChildCommand(
command: Command,
options: { priority?: PriorityString } = {}
): void {
insertToPriorityArray( this._childCommandsDefinitions, { command, priority: options.priority || 'normal' } );
// Change multi-command enabled state when one of registered commands changes state.
command.on<ObservableChangeEvent<boolean>>( 'change:isEnabled', () => this._checkEnabled() );
this._checkEnabled();
}
/**
* Checks if any of child commands is enabled.
*/
private _checkEnabled(): void {
this.isEnabled = !!this._getFirstEnabledCommand();
}
/**
* Returns a first enabled command with the highest priority or `undefined` if none of them is enabled.
*/
private _getFirstEnabledCommand(): Command | undefined {
const commandDefinition = this._childCommandsDefinitions.find( ( { command } ) => command.isEnabled );
return commandDefinition && commandDefinition.command;
}
}