domeventobserver.js 3.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151
  1. /**
  2. * @license Copyright (c) 2003-2015, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* globals MouseEvent, document */
  6. /* bender-tags: view, browser-only */
  7. import DomEventObserver from 'ckeditor5/engine/view/observer/domeventobserver.js';
  8. import Observer from 'ckeditor5/engine/view/observer/observer.js';
  9. import ViewDocument from 'ckeditor5/engine/view/document.js';
  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. describe( 'DomEventObserver', () => {
  29. let viewDocument;
  30. beforeEach( () => {
  31. viewDocument = new ViewDocument();
  32. } );
  33. afterEach( () => {
  34. viewDocument.destroy();
  35. } );
  36. describe( 'constructor()', () => {
  37. it( 'should create Observer with properties', () => {
  38. const observer = new DomEventObserver( viewDocument );
  39. expect( observer ).to.be.an.instanceof( Observer );
  40. } );
  41. } );
  42. it( 'should add event listener', () => {
  43. const domElement = document.createElement( 'p' );
  44. const domEvent = new MouseEvent( 'click' );
  45. const evtSpy = sinon.spy();
  46. viewDocument.createRoot( domElement, 'root' );
  47. viewDocument.addObserver( ClickObserver );
  48. viewDocument.on( 'click', evtSpy );
  49. domElement.dispatchEvent( domEvent );
  50. expect( evtSpy.calledOnce ).to.be.true;
  51. const data = evtSpy.args[ 0 ][ 1 ];
  52. expect( data ).to.have.property( 'foo', 1 );
  53. expect( data ).to.have.property( 'bar', 2 );
  54. expect( data ).to.have.property( 'domEvent', domEvent );
  55. } );
  56. it( 'should add multiple event listeners', () => {
  57. const domElement = document.createElement( 'p' );
  58. const domEvent1 = new MouseEvent( 'evt1' );
  59. const domEvent2 = new MouseEvent( 'evt2' );
  60. const evtSpy1 = sinon.spy();
  61. const evtSpy2 = sinon.spy();
  62. viewDocument.createRoot( domElement, 'root' );
  63. viewDocument.addObserver( MultiObserver );
  64. viewDocument.on( 'evt1', evtSpy1 );
  65. viewDocument.on( 'evt2', evtSpy2 );
  66. domElement.dispatchEvent( domEvent1 );
  67. expect( evtSpy1.calledOnce ).to.be.true;
  68. domElement.dispatchEvent( domEvent2 );
  69. expect( evtSpy2.calledOnce ).to.be.true;
  70. } );
  71. it( 'should not fire event if observer is disabled', () => {
  72. const domElement = document.createElement( 'p' );
  73. const domEvent = new MouseEvent( 'click' );
  74. const evtSpy = sinon.spy();
  75. viewDocument.createRoot( domElement, 'root' );
  76. const testObserver = viewDocument.addObserver( ClickObserver );
  77. viewDocument.on( 'click', evtSpy );
  78. testObserver.disable();
  79. domElement.dispatchEvent( domEvent );
  80. expect( evtSpy.called ).to.be.false;
  81. } );
  82. it( 'should fire event if observer is disabled and re-enabled', () => {
  83. const domElement = document.createElement( 'p' );
  84. const domEvent = new MouseEvent( 'click' );
  85. const evtSpy = sinon.spy();
  86. viewDocument.createRoot( domElement, 'root' );
  87. const testObserver = viewDocument.addObserver( ClickObserver );
  88. viewDocument.on( 'click', evtSpy );
  89. testObserver.disable();
  90. domElement.dispatchEvent( domEvent );
  91. expect( evtSpy.called ).to.be.false;
  92. testObserver.enable();
  93. domElement.dispatchEvent( domEvent );
  94. expect( evtSpy.calledOnce ).to.be.true;
  95. } );
  96. describe( 'fire', () => {
  97. it( 'should do nothing if observer is disabled', () => {
  98. const testObserver = new ClickObserver( viewDocument );
  99. const fireSpy = sinon.spy( viewDocument, 'fire' );
  100. testObserver.disable();
  101. testObserver.fire( 'click', {} );
  102. expect( fireSpy.called ).to.be.false;
  103. testObserver.enable();
  104. testObserver.fire( 'click', {} );
  105. expect( fireSpy.calledOnce ).to.be.true;
  106. } );
  107. } );
  108. } );