8
0

domeventobserver.js 4.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174
  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 '../../../src/view/observer/domeventobserver';
  7. import Observer from '../../../src/view/observer/observer';
  8. import ViewDocument from '../../../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. class ClickCapturingObserver extends ClickObserver {
  28. constructor( document ) {
  29. super( document );
  30. this.useCapture = true;
  31. }
  32. }
  33. describe( 'DomEventObserver', () => {
  34. let viewDocument;
  35. beforeEach( () => {
  36. viewDocument = new ViewDocument();
  37. } );
  38. afterEach( () => {
  39. viewDocument.destroy();
  40. } );
  41. describe( 'constructor()', () => {
  42. it( 'should create Observer with properties', () => {
  43. const observer = new DomEventObserver( viewDocument );
  44. expect( observer ).to.be.an.instanceof( Observer );
  45. } );
  46. } );
  47. it( 'should add event listener', () => {
  48. const domElement = document.createElement( 'p' );
  49. const domEvent = new MouseEvent( 'click' );
  50. const evtSpy = sinon.spy();
  51. viewDocument.createRoot( domElement, 'root' );
  52. viewDocument.addObserver( ClickObserver );
  53. viewDocument.on( 'click', evtSpy );
  54. domElement.dispatchEvent( domEvent );
  55. expect( evtSpy.calledOnce ).to.be.true;
  56. const data = evtSpy.args[ 0 ][ 1 ];
  57. expect( data ).to.have.property( 'foo', 1 );
  58. expect( data ).to.have.property( 'bar', 2 );
  59. expect( data ).to.have.property( 'domEvent', domEvent );
  60. } );
  61. it( 'should add multiple event listeners', () => {
  62. const domElement = document.createElement( 'p' );
  63. const domEvent1 = new MouseEvent( 'evt1' );
  64. const domEvent2 = new MouseEvent( 'evt2' );
  65. const evtSpy1 = sinon.spy();
  66. const evtSpy2 = sinon.spy();
  67. viewDocument.createRoot( domElement, 'root' );
  68. viewDocument.addObserver( MultiObserver );
  69. viewDocument.on( 'evt1', evtSpy1 );
  70. viewDocument.on( 'evt2', evtSpy2 );
  71. domElement.dispatchEvent( domEvent1 );
  72. expect( evtSpy1.calledOnce ).to.be.true;
  73. domElement.dispatchEvent( domEvent2 );
  74. expect( evtSpy2.calledOnce ).to.be.true;
  75. } );
  76. it( 'should not fire event if observer is disabled', () => {
  77. const domElement = document.createElement( 'p' );
  78. const domEvent = new MouseEvent( 'click' );
  79. const evtSpy = sinon.spy();
  80. viewDocument.createRoot( domElement, 'root' );
  81. const testObserver = viewDocument.addObserver( ClickObserver );
  82. viewDocument.on( 'click', evtSpy );
  83. testObserver.disable();
  84. domElement.dispatchEvent( domEvent );
  85. expect( evtSpy.called ).to.be.false;
  86. } );
  87. it( 'should fire event if observer is disabled and re-enabled', () => {
  88. const domElement = document.createElement( 'p' );
  89. const domEvent = new MouseEvent( 'click' );
  90. const evtSpy = sinon.spy();
  91. viewDocument.createRoot( domElement, 'root' );
  92. const testObserver = viewDocument.addObserver( ClickObserver );
  93. viewDocument.on( 'click', evtSpy );
  94. testObserver.disable();
  95. domElement.dispatchEvent( domEvent );
  96. expect( evtSpy.called ).to.be.false;
  97. testObserver.enable();
  98. domElement.dispatchEvent( domEvent );
  99. expect( evtSpy.calledOnce ).to.be.true;
  100. } );
  101. it( 'should allow to listen events on capturing phase', ( done ) => {
  102. const domElement = document.createElement( 'div' );
  103. const childDomElement = document.createElement( 'p' );
  104. const domEvent = new MouseEvent( 'click' );
  105. domElement.appendChild( childDomElement );
  106. viewDocument.createRoot( domElement, 'root' );
  107. viewDocument.addObserver( ClickCapturingObserver );
  108. viewDocument.on( 'click', ( evt, domEventData ) => {
  109. expect( domEventData.domEvent.eventPhase ).to.equal( domEventData.domEvent.CAPTURING_PHASE );
  110. done();
  111. } );
  112. childDomElement.dispatchEvent( domEvent );
  113. } );
  114. describe( 'fire', () => {
  115. it( 'should do nothing if observer is disabled', () => {
  116. const testObserver = new ClickObserver( viewDocument );
  117. const fireSpy = sinon.spy( viewDocument, 'fire' );
  118. testObserver.disable();
  119. testObserver.fire( 'click', {} );
  120. expect( fireSpy.called ).to.be.false;
  121. testObserver.enable();
  122. testObserver.fire( 'click', {} );
  123. expect( fireSpy.calledOnce ).to.be.true;
  124. } );
  125. } );
  126. } );