8
0

document.js 14 KB

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