enterobserver.js 1.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. /**
  2. * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /**
  6. * @module enter/enterobserver
  7. */
  8. import Observer from '../engine/view/observer/observer.js';
  9. import DomEventData from '../engine/view/observer/domeventdata.js';
  10. import { keyCodes } from '../utils/keyboard.js';
  11. /**
  12. * Enter observer introduces the {@link module:engine/view/document~Document#enter} event.
  13. *
  14. * @extends module:engine/view/observer~Observer
  15. */
  16. export default class EnterObserver extends Observer {
  17. constructor( document ) {
  18. super( document );
  19. document.on( 'keydown', ( evt, data ) => {
  20. if ( this.isEnabled && data.keyCode == keyCodes.enter ) {
  21. document.fire( 'enter', new DomEventData( document, data.domEvent ) );
  22. }
  23. } );
  24. }
  25. /**
  26. * @inheritDoc
  27. */
  28. observe() {}
  29. }
  30. /**
  31. * Event fired when the user presses the <kbd>Enter</kbd> key.
  32. *
  33. * Note: This event is fired by the {@link module:enter/enterobserver~EnterObserver observer}
  34. * (usually registered by the {@link module:enter/enter~Enter Enter feature}).
  35. *
  36. * @event module:engine/view/document~Document#event:enter
  37. * @param {module:engine/view/observer/domeventdata~DomEventData} data
  38. */