deleteobserver.js 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  1. /**
  2. * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /**
  6. * @module typing/deleteobserver
  7. */
  8. import Observer from '@ckeditor/ckeditor5-engine/src/view/observer/observer';
  9. import DomEventData from '@ckeditor/ckeditor5-engine/src/view/observer/domeventdata';
  10. import { keyCodes } from '@ckeditor/ckeditor5-utils/src/keyboard';
  11. /**
  12. * Delete observer introduces the {@link module:engine/view/document~Document#event:delete} event.
  13. *
  14. * @extends module:engine/view/observer/observer~Observer
  15. */
  16. export default class DeleteObserver extends Observer {
  17. constructor( document ) {
  18. super( document );
  19. let sequence = 0;
  20. document.on( 'keyup', ( evt, data ) => {
  21. if ( data.keyCode == keyCodes.delete || data.keyCode == keyCodes.backspace ) {
  22. sequence = 0;
  23. }
  24. } );
  25. document.on( 'keydown', ( evt, data ) => {
  26. const deleteData = {};
  27. if ( data.keyCode == keyCodes.delete ) {
  28. deleteData.direction = 'forward';
  29. deleteData.unit = 'character';
  30. } else if ( data.keyCode == keyCodes.backspace ) {
  31. deleteData.direction = 'backward';
  32. deleteData.unit = 'codePoint';
  33. } else {
  34. return;
  35. }
  36. deleteData.unit = data.altKey ? 'word' : deleteData.unit;
  37. deleteData.sequence = ++sequence;
  38. document.fire( 'delete', new DomEventData( document, data.domEvent, deleteData ) );
  39. } );
  40. }
  41. /**
  42. * @inheritDoc
  43. */
  44. observe() {}
  45. }
  46. /**
  47. * Event fired when the user tries to delete content (e.g. presses <kbd>Delete</kbd> or <kbd>Backspace</kbd>).
  48. *
  49. * Note: This event is fired by the {@link module:typing/deleteobserver~DeleteObserver observer}
  50. * (usually registered by the {@link module:typing/delete~Delete delete feature}).
  51. *
  52. * @event module:engine/view/document~Document#event:delete
  53. * @param {module:engine/view/observer/domeventdata~DomEventData} data
  54. * @param {'forward'|'delete'} data.direction The direction in which the deletion should happen.
  55. * @param {'character'|'word'} data.unit The "amount" of content that should be deleted.
  56. * @param {Number} data.sequence A number describing which subsequent delete event it is without the key being released.
  57. * If it's 2 or more it means that the key was pressed and hold.
  58. */