domeventobserver.js 3.8 KB

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