| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112 |
- /**
- * @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 typing/inputcommand
- */
- import Command from '@ckeditor/ckeditor5-core/src/command';
- import ChangeBuffer from './utils/changebuffer';
- /**
- * The input command. Used by the {@link module:typing/input~Input input feature} to handle typing.
- *
- * @extends module:core/command~Command
- */
- export default class InputCommand extends Command {
- /**
- * Creates an instance of the command.
- *
- * @param {module:core/editor/editor~Editor} editor
- * @param {Number} undoStepSize The maximum number of atomic changes
- * which can be contained in one batch in the command buffer.
- */
- constructor( editor, undoStepSize ) {
- super( editor );
- /**
- * Typing's change buffer used to group subsequent changes into batches.
- *
- * @readonly
- * @private
- * @member {module:typing/utils/changebuffer~ChangeBuffer} #_buffer
- */
- this._buffer = new ChangeBuffer( editor.model, undoStepSize );
- /**
- * Stores batches created by the input command. The batches are used to differentiate input batches from other batches using
- * {@link module:typing/input~Input#isInput} method.
- *
- * @type {WeakSet<module:engine/model/batch~Batch>}
- * @protected
- */
- this._batches = new WeakSet();
- }
- /**
- * The current change buffer.
- *
- * @type {module:typing/utils/changebuffer~ChangeBuffer}
- */
- get buffer() {
- return this._buffer;
- }
- /**
- * @inheritDoc
- */
- destroy() {
- super.destroy();
- this._buffer.destroy();
- }
- /**
- * Executes the input command. It replaces the content within the given range with the given text.
- * Replacing is a two step process, first the content within the range is removed and then the new text is inserted
- * at the beginning of the range (which after the removal is a collapsed range).
- *
- * @fires execute
- * @param {Object} [options] The command options.
- * @param {String} [options.text=''] The text to be inserted.
- * @param {module:engine/model/range~Range} [options.range] The range in which the text is inserted. Defaults
- * to the first range in the current selection.
- * @param {module:engine/model/range~Range} [options.resultRange] The range where the selection
- * should be placed after the insertion. If not specified, the selection will be placed right after
- * the inserted text.
- */
- execute( options = {} ) {
- const model = this.editor.model;
- const doc = model.document;
- const text = options.text || '';
- const textInsertions = text.length;
- const selection = options.range ? model.createSelection( options.range ) : doc.selection;
- const resultRange = options.resultRange;
- model.enqueueChange( this._buffer.batch, writer => {
- this._buffer.lock();
- // Store the batch as an 'input' batch for the Input.isInput( batch ) check.
- this._batches.add( this._buffer.batch );
- model.deleteContent( selection );
- if ( text ) {
- model.insertContent( writer.createText( text, doc.selection.getAttributes() ), selection );
- }
- if ( resultRange ) {
- writer.setSelection( resultRange );
- } else if ( !selection.is( 'documentSelection' ) ) {
- writer.setSelection( selection );
- }
- this._buffer.unlock();
- this._buffer.input( textInsertions );
- } );
- }
- }
|