8
0

document.js 13 KB

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