-
-
Notifications
You must be signed in to change notification settings - Fork 3.7k
/
tablepropertycommand.js
98 lines (84 loc) · 2.5 KB
/
tablepropertycommand.js
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
/**
* @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
*/
/**
* @module table/tableproperties/commands/tablepropertycommand
*/
import Command from '@ckeditor/ckeditor5-core/src/command';
/**
* The table cell attribute command.
*
* This command is a base command for other table property commands.
*
* @extends module:core/command~Command
*/
export default class TablePropertyCommand extends Command {
/**
* Creates a new `TablePropertyCommand` instance.
*
* @param {module:core/editor/editor~Editor} editor An editor in which this command will be used.
* @param {String} attributeName Table cell attribute name.
*/
constructor( editor, attributeName ) {
super( editor );
this.attributeName = attributeName;
}
/**
* @inheritDoc
*/
refresh() {
const editor = this.editor;
const selection = editor.model.document.selection;
const table = selection.getFirstPosition().findAncestor( 'table' );
this.isEnabled = !!table;
this.value = this._getValue( table );
}
/**
* Executes the command.
*
* @fires execute
* @param {Object} [options]
* @param {*} [options.value] If set, the command will set the attribute on the selected table.
* If not set, the command will remove the attribute from the selected table.
* @param {module:engine/model/batch~Batch} [options.batch] Pass the model batch instance to the command to aggregate changes,
* for example, to allow a single undo step for multiple executions.
*/
execute( options = {} ) {
const model = this.editor.model;
const selection = model.document.selection;
const { value, batch } = options;
const table = selection.getFirstPosition().findAncestor( 'table' );
const valueToSet = this._getValueToSet( value );
model.enqueueChange( batch || 'default', writer => {
if ( valueToSet ) {
writer.setAttribute( this.attributeName, valueToSet, table );
} else {
writer.removeAttribute( this.attributeName, table );
}
} );
}
/**
* Returns the attribute value for a table.
*
* @param {module:engine/model/element~Element} table
* @returns {String|undefined}
* @private
*/
_getValue( table ) {
if ( !table ) {
return;
}
return table.getAttribute( this.attributeName );
}
/**
* Returns the proper model value. It can be used to add a default unit to numeric values.
*
* @private
* @param {*} value
* @returns {*}
*/
_getValueToSet( value ) {
return value;
}
}