domeventobserver.js 3.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150
  1. /**
  2. * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* globals MouseEvent, document */
  6. import DomEventObserver from 'ckeditor5-engine/src/view/observer/domeventobserver';
  7. import Observer from 'ckeditor5-engine/src/view/observer/observer';
  8. import ViewDocument from 'ckeditor5-engine/src/view/document';
  9. class ClickObserver extends DomEventObserver {
  10. constructor( document ) {
  11. super( document );
  12. this.domEventType = 'click';
  13. }
  14. onDomEvent( domEvt ) {
  15. this.fire( 'click', domEvt, { foo: 1, bar: 2 } );
  16. }
  17. }
  18. class MultiObserver extends DomEventObserver {
  19. constructor( document ) {
  20. super( document );
  21. this.domEventType = [ 'evt1', 'evt2' ];
  22. }
  23. onDomEvent( domEvt ) {
  24. this.fire( domEvt.type, domEvt );
  25. }
  26. }
  27. describe( 'DomEventObserver', () => {
  28. let viewDocument;
  29. beforeEach( () => {
  30. viewDocument = new ViewDocument();
  31. } );
  32. afterEach( () => {
  33. viewDocument.destroy();
  34. } );
  35. describe( 'constructor()', () => {
  36. it( 'should create Observer with properties', () => {
  37. const observer = new DomEventObserver( viewDocument );
  38. expect( observer ).to.be.an.instanceof( Observer );
  39. } );
  40. } );
  41. it( 'should add event listener', () => {
  42. const domElement = document.createElement( 'p' );
  43. const domEvent = new MouseEvent( 'click' );
  44. const evtSpy = sinon.spy();
  45. viewDocument.createRoot( domElement, 'root' );
  46. viewDocument.addObserver( ClickObserver );
  47. viewDocument.on( 'click', evtSpy );
  48. domElement.dispatchEvent( domEvent );
  49. expect( evtSpy.calledOnce ).to.be.true;
  50. const data = evtSpy.args[ 0 ][ 1 ];
  51. expect( data ).to.have.property( 'foo', 1 );
  52. expect( data ).to.have.property( 'bar', 2 );
  53. expect( data ).to.have.property( 'domEvent', domEvent );
  54. } );
  55. it( 'should add multiple event listeners', () => {
  56. const domElement = document.createElement( 'p' );
  57. const domEvent1 = new MouseEvent( 'evt1' );
  58. const domEvent2 = new MouseEvent( 'evt2' );
  59. const evtSpy1 = sinon.spy();
  60. const evtSpy2 = sinon.spy();
  61. viewDocument.createRoot( domElement, 'root' );
  62. viewDocument.addObserver( MultiObserver );
  63. viewDocument.on( 'evt1', evtSpy1 );
  64. viewDocument.on( 'evt2', evtSpy2 );
  65. domElement.dispatchEvent( domEvent1 );
  66. expect( evtSpy1.calledOnce ).to.be.true;
  67. domElement.dispatchEvent( domEvent2 );
  68. expect( evtSpy2.calledOnce ).to.be.true;
  69. } );
  70. it( 'should not fire event if observer is disabled', () => {
  71. const domElement = document.createElement( 'p' );
  72. const domEvent = new MouseEvent( 'click' );
  73. const evtSpy = sinon.spy();
  74. viewDocument.createRoot( domElement, 'root' );
  75. const testObserver = viewDocument.addObserver( ClickObserver );
  76. viewDocument.on( 'click', evtSpy );
  77. testObserver.disable();
  78. domElement.dispatchEvent( domEvent );
  79. expect( evtSpy.called ).to.be.false;
  80. } );
  81. it( 'should fire event if observer is disabled and re-enabled', () => {
  82. const domElement = document.createElement( 'p' );
  83. const domEvent = new MouseEvent( 'click' );
  84. const evtSpy = sinon.spy();
  85. viewDocument.createRoot( domElement, 'root' );
  86. const testObserver = viewDocument.addObserver( ClickObserver );
  87. viewDocument.on( 'click', evtSpy );
  88. testObserver.disable();
  89. domElement.dispatchEvent( domEvent );
  90. expect( evtSpy.called ).to.be.false;
  91. testObserver.enable();
  92. domElement.dispatchEvent( domEvent );
  93. expect( evtSpy.calledOnce ).to.be.true;
  94. } );
  95. describe( 'fire', () => {
  96. it( 'should do nothing if observer is disabled', () => {
  97. const testObserver = new ClickObserver( viewDocument );
  98. const fireSpy = sinon.spy( viewDocument, 'fire' );
  99. testObserver.disable();
  100. testObserver.fire( 'click', {} );
  101. expect( fireSpy.called ).to.be.false;
  102. testObserver.enable();
  103. testObserver.fire( 'click', {} );
  104. expect( fireSpy.calledOnce ).to.be.true;
  105. } );
  106. } );
  107. } );