domeventobserver.js 6.2 KB

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