document.js 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408
  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. 'use strict';
  7. import Document from '/ckeditor5/engine/view/document.js';
  8. import Observer from '/ckeditor5/engine/view/observer/observer.js';
  9. import Renderer from '/ckeditor5/engine/view/renderer.js';
  10. import ViewRange from '/ckeditor5/engine/view/range.js';
  11. import DomConverter from '/ckeditor5/engine/view/domconverter.js';
  12. import testUtils from '/tests/ckeditor5/_utils/utils.js';
  13. import count from '/ckeditor5/utils/count.js';
  14. import log from '/ckeditor5/utils/log.js';
  15. testUtils.createSinonSandbox();
  16. describe( 'Document', () => {
  17. let ObserverMock, ObserverMockGlobalCount, instantiated, enabled;
  18. beforeEach( () => {
  19. instantiated = 0;
  20. enabled = 0;
  21. ObserverMock = class extends Observer {
  22. constructor( viewDocument ) {
  23. super( viewDocument );
  24. this.enable = sinon.spy();
  25. this.disable = sinon.spy();
  26. this.observe = sinon.spy();
  27. }
  28. };
  29. ObserverMockGlobalCount = class extends Observer {
  30. constructor( viewDocument ) {
  31. super( viewDocument );
  32. instantiated++;
  33. this.observe = sinon.spy();
  34. }
  35. enable() {
  36. enabled++;
  37. }
  38. };
  39. } );
  40. describe( 'constructor', () => {
  41. it( 'should create Document with all properties', () => {
  42. const viewDocument = new Document();
  43. expect( count( viewDocument.domRoots ) ).to.equal( 0 );
  44. expect( count( viewDocument.roots ) ).to.equal( 0 );
  45. expect( count( viewDocument._observers ) ).to.equal( 0 );
  46. expect( viewDocument ).to.have.property( 'renderer' ).that.is.instanceOf( Renderer );
  47. expect( viewDocument ).to.have.property( 'domConverter' ).that.is.instanceOf( DomConverter );
  48. expect( viewDocument ).to.have.property( 'isFocused' ).that.is.false;
  49. } );
  50. } );
  51. describe( 'createRoot', () => {
  52. it( 'should create root', () => {
  53. const domP = document.createElement( 'p' );
  54. const domDiv = document.createElement( 'div' );
  55. domDiv.appendChild( domP );
  56. const viewDocument = new Document();
  57. const ret = viewDocument.createRoot( domDiv );
  58. expect( count( viewDocument.domRoots ) ).to.equal( 1 );
  59. expect( count( viewDocument.roots ) ).to.equal( 1 );
  60. const domRoot = viewDocument.getDomRoot();
  61. const viewRoot = viewDocument.getRoot();
  62. expect( ret ).to.equal( viewRoot );
  63. expect( domRoot ).to.equal( domDiv );
  64. expect( viewDocument.domConverter.getCorrespondingDom( viewRoot ) ).to.equal( domDiv );
  65. expect( viewRoot.name.toLowerCase() ).to.equal( 'div' );
  66. expect( viewDocument.renderer.markedChildren.has( viewRoot ) ).to.be.true;
  67. } );
  68. it( 'should call observe on each observer', () => {
  69. const viewDocument = new Document( document.createElement( 'div' ) );
  70. viewDocument.renderer.render = sinon.spy();
  71. const domDiv1 = document.createElement( 'div' );
  72. domDiv1.setAttribute( 'id', 'editor' );
  73. const domDiv2 = document.createElement( 'div' );
  74. domDiv2.setAttribute( 'id', 'editor' );
  75. const observerMock = viewDocument.addObserver( ObserverMock );
  76. const observerMockGlobalCount = viewDocument.addObserver( ObserverMockGlobalCount );
  77. viewDocument.createRoot( document.createElement( 'div' ), 'root1' );
  78. sinon.assert.calledOnce( observerMock.observe );
  79. sinon.assert.calledOnce( observerMockGlobalCount.observe );
  80. } );
  81. it( 'should create "main" root by default', () => {
  82. const domDiv = document.createElement( 'div' );
  83. const viewDocument = new Document();
  84. const ret = viewDocument.createRoot( domDiv );
  85. expect( count( viewDocument.domRoots ) ).to.equal( 1 );
  86. expect( count( viewDocument.roots ) ).to.equal( 1 );
  87. const domRoot = viewDocument.domRoots.get( 'main' );
  88. const viewRoot = viewDocument.roots.get( 'main' );
  89. expect( ret ).to.equal( viewRoot );
  90. expect( domRoot ).to.equal( domDiv );
  91. } );
  92. it( 'should create root with given name', () => {
  93. const domDiv = document.createElement( 'div' );
  94. const viewDocument = new Document();
  95. const ret = viewDocument.createRoot( domDiv, 'header' );
  96. expect( count( viewDocument.domRoots ) ).to.equal( 1 );
  97. expect( count( viewDocument.roots ) ).to.equal( 1 );
  98. const domRoot = viewDocument.domRoots.get( 'header' );
  99. const viewRoot = viewDocument.roots.get( 'header' );
  100. expect( ret ).to.equal( viewRoot );
  101. expect( domRoot ).to.equal( domDiv );
  102. } );
  103. it( 'should create root without attaching DOM element', () => {
  104. const viewDocument = new Document();
  105. const ret = viewDocument.createRoot( 'div' );
  106. expect( count( viewDocument.domRoots ) ).to.equal( 0 );
  107. expect( count( viewDocument.roots ) ).to.equal( 1 );
  108. expect( ret ).to.equal( viewDocument.getRoot() );
  109. } );
  110. } );
  111. describe( 'attachDomRoot', () => {
  112. it( 'should create root without attach DOM element to the view element', () => {
  113. const domDiv = document.createElement( 'div' );
  114. const viewDocument = new Document();
  115. const viewRoot = viewDocument.createRoot( 'div' );
  116. expect( count( viewDocument.domRoots ) ).to.equal( 0 );
  117. expect( count( viewDocument.roots ) ).to.equal( 1 );
  118. expect( viewRoot ).to.equal( viewDocument.getRoot() );
  119. viewDocument.attachDomRoot( domDiv );
  120. expect( count( viewDocument.domRoots ) ).to.equal( 1 );
  121. expect( count( viewDocument.roots ) ).to.equal( 1 );
  122. expect( viewDocument.getDomRoot() ).to.equal( domDiv );
  123. expect( viewDocument.domConverter.getCorrespondingDom( viewRoot ) ).to.equal( domDiv );
  124. expect( viewDocument.renderer.markedChildren.has( viewRoot ) ).to.be.true;
  125. } );
  126. it( 'should create root without attach DOM element to the view element with given name', () => {
  127. const domH1 = document.createElement( 'h1' );
  128. const viewDocument = new Document();
  129. viewDocument.createRoot( 'div' );
  130. const viewH1 = viewDocument.createRoot( 'h1', 'header' );
  131. expect( count( viewDocument.domRoots ) ).to.equal( 0 );
  132. expect( count( viewDocument.roots ) ).to.equal( 2 );
  133. expect( viewH1 ).to.equal( viewDocument.getRoot( 'header' ) );
  134. viewDocument.attachDomRoot( domH1, 'header' );
  135. expect( count( viewDocument.domRoots ) ).to.equal( 1 );
  136. expect( count( viewDocument.roots ) ).to.equal( 2 );
  137. expect( viewDocument.getDomRoot( 'header' ) ).to.equal( domH1 );
  138. expect( viewDocument.domConverter.getCorrespondingDom( viewH1 ) ).to.equal( domH1 );
  139. expect( viewDocument.renderer.markedChildren.has( viewH1 ) ).to.be.true;
  140. } );
  141. } );
  142. describe( 'getRoot', () => {
  143. it( 'should return "main" root', () => {
  144. const viewDocument = new Document();
  145. viewDocument.createRoot( document.createElement( 'div' ) );
  146. expect( count( viewDocument.roots ) ).to.equal( 1 );
  147. expect( viewDocument.getRoot() ).to.equal( viewDocument.roots.get( 'main' ) );
  148. } );
  149. it( 'should return named root', () => {
  150. const viewDocument = new Document();
  151. viewDocument.createRoot( document.createElement( 'h1' ), 'header' );
  152. expect( count( viewDocument.roots ) ).to.equal( 1 );
  153. expect( viewDocument.getRoot( 'header' ) ).to.equal( viewDocument.roots.get( 'header' ) );
  154. } );
  155. } );
  156. describe( 'addObserver', () => {
  157. let viewDocument;
  158. beforeEach( () => {
  159. viewDocument = new Document( document.createElement( 'div' ) );
  160. viewDocument.renderer.render = sinon.spy();
  161. } );
  162. it( 'should be instantiated and enabled on adding', () => {
  163. const observerMock = viewDocument.addObserver( ObserverMock );
  164. expect( viewDocument._observers.size ).to.equal( 1 );
  165. expect( observerMock ).to.have.property( 'document', viewDocument );
  166. sinon.assert.calledOnce( observerMock.enable );
  167. } );
  168. it( 'should return observer instance ever time addObserver is called', () => {
  169. const observerMock1 = viewDocument.addObserver( ObserverMock );
  170. const observerMock2 = viewDocument.addObserver( ObserverMock );
  171. expect( observerMock1 ).to.be.instanceof( ObserverMock );
  172. expect( observerMock2 ).to.be.instanceof( ObserverMock );
  173. expect( observerMock1 ).to.equals( observerMock2 );
  174. } );
  175. it( 'should instantiate one observer only once', () => {
  176. viewDocument.addObserver( ObserverMockGlobalCount );
  177. viewDocument.addObserver( ObserverMockGlobalCount );
  178. expect( viewDocument._observers.size ).to.equal( 1 );
  179. expect( instantiated ).to.equal( 1 );
  180. expect( enabled ).to.equal( 1 );
  181. viewDocument.addObserver( ObserverMock );
  182. expect( viewDocument._observers.size ).to.equal( 2 );
  183. } );
  184. it( 'should instantiate child class of already registered observer', () => {
  185. class ObserverMock extends Observer {
  186. enable() {}
  187. }
  188. class ChildObserverMock extends ObserverMock {
  189. enable() {}
  190. }
  191. viewDocument.addObserver( ObserverMock );
  192. viewDocument.addObserver( ChildObserverMock );
  193. expect( viewDocument._observers.size ).to.equal( 2 );
  194. } );
  195. it( 'should be disabled and re-enabled on render', () => {
  196. const observerMock = viewDocument.addObserver( ObserverMock );
  197. viewDocument.render();
  198. sinon.assert.calledOnce( observerMock.disable );
  199. sinon.assert.calledOnce( viewDocument.renderer.render );
  200. sinon.assert.calledTwice( observerMock.enable );
  201. } );
  202. it( 'should call observe on each root', () => {
  203. viewDocument.createRoot( document.createElement( 'div' ), 'root1' );
  204. viewDocument.createRoot( document.createElement( 'div' ), 'root2' );
  205. const observerMock = viewDocument.addObserver( ObserverMock );
  206. sinon.assert.calledTwice( observerMock.observe );
  207. } );
  208. } );
  209. describe( 'getObserver', () => {
  210. it( 'should return observer it it is added', () => {
  211. const viewDocument = new Document();
  212. const addedObserverMock = viewDocument.addObserver( ObserverMock );
  213. const getObserverMock = viewDocument.getObserver( ObserverMock );
  214. expect( getObserverMock ).to.be.instanceof( ObserverMock );
  215. expect( getObserverMock ).to.equal( addedObserverMock );
  216. } );
  217. it( 'should return undefined if observer is not added', () => {
  218. const viewDocument = new Document();
  219. const getObserverMock = viewDocument.getObserver( ObserverMock );
  220. expect( getObserverMock ).to.be.undefined();
  221. } );
  222. } );
  223. describe( 'disableObservers', () => {
  224. it( 'should disable observers', () => {
  225. const viewDocument = new Document();
  226. const addedObserverMock = viewDocument.addObserver( ObserverMock );
  227. expect( addedObserverMock.enable.calledOnce ).to.be.true;
  228. expect( addedObserverMock.disable.called ).to.be.false;
  229. viewDocument.disableObservers();
  230. expect( addedObserverMock.enable.calledOnce ).to.be.true;
  231. expect( addedObserverMock.disable.calledOnce ).to.be.true;
  232. } );
  233. } );
  234. describe( 'enableObservers', () => {
  235. it( 'should enable observers', () => {
  236. const viewDocument = new Document();
  237. const addedObserverMock = viewDocument.addObserver( ObserverMock );
  238. viewDocument.disableObservers();
  239. expect( addedObserverMock.enable.calledOnce ).to.be.true;
  240. expect( addedObserverMock.disable.calledOnce ).to.be.true;
  241. viewDocument.enableObservers();
  242. expect( addedObserverMock.enable.calledTwice ).to.be.true;
  243. expect( addedObserverMock.disable.calledOnce ).to.be.true;
  244. } );
  245. } );
  246. describe( 'isFocused', () => {
  247. it( 'should change renderer.isFocused too', () => {
  248. const viewDocument = new Document();
  249. expect( viewDocument.isFocused ).to.equal( false );
  250. expect( viewDocument.renderer.isFocused ).to.equal( false );
  251. viewDocument.isFocused = true;
  252. expect( viewDocument.isFocused ).to.equal( true );
  253. expect( viewDocument.renderer.isFocused ).to.equal( true );
  254. } );
  255. } );
  256. describe( 'focus', () => {
  257. let viewDocument, domEditable, viewEditable;
  258. beforeEach( () => {
  259. viewDocument = new Document();
  260. domEditable = document.createElement( 'div' );
  261. domEditable.setAttribute( 'contenteditable', 'true' );
  262. document.body.appendChild( domEditable );
  263. viewEditable = viewDocument.createRoot( domEditable );
  264. viewDocument.selection.addRange( ViewRange.createFromParentsAndOffsets( viewEditable, 0, viewEditable, 0 ) );
  265. } );
  266. afterEach( () => {
  267. document.body.removeChild( domEditable );
  268. } );
  269. it( 'should focus editable with selection', () => {
  270. const converterFocusSpy = testUtils.sinon.spy( viewDocument.domConverter, 'focus' );
  271. const renderSpy = testUtils.sinon.spy( viewDocument, 'render' );
  272. viewDocument.focus();
  273. expect( converterFocusSpy.calledOnce ).to.be.true;
  274. expect( renderSpy.calledOnce ).to.be.true;
  275. expect( document.activeElement ).to.equal( domEditable );
  276. const domSelection = document.getSelection();
  277. expect( domSelection.rangeCount ).to.equal( 1 );
  278. const domRange = domSelection.getRangeAt( 0 );
  279. expect( domRange.startContainer ).to.equal( domEditable );
  280. expect( domRange.startOffset ).to.equal( 0 );
  281. expect( domRange.collapsed ).to.be.true;
  282. } );
  283. it( 'should not focus if document is already focused', () => {
  284. const converterFocusSpy = testUtils.sinon.spy( viewDocument.domConverter, 'focus' );
  285. const renderSpy = testUtils.sinon.spy( viewDocument, 'render' );
  286. viewDocument.isFocused = true;
  287. viewDocument.focus();
  288. expect( converterFocusSpy.called ).to.be.false;
  289. expect( renderSpy.called ).to.be.false;
  290. } );
  291. it( 'should log warning when no selection', () => {
  292. const logSpy = testUtils.sinon.stub( log, 'warn' );
  293. viewDocument.selection.removeAllRanges();
  294. viewDocument.focus();
  295. expect( logSpy.calledOnce ).to.be.true;
  296. expect( logSpy.args[ 0 ][ 0 ] ).to.match( /^view-focus-no-selection/ );
  297. } );
  298. } );
  299. } );