domeventobserver.js 6.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256
  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;
  38. beforeEach( () => {
  39. view = new View( new StylesProcessor() );
  40. viewDocument = view.document;
  41. } );
  42. afterEach( () => {
  43. view.destroy();
  44. } );
  45. describe( 'constructor()', () => {
  46. it( 'should create Observer with properties', () => {
  47. const observer = new DomEventObserver( viewDocument );
  48. expect( observer ).to.be.an.instanceof( Observer );
  49. } );
  50. } );
  51. it( 'should add event listener', () => {
  52. const domElement = document.createElement( 'p' );
  53. const domEvent = new MouseEvent( 'click' );
  54. const evtSpy = sinon.spy();
  55. createViewRoot( viewDocument );
  56. view.attachDomRoot( domElement );
  57. view.addObserver( ClickObserver );
  58. viewDocument.on( 'click', evtSpy );
  59. domElement.dispatchEvent( domEvent );
  60. expect( evtSpy.calledOnce ).to.be.true;
  61. const data = evtSpy.args[ 0 ][ 1 ];
  62. expect( data ).to.have.property( 'foo', 1 );
  63. expect( data ).to.have.property( 'bar', 2 );
  64. expect( data ).to.have.property( 'domEvent', domEvent );
  65. } );
  66. it( 'should add multiple event listeners', () => {
  67. const domElement = document.createElement( 'p' );
  68. const domEvent1 = new MouseEvent( 'evt1' );
  69. const domEvent2 = new MouseEvent( 'evt2' );
  70. const evtSpy1 = sinon.spy();
  71. const evtSpy2 = sinon.spy();
  72. createViewRoot( viewDocument );
  73. view.attachDomRoot( domElement );
  74. view.addObserver( MultiObserver );
  75. viewDocument.on( 'evt1', evtSpy1 );
  76. viewDocument.on( 'evt2', evtSpy2 );
  77. domElement.dispatchEvent( domEvent1 );
  78. expect( evtSpy1.calledOnce ).to.be.true;
  79. domElement.dispatchEvent( domEvent2 );
  80. expect( evtSpy2.calledOnce ).to.be.true;
  81. } );
  82. it( 'should not fire event if observer is disabled', () => {
  83. const domElement = document.createElement( 'p' );
  84. const domEvent = new MouseEvent( 'click' );
  85. const evtSpy = sinon.spy();
  86. createViewRoot( viewDocument );
  87. view.attachDomRoot( domElement );
  88. const testObserver = view.addObserver( ClickObserver );
  89. viewDocument.on( 'click', evtSpy );
  90. testObserver.disable();
  91. domElement.dispatchEvent( domEvent );
  92. expect( evtSpy.called ).to.be.false;
  93. } );
  94. it( 'should not fire event if target is ignored', () => {
  95. const domElement = document.createElement( 'p' );
  96. const domEvent = new MouseEvent( 'click' );
  97. const evtSpy = sinon.spy();
  98. const ignoreEventFromTargetStub = sinon
  99. .stub( Observer.prototype, 'checkShouldIgnoreEventFromTarget' )
  100. .returns( true );
  101. createViewRoot( viewDocument );
  102. view.attachDomRoot( domElement );
  103. view.addObserver( ClickObserver );
  104. viewDocument.on( 'click', evtSpy );
  105. domElement.dispatchEvent( domEvent );
  106. expect( ignoreEventFromTargetStub.called ).to.be.true;
  107. expect( evtSpy.called ).to.be.false;
  108. ignoreEventFromTargetStub.restore();
  109. } );
  110. it( 'should fire event if observer is disabled and re-enabled', () => {
  111. const domElement = document.createElement( 'p' );
  112. const domEvent = new MouseEvent( 'click' );
  113. const evtSpy = sinon.spy();
  114. createViewRoot( viewDocument );
  115. view.attachDomRoot( domElement );
  116. const testObserver = view.addObserver( ClickObserver );
  117. viewDocument.on( 'click', evtSpy );
  118. testObserver.disable();
  119. domElement.dispatchEvent( domEvent );
  120. expect( evtSpy.called ).to.be.false;
  121. testObserver.enable();
  122. domElement.dispatchEvent( domEvent );
  123. expect( evtSpy.calledOnce ).to.be.true;
  124. } );
  125. it( 'should allow to listen events on capturing phase', done => {
  126. const domElement = document.createElement( 'div' );
  127. const childDomElement = document.createElement( 'p' );
  128. const domEvent = new MouseEvent( 'click' );
  129. domElement.appendChild( childDomElement );
  130. createViewRoot( viewDocument );
  131. view.attachDomRoot( domElement );
  132. view.addObserver( ClickCapturingObserver );
  133. viewDocument.on( 'click', ( evt, domEventData ) => {
  134. expect( domEventData.domEvent.eventPhase ).to.equal( domEventData.domEvent.CAPTURING_PHASE );
  135. done();
  136. } );
  137. childDomElement.dispatchEvent( domEvent );
  138. } );
  139. describe( 'integration with UIElement', () => {
  140. let domRoot, domEvent, evtSpy, uiElement;
  141. function createUIElement( name ) {
  142. const element = new UIElement( viewDocument, name );
  143. element.render = function( domDocument ) {
  144. const root = this.toDomElement( domDocument );
  145. root.innerHTML = '<span>foo bar</span>';
  146. return root;
  147. };
  148. return element;
  149. }
  150. beforeEach( () => {
  151. domRoot = document.createElement( 'div' );
  152. const viewRoot = createViewRoot( viewDocument );
  153. view.attachDomRoot( domRoot );
  154. uiElement = createUIElement( 'p' );
  155. viewRoot._appendChild( uiElement );
  156. view.forceRender();
  157. domEvent = new MouseEvent( 'click', { bubbles: true } );
  158. evtSpy = sinon.spy();
  159. view.addObserver( ClickObserver );
  160. viewDocument.on( 'click', evtSpy );
  161. } );
  162. it( 'should fire events from UIElement itself', () => {
  163. const domUiElement = domRoot.querySelector( 'p' );
  164. domUiElement.dispatchEvent( domEvent );
  165. const data = evtSpy.args[ 0 ][ 1 ];
  166. sinon.assert.calledOnce( evtSpy );
  167. expect( data.target ).to.equal( uiElement );
  168. } );
  169. it( 'events from inside of UIElement should target UIElement', () => {
  170. const domUiElementChild = domRoot.querySelector( 'span' );
  171. domUiElementChild.dispatchEvent( domEvent );
  172. const data = evtSpy.args[ 0 ][ 1 ];
  173. sinon.assert.calledOnce( evtSpy );
  174. expect( data.target ).to.equal( uiElement );
  175. } );
  176. } );
  177. describe( 'fire', () => {
  178. it( 'should do nothing if observer is disabled', () => {
  179. const testObserver = new ClickObserver( view );
  180. const fireSpy = sinon.spy( viewDocument, 'fire' );
  181. testObserver.disable();
  182. testObserver.fire( 'click', {} );
  183. expect( fireSpy.called ).to.be.false;
  184. testObserver.enable();
  185. testObserver.fire( 'click', {} );
  186. expect( fireSpy.calledOnce ).to.be.true;
  187. } );
  188. } );
  189. } );