8
0

domeventobserver.js 6.1 KB

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