-
-
Notifications
You must be signed in to change notification settings - Fork 3.7k
/
horizontallinecommand.js
116 lines (95 loc) · 3.83 KB
/
horizontallinecommand.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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
/**
* @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
*/
/**
* @module horizontal-line/horizontallinecommand
*/
import Command from '@ckeditor/ckeditor5-core/src/command';
import { findOptimalInsertionPosition } from '@ckeditor/ckeditor5-widget/src/utils';
/**
* The horizontal line command.
*
* The command is registered by {@link module:horizontal-line/horizontallineediting~HorizontalLineEditing} as `'horizontalLine'`.
*
* To insert a horizontal line at the current selection, execute the command:
*
* editor.execute( 'horizontalLine' );
*
* @extends module:core/command~Command
*/
export default class HorizontalLineCommand extends Command {
/**
* @inheritDoc
*/
refresh() {
this.isEnabled = isHorizontalLineAllowed( this.editor.model );
}
/**
* Executes the command.
*
* @fires execute
*/
execute() {
const model = this.editor.model;
model.change( writer => {
const horizontalElement = writer.createElement( 'horizontalLine' );
model.insertContent( horizontalElement );
let nextElement = horizontalElement.nextSibling;
// Check whether an element next to the inserted horizontal line is defined and can contain a text.
const canSetSelection = nextElement && model.schema.checkChild( nextElement, '$text' );
// If the element is missing, but a paragraph could be inserted next to the horizontal line, let's add it.
if ( !canSetSelection && model.schema.checkChild( horizontalElement.parent, 'paragraph' ) ) {
nextElement = writer.createElement( 'paragraph' );
model.insertContent( nextElement, writer.createPositionAfter( horizontalElement ) );
}
// Put the selection inside the element, at the beginning.
if ( nextElement ) {
writer.setSelection( nextElement, 0 );
}
} );
}
}
// Checks if the `horizontalLine` element can be inserted at the current model selection.
//
// @param {module:engine/model/model~Model} model
// @returns {Boolean}
function isHorizontalLineAllowed( model ) {
const schema = model.schema;
const selection = model.document.selection;
return isHorizontalLineAllowedInParent( selection, schema, model ) &&
!checkSelectionOnObject( selection, schema );
}
// Checks if a horizontal line is allowed by the schema in the optimal insertion parent.
//
// @param {module:engine/model/selection~Selection|module:engine/model/documentselection~DocumentSelection} selection
// @param {module:engine/model/schema~Schema} schema
// @param {module:engine/model/model~Model} model Model instance.
// @returns {Boolean}
function isHorizontalLineAllowedInParent( selection, schema, model ) {
const parent = getInsertHorizontalLineParent( selection, model );
return schema.checkChild( parent, 'horizontalLine' );
}
// Checks if the selection is on object.
//
// @param {module:engine/model/selection~Selection|module:engine/model/documentselection~DocumentSelection} selection
// @param {module:engine/model/schema~Schema} schema
// @returns {Boolean}
function checkSelectionOnObject( selection, schema ) {
const selectedElement = selection.getSelectedElement();
return selectedElement && schema.isObject( selectedElement );
}
// Returns a node that will be used to insert a horizontal line with `model.insertContent` to check if the horizontal line can be
// placed there.
//
// @param {module:engine/model/selection~Selection|module:engine/model/documentselection~DocumentSelection} selection
// @param {module:engine/model/model~Model} model Model instance.
// @returns {module:engine/model/element~Element}
function getInsertHorizontalLineParent( selection, model ) {
const insertAt = findOptimalInsertionPosition( selection, model );
const parent = insertAt.parent;
if ( parent.isEmpty && !parent.is( 'element', '$root' ) ) {
return parent.parent;
}
return parent;
}