/** * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved. * For licensing, see LICENSE.md. */ /** * @module enter/enterobserver */ import Observer from '@ckeditor/ckeditor5-engine/src/view/observer/observer'; import DomEventData from '@ckeditor/ckeditor5-engine/src/view/observer/domeventdata'; import { keyCodes } from '@ckeditor/ckeditor5-utils/src/keyboard'; /** * Enter observer introduces the {@link module:engine/view/document~Document#event:enter} event. * * @extends module:engine/view/observer~Observer */ export default class EnterObserver extends Observer { constructor( view ) { super( view ); const document = this.document; document.on( 'keydown', ( evt, data ) => { if ( this.isEnabled && data.keyCode == keyCodes.enter ) { // Save the event object to check later if it was stopped or not. let event; document.once( 'enter', evt => ( event = evt ), { priority: 'highest' } ); document.fire( 'enter', new DomEventData( document, data.domEvent, { isSoft: data.shiftKey } ) ); // Stop `keydown` event if `enter` event was stopped. // https://github.com/ckeditor/ckeditor5/issues/753 if ( event && event.stop.called ) { evt.stop(); } } } ); } /** * @inheritDoc */ observe() {} } /** * Event fired when the user presses the Enter key. * * Note: This event is fired by the {@link module:enter/enterobserver~EnterObserver observer} * (usually registered by the {@link module:enter/enter~Enter Enter feature} and * {@link module:enter/softenter~SoftEnter SoftEnter feature}). * * @event module:engine/view/document~Document#event:enter * @param {module:engine/view/observer/domeventdata~DomEventData} data */