domeventobserver.js 6.0 KB

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