domeventobserver.js 5.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221
  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. import UIElement from '../../../src/view/uielement';
  10. class ClickObserver extends DomEventObserver {
  11. constructor( document ) {
  12. super( document );
  13. this.domEventType = 'click';
  14. }
  15. onDomEvent( domEvt ) {
  16. this.fire( 'click', domEvt, { foo: 1, bar: 2 } );
  17. }
  18. }
  19. class MultiObserver extends DomEventObserver {
  20. constructor( document ) {
  21. super( document );
  22. this.domEventType = [ 'evt1', 'evt2' ];
  23. }
  24. onDomEvent( domEvt ) {
  25. this.fire( domEvt.type, domEvt );
  26. }
  27. }
  28. class ClickCapturingObserver extends ClickObserver {
  29. constructor( document ) {
  30. super( document );
  31. this.useCapture = true;
  32. }
  33. }
  34. describe( 'DomEventObserver', () => {
  35. let viewDocument;
  36. beforeEach( () => {
  37. viewDocument = new ViewDocument();
  38. } );
  39. afterEach( () => {
  40. viewDocument.destroy();
  41. } );
  42. describe( 'constructor()', () => {
  43. it( 'should create Observer with properties', () => {
  44. const observer = new DomEventObserver( viewDocument );
  45. expect( observer ).to.be.an.instanceof( Observer );
  46. } );
  47. } );
  48. it( 'should add event listener', () => {
  49. const domElement = document.createElement( 'p' );
  50. const domEvent = new MouseEvent( 'click' );
  51. const evtSpy = sinon.spy();
  52. viewDocument.createRoot( domElement, 'root' );
  53. viewDocument.addObserver( ClickObserver );
  54. viewDocument.on( 'click', evtSpy );
  55. domElement.dispatchEvent( domEvent );
  56. expect( evtSpy.calledOnce ).to.be.true;
  57. const data = evtSpy.args[ 0 ][ 1 ];
  58. expect( data ).to.have.property( 'foo', 1 );
  59. expect( data ).to.have.property( 'bar', 2 );
  60. expect( data ).to.have.property( 'domEvent', domEvent );
  61. } );
  62. it( 'should add multiple event listeners', () => {
  63. const domElement = document.createElement( 'p' );
  64. const domEvent1 = new MouseEvent( 'evt1' );
  65. const domEvent2 = new MouseEvent( 'evt2' );
  66. const evtSpy1 = sinon.spy();
  67. const evtSpy2 = sinon.spy();
  68. viewDocument.createRoot( domElement, 'root' );
  69. viewDocument.addObserver( MultiObserver );
  70. viewDocument.on( 'evt1', evtSpy1 );
  71. viewDocument.on( 'evt2', evtSpy2 );
  72. domElement.dispatchEvent( domEvent1 );
  73. expect( evtSpy1.calledOnce ).to.be.true;
  74. domElement.dispatchEvent( domEvent2 );
  75. expect( evtSpy2.calledOnce ).to.be.true;
  76. } );
  77. it( 'should not fire event if observer is disabled', () => {
  78. const domElement = document.createElement( 'p' );
  79. const domEvent = new MouseEvent( 'click' );
  80. const evtSpy = sinon.spy();
  81. viewDocument.createRoot( domElement, 'root' );
  82. const testObserver = viewDocument.addObserver( ClickObserver );
  83. viewDocument.on( 'click', evtSpy );
  84. testObserver.disable();
  85. domElement.dispatchEvent( domEvent );
  86. expect( evtSpy.called ).to.be.false;
  87. } );
  88. it( 'should fire event if observer is disabled and re-enabled', () => {
  89. const domElement = document.createElement( 'p' );
  90. const domEvent = new MouseEvent( 'click' );
  91. const evtSpy = sinon.spy();
  92. viewDocument.createRoot( domElement, 'root' );
  93. const testObserver = viewDocument.addObserver( ClickObserver );
  94. viewDocument.on( 'click', evtSpy );
  95. testObserver.disable();
  96. domElement.dispatchEvent( domEvent );
  97. expect( evtSpy.called ).to.be.false;
  98. testObserver.enable();
  99. domElement.dispatchEvent( domEvent );
  100. expect( evtSpy.calledOnce ).to.be.true;
  101. } );
  102. it( 'should allow to listen events on capturing phase', done => {
  103. const domElement = document.createElement( 'div' );
  104. const childDomElement = document.createElement( 'p' );
  105. const domEvent = new MouseEvent( 'click' );
  106. domElement.appendChild( childDomElement );
  107. viewDocument.createRoot( domElement, 'root' );
  108. viewDocument.addObserver( ClickCapturingObserver );
  109. viewDocument.on( 'click', ( evt, domEventData ) => {
  110. expect( domEventData.domEvent.eventPhase ).to.equal( domEventData.domEvent.CAPTURING_PHASE );
  111. done();
  112. } );
  113. childDomElement.dispatchEvent( domEvent );
  114. } );
  115. describe( 'integration with UIElement', () => {
  116. let domRoot, domEvent, evtSpy, uiElement;
  117. class MyUIElement extends UIElement {
  118. render( domDocument ) {
  119. const root = super.render( domDocument );
  120. root.innerHTML = '<span>foo bar</span>';
  121. return root;
  122. }
  123. }
  124. beforeEach( () => {
  125. domRoot = document.createElement( 'div' );
  126. const viewRoot = viewDocument.createRoot( domRoot, 'root' );
  127. uiElement = new MyUIElement( 'p' );
  128. viewRoot.appendChildren( uiElement );
  129. viewDocument.render();
  130. domEvent = new MouseEvent( 'click', { bubbles: true } );
  131. evtSpy = sinon.spy();
  132. viewDocument.addObserver( ClickObserver );
  133. viewDocument.on( 'click', evtSpy );
  134. } );
  135. it( 'should fire events from UIElement itself', () => {
  136. const domUiElement = domRoot.querySelector( 'p' );
  137. domUiElement.dispatchEvent( domEvent );
  138. const data = evtSpy.args[ 0 ][ 1 ];
  139. sinon.assert.calledOnce( evtSpy );
  140. expect( data.target ).to.equal( uiElement );
  141. } );
  142. it( 'events from inside of UIElement should target UIElement', () => {
  143. const domUiElementChild = domRoot.querySelector( 'span' );
  144. domUiElementChild.dispatchEvent( domEvent );
  145. const data = evtSpy.args[ 0 ][ 1 ];
  146. sinon.assert.calledOnce( evtSpy );
  147. expect( data.target ).to.equal( uiElement );
  148. } );
  149. } );
  150. describe( 'fire', () => {
  151. it( 'should do nothing if observer is disabled', () => {
  152. const testObserver = new ClickObserver( viewDocument );
  153. const fireSpy = sinon.spy( viewDocument, 'fire' );
  154. testObserver.disable();
  155. testObserver.fire( 'click', {} );
  156. expect( fireSpy.called ).to.be.false;
  157. testObserver.enable();
  158. testObserver.fire( 'click', {} );
  159. expect( fireSpy.calledOnce ).to.be.true;
  160. } );
  161. } );
  162. } );