view.js 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979
  1. /**
  2. * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  4. */
  5. /* globals document, console, setTimeout */
  6. import View from '../../../src/view/view';
  7. import Observer from '../../../src/view/observer/observer';
  8. import MutationObserver from '../../../src/view/observer/mutationobserver';
  9. import KeyObserver from '../../../src/view/observer/keyobserver';
  10. import InputObserver from '../../../src/view/observer/inputobserver';
  11. import FakeSelectionObserver from '../../../src/view/observer/fakeselectionobserver';
  12. import SelectionObserver from '../../../src/view/observer/selectionobserver';
  13. import FocusObserver from '../../../src/view/observer/focusobserver';
  14. import CompositionObserver from '../../../src/view/observer/compositionobserver';
  15. import ViewRange from '../../../src/view/range';
  16. import ViewElement from '../../../src/view/element';
  17. import ViewContainerElement from '../../../src/view/containerelement';
  18. import ViewPosition from '../../../src/view/position';
  19. import ViewSelection from '../../../src/view/selection';
  20. import { StylesProcessor } from '../../../src/view/stylesmap';
  21. import count from '@ckeditor/ckeditor5-utils/src/count';
  22. import global from '@ckeditor/ckeditor5-utils/src/dom/global';
  23. import createViewRoot from '../_utils/createroot';
  24. import createElement from '@ckeditor/ckeditor5-utils/src/dom/createelement';
  25. import { expectToThrowCKEditorError } from '@ckeditor/ckeditor5-utils/tests/_utils/utils';
  26. import env from '@ckeditor/ckeditor5-utils/src/env';
  27. import CKEditorError from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
  28. describe( 'view', () => {
  29. const DEFAULT_OBSERVERS_COUNT = 6;
  30. let domRoot, view, viewDocument, ObserverMock, instantiated, enabled, ObserverMockGlobalCount;
  31. beforeEach( () => {
  32. domRoot = createElement( document, 'div', {
  33. id: 'editor',
  34. contenteditable: 'true'
  35. } );
  36. document.body.appendChild( domRoot );
  37. view = new View( new StylesProcessor() );
  38. viewDocument = view.document;
  39. ObserverMock = class extends Observer {
  40. constructor( view ) {
  41. super( view );
  42. this.enable = sinon.spy();
  43. this.disable = sinon.spy();
  44. this.observe = sinon.spy();
  45. this.destroy = sinon.spy();
  46. }
  47. };
  48. instantiated = 0;
  49. enabled = 0;
  50. ObserverMockGlobalCount = class extends Observer {
  51. constructor( view ) {
  52. super( view );
  53. instantiated++;
  54. this.observe = sinon.spy();
  55. }
  56. enable() {
  57. enabled++;
  58. }
  59. };
  60. } );
  61. afterEach( () => {
  62. sinon.restore();
  63. domRoot.remove();
  64. view.destroy();
  65. } );
  66. it( 'should add default observers', () => {
  67. expect( count( view._observers ) ).to.equal( DEFAULT_OBSERVERS_COUNT );
  68. expect( view.getObserver( MutationObserver ) ).to.be.instanceof( MutationObserver );
  69. expect( view.getObserver( SelectionObserver ) ).to.be.instanceof( SelectionObserver );
  70. expect( view.getObserver( FocusObserver ) ).to.be.instanceof( FocusObserver );
  71. expect( view.getObserver( KeyObserver ) ).to.be.instanceof( KeyObserver );
  72. expect( view.getObserver( FakeSelectionObserver ) ).to.be.instanceof( FakeSelectionObserver );
  73. expect( view.getObserver( CompositionObserver ) ).to.be.instanceof( CompositionObserver );
  74. } );
  75. it( 'should add InputObserver on Android devices', () => {
  76. const oldEnvIsAndroid = env.isAndroid;
  77. env.isAndroid = true;
  78. const newView = new View( new StylesProcessor() );
  79. expect( newView.getObserver( InputObserver ) ).to.be.instanceof( InputObserver );
  80. env.isAndroid = oldEnvIsAndroid;
  81. newView.destroy();
  82. } );
  83. describe( 'attachDomRoot()', () => {
  84. it( 'should attach DOM element to main view element', () => {
  85. const domDiv = document.createElement( 'div' );
  86. const viewRoot = createViewRoot( viewDocument, 'div', 'main' );
  87. expect( count( view.domRoots ) ).to.equal( 0 );
  88. view.attachDomRoot( domDiv );
  89. expect( count( view.domRoots ) ).to.equal( 1 );
  90. expect( view.getDomRoot() ).to.equal( domDiv );
  91. expect( view.domConverter.mapViewToDom( viewRoot ) ).to.equal( domDiv );
  92. expect( view._renderer.markedChildren.has( viewRoot ) ).to.be.true;
  93. domDiv.remove();
  94. } );
  95. it( 'should attach DOM element to custom view element', () => {
  96. const domH1 = document.createElement( 'h1' );
  97. const viewH1 = createViewRoot( viewDocument, 'h1', 'header' );
  98. expect( count( view.domRoots ) ).to.equal( 0 );
  99. view.attachDomRoot( domH1, 'header' );
  100. expect( count( view.domRoots ) ).to.equal( 1 );
  101. expect( view.getDomRoot( 'header' ) ).to.equal( domH1 );
  102. expect( view.domConverter.mapViewToDom( viewH1 ) ).to.equal( domH1 );
  103. expect( view._renderer.markedChildren.has( viewH1 ) ).to.be.true;
  104. } );
  105. it( 'should handle the "contenteditable" attribute management on #isReadOnly change', () => {
  106. const domDiv = document.createElement( 'div' );
  107. const viewRoot = createViewRoot( viewDocument, 'div', 'main' );
  108. view.attachDomRoot( domDiv );
  109. viewRoot.isReadOnly = false;
  110. expect( viewRoot.getAttribute( 'contenteditable' ) ).to.equal( 'true' );
  111. viewRoot.isReadOnly = true;
  112. expect( viewRoot.getAttribute( 'contenteditable' ) ).to.equal( 'false' );
  113. } );
  114. it( 'should handle the ".ck-read-only" class management on #isReadOnly change', () => {
  115. const domDiv = document.createElement( 'div' );
  116. const viewRoot = createViewRoot( viewDocument, 'div', 'main' );
  117. view.attachDomRoot( domDiv );
  118. viewRoot.isReadOnly = false;
  119. expect( viewRoot.hasClass( 'ck-read-only' ) ).to.be.false;
  120. viewRoot.isReadOnly = true;
  121. expect( viewRoot.hasClass( 'ck-read-only' ) ).to.be.true;
  122. } );
  123. it( 'should call observe on each observer', () => {
  124. // The variable will be overwritten.
  125. view.destroy();
  126. view = new View( new StylesProcessor() );
  127. viewDocument = view.document;
  128. view._renderer.render = sinon.spy();
  129. const domDiv1 = document.createElement( 'div' );
  130. domDiv1.setAttribute( 'id', 'editor' );
  131. const domDiv2 = document.createElement( 'div' );
  132. domDiv2.setAttribute( 'id', 'editor' );
  133. const observerMock = view.addObserver( ObserverMock );
  134. const observerMockGlobalCount = view.addObserver( ObserverMockGlobalCount );
  135. createViewRoot( viewDocument, 'div', 'root1' );
  136. view.attachDomRoot( document.createElement( 'div' ), 'root1' );
  137. sinon.assert.calledOnce( observerMock.observe );
  138. sinon.assert.calledOnce( observerMockGlobalCount.observe );
  139. } );
  140. } );
  141. describe( 'detachDomRoot()', () => {
  142. it( 'should remove DOM root and unbind DOM element', () => {
  143. const domDiv = document.createElement( 'div' );
  144. const viewRoot = createViewRoot( viewDocument, 'div', 'main' );
  145. view.attachDomRoot( domDiv );
  146. expect( count( view.domRoots ) ).to.equal( 1 );
  147. expect( view.domConverter.mapViewToDom( viewRoot ) ).to.equal( domDiv );
  148. view.detachDomRoot( 'main' );
  149. expect( count( view.domRoots ) ).to.equal( 0 );
  150. expect( view.domConverter.mapViewToDom( viewRoot ) ).to.be.undefined;
  151. domDiv.remove();
  152. } );
  153. it( 'should restore the DOM root attributes to the state before attachDomRoot()', () => {
  154. const domDiv = document.createElement( 'div' );
  155. const viewRoot = createViewRoot( viewDocument, 'div', 'main' );
  156. domDiv.setAttribute( 'foo', 'bar' );
  157. domDiv.setAttribute( 'data-baz', 'qux' );
  158. domDiv.classList.add( 'foo-class' );
  159. view.attachDomRoot( domDiv );
  160. view.change( writer => {
  161. writer.addClass( 'addedClass', viewRoot );
  162. writer.setAttribute( 'added-attribute', 'foo', viewRoot );
  163. writer.setAttribute( 'foo', 'changed the value', viewRoot );
  164. } );
  165. view.detachDomRoot( 'main' );
  166. const attributes = {};
  167. for ( const attribute of Array.from( domDiv.attributes ) ) {
  168. attributes[ attribute.name ] = attribute.value;
  169. }
  170. expect( attributes ).to.deep.equal( {
  171. foo: 'bar',
  172. 'data-baz': 'qux',
  173. class: 'foo-class'
  174. } );
  175. domDiv.remove();
  176. } );
  177. it( 'should remove the "contenteditable" attribute from the DOM root', () => {
  178. const domDiv = document.createElement( 'div' );
  179. const viewRoot = createViewRoot( viewDocument, 'div', 'main' );
  180. view.attachDomRoot( domDiv );
  181. view.forceRender();
  182. viewRoot.isReadOnly = false;
  183. expect( domDiv.getAttribute( 'contenteditable' ) ).to.equal( 'true' );
  184. view.detachDomRoot( 'main' );
  185. expect( domDiv.hasAttribute( 'contenteditable' ) ).to.be.false;
  186. domDiv.remove();
  187. } );
  188. it( 'should remove the ".ck-read-only" class from the DOM root', () => {
  189. const domDiv = document.createElement( 'div' );
  190. const viewRoot = createViewRoot( viewDocument, 'div', 'main' );
  191. view.attachDomRoot( domDiv );
  192. view.forceRender();
  193. viewRoot.isReadOnly = true;
  194. expect( domDiv.classList.contains( 'ck-read-only' ) ).to.be.true;
  195. view.detachDomRoot( 'main' );
  196. expect( domDiv.classList.contains( 'ck-read-only' ) ).to.be.false;
  197. domDiv.remove();
  198. } );
  199. } );
  200. describe( 'addObserver()', () => {
  201. beforeEach( () => {
  202. // The variable will be overwritten.
  203. view.destroy();
  204. view = new View( new StylesProcessor() );
  205. viewDocument = view.document;
  206. view._renderer.render = sinon.spy();
  207. } );
  208. afterEach( () => {
  209. view.destroy();
  210. } );
  211. it( 'should be instantiated and enabled on adding', () => {
  212. const observerMock = view.addObserver( ObserverMock );
  213. expect( view._observers.size ).to.equal( DEFAULT_OBSERVERS_COUNT + 1 );
  214. expect( observerMock ).to.have.property( 'document', viewDocument );
  215. sinon.assert.calledOnce( observerMock.enable );
  216. } );
  217. it( 'should return observer instance each time addObserver is called', () => {
  218. const observerMock1 = view.addObserver( ObserverMock );
  219. const observerMock2 = view.addObserver( ObserverMock );
  220. expect( observerMock1 ).to.be.instanceof( ObserverMock );
  221. expect( observerMock2 ).to.be.instanceof( ObserverMock );
  222. expect( observerMock1 ).to.equals( observerMock2 );
  223. } );
  224. it( 'should instantiate one observer only once', () => {
  225. view.addObserver( ObserverMockGlobalCount );
  226. view.addObserver( ObserverMockGlobalCount );
  227. expect( view._observers.size ).to.equal( DEFAULT_OBSERVERS_COUNT + 1 );
  228. expect( instantiated ).to.equal( 1 );
  229. expect( enabled ).to.equal( 1 );
  230. view.addObserver( ObserverMock );
  231. expect( view._observers.size ).to.equal( DEFAULT_OBSERVERS_COUNT + 2 );
  232. } );
  233. it( 'should instantiate child class of already registered observer', () => {
  234. class ObserverMock extends Observer {
  235. enable() {}
  236. }
  237. class ChildObserverMock extends ObserverMock {
  238. enable() {}
  239. }
  240. view.addObserver( ObserverMock );
  241. view.addObserver( ChildObserverMock );
  242. expect( view._observers.size ).to.equal( DEFAULT_OBSERVERS_COUNT + 2 );
  243. } );
  244. it( 'should be disabled and re-enabled on render', () => {
  245. const observerMock = view.addObserver( ObserverMock );
  246. view.forceRender();
  247. sinon.assert.calledOnce( observerMock.disable );
  248. sinon.assert.calledOnce( view._renderer.render );
  249. sinon.assert.calledTwice( observerMock.enable );
  250. } );
  251. it( 'should call observe on each root', () => {
  252. createViewRoot( viewDocument, 'div', 'roo1' );
  253. createViewRoot( viewDocument, 'div', 'roo2' );
  254. view.attachDomRoot( document.createElement( 'div' ), 'roo1' );
  255. view.attachDomRoot( document.createElement( 'div' ), 'roo2' );
  256. const observerMock = view.addObserver( ObserverMock );
  257. sinon.assert.calledTwice( observerMock.observe );
  258. } );
  259. } );
  260. describe( 'getObserver()', () => {
  261. it( 'should return observer it it is added', () => {
  262. const addedObserverMock = view.addObserver( ObserverMock );
  263. const getObserverMock = view.getObserver( ObserverMock );
  264. expect( getObserverMock ).to.be.instanceof( ObserverMock );
  265. expect( getObserverMock ).to.equal( addedObserverMock );
  266. } );
  267. it( 'should return undefined if observer is not added', () => {
  268. const getObserverMock = view.getObserver( ObserverMock );
  269. expect( getObserverMock ).to.be.undefined;
  270. } );
  271. } );
  272. describe( 'scrollToTheSelection()', () => {
  273. beforeEach( () => {
  274. // Silence the Rect warnings.
  275. sinon.stub( console, 'warn' );
  276. } );
  277. it( 'does nothing when there are no ranges in the selection', () => {
  278. const stub = sinon.stub( global.window, 'scrollTo' );
  279. view.scrollToTheSelection();
  280. sinon.assert.notCalled( stub );
  281. } );
  282. it( 'scrolls to the first range in selection with an offset', () => {
  283. const root = createViewRoot( viewDocument, 'div', 'main' );
  284. const stub = sinon.stub( global.window, 'scrollTo' );
  285. const range = ViewRange._createIn( root );
  286. view.attachDomRoot( domRoot );
  287. view.change( writer => {
  288. writer.setSelection( range );
  289. } );
  290. // Make sure the window will have to scroll to the domRoot.
  291. Object.assign( domRoot.style, {
  292. position: 'absolute',
  293. top: '-1000px',
  294. left: '-1000px'
  295. } );
  296. view.scrollToTheSelection();
  297. sinon.assert.calledWithMatch( stub, sinon.match.number, sinon.match.number );
  298. } );
  299. } );
  300. describe( 'disableObservers()', () => {
  301. it( 'should disable observers', () => {
  302. const addedObserverMock = view.addObserver( ObserverMock );
  303. expect( addedObserverMock.enable.calledOnce ).to.be.true;
  304. expect( addedObserverMock.disable.called ).to.be.false;
  305. view.disableObservers();
  306. expect( addedObserverMock.enable.calledOnce ).to.be.true;
  307. expect( addedObserverMock.disable.calledOnce ).to.be.true;
  308. } );
  309. } );
  310. describe( 'enableObservers()', () => {
  311. it( 'should enable observers', () => {
  312. const addedObserverMock = view.addObserver( ObserverMock );
  313. view.disableObservers();
  314. expect( addedObserverMock.enable.calledOnce ).to.be.true;
  315. expect( addedObserverMock.disable.calledOnce ).to.be.true;
  316. view.enableObservers();
  317. expect( addedObserverMock.enable.calledTwice ).to.be.true;
  318. expect( addedObserverMock.disable.calledOnce ).to.be.true;
  319. } );
  320. } );
  321. describe( 'focus()', () => {
  322. let domEditable, viewEditable;
  323. beforeEach( () => {
  324. domEditable = document.createElement( 'div' );
  325. domEditable.setAttribute( 'contenteditable', 'true' );
  326. document.body.appendChild( domEditable );
  327. viewEditable = createViewRoot( viewDocument, 'div', 'main' );
  328. view.attachDomRoot( domEditable );
  329. view.change( writer => {
  330. writer.setSelection( viewEditable, 0 );
  331. } );
  332. } );
  333. afterEach( () => {
  334. document.body.removeChild( domEditable );
  335. } );
  336. it( 'should focus editable with selection', () => {
  337. const converterFocusSpy = sinon.spy( view.domConverter, 'focus' );
  338. const renderSpy = sinon.spy( view, 'forceRender' );
  339. view.focus();
  340. expect( converterFocusSpy.called ).to.be.true;
  341. expect( renderSpy.calledOnce ).to.be.true;
  342. expect( document.activeElement ).to.equal( domEditable );
  343. const domSelection = document.getSelection();
  344. expect( domSelection.rangeCount ).to.equal( 1 );
  345. const domRange = domSelection.getRangeAt( 0 );
  346. expect( domRange.startContainer ).to.equal( domEditable );
  347. expect( domRange.startOffset ).to.equal( 0 );
  348. expect( domRange.collapsed ).to.be.true;
  349. } );
  350. it( 'should not focus if document is already focused', () => {
  351. const converterFocusSpy = sinon.spy( view.domConverter, 'focus' );
  352. const renderSpy = sinon.spy( view, 'forceRender' );
  353. viewDocument.isFocused = true;
  354. view.focus();
  355. expect( converterFocusSpy.called ).to.be.false;
  356. expect( renderSpy.called ).to.be.false;
  357. } );
  358. it( 'should not crash when there is no selection', () => {
  359. // Catches the `There is no selection in any editable to focus.` warning in the CK_DEBUG mode.
  360. sinon.stub( console, 'warn' );
  361. view.change( writer => {
  362. writer.setSelection( null );
  363. } );
  364. view.focus();
  365. } );
  366. } );
  367. describe( 'isFocused', () => {
  368. it( 'should change renderer.isFocused too', () => {
  369. expect( viewDocument.isFocused ).to.equal( false );
  370. expect( view._renderer.isFocused ).to.equal( false );
  371. viewDocument.isFocused = true;
  372. expect( viewDocument.isFocused ).to.equal( true );
  373. expect( view._renderer.isFocused ).to.equal( true );
  374. } );
  375. } );
  376. describe( 'isRenderingInProgress', () => {
  377. it( 'should be true while rendering is in progress', () => {
  378. expect( view.isRenderingInProgress ).to.equal( false );
  379. const spy = sinon.spy();
  380. view.on( 'change:isRenderingInProgress', spy );
  381. view.fire( 'render' );
  382. sinon.assert.calledTwice( spy );
  383. sinon.assert.calledWith( spy.firstCall, sinon.match.any, 'isRenderingInProgress', true );
  384. sinon.assert.calledWith( spy.secondCall, sinon.match.any, 'isRenderingInProgress', false );
  385. } );
  386. } );
  387. describe( 'hasDomSelection', () => {
  388. let domElement, domP, domSelection;
  389. // Focus tests are too unstable on Firefox to run them.
  390. if ( env.isGecko ) {
  391. return;
  392. }
  393. beforeEach( () => {
  394. const viewRoot = createViewRoot( viewDocument, 'div', 'main' );
  395. view.attachDomRoot( domRoot );
  396. // It must be a container element to be rendered with the bogus <br> inside which ensures
  397. // that the browser sees a selection position inside (empty <p> may not be selectable).
  398. // May help resolving https://github.com/ckeditor/ckeditor5/issues/6655.
  399. viewRoot._appendChild( new ViewContainerElement( viewDocument, 'p' ) );
  400. view.forceRender();
  401. domElement = createElement( document, 'div', { contenteditable: 'true' } );
  402. document.body.appendChild( domElement );
  403. domSelection = document.getSelection();
  404. domP = domRoot.childNodes[ 0 ];
  405. } );
  406. afterEach( () => {
  407. domElement.remove();
  408. } );
  409. it( 'should be true if selection is inside a DOM root element', done => {
  410. domRoot.focus();
  411. setTimeout( () => {
  412. domSelection.collapse( domP, 0 );
  413. // Wait for async selectionchange event on DOM document.
  414. setTimeout( () => {
  415. expect( view.hasDomSelection ).to.be.true;
  416. done();
  417. }, 10 );
  418. }, 10 );
  419. } );
  420. it( 'should be true if selection is inside a DOM root element - no focus', done => {
  421. domRoot.focus();
  422. setTimeout( () => {
  423. domSelection.collapse( domP, 0 );
  424. setTimeout( () => {
  425. // We could also do domRoot.blur() here but it's always better to know where the focus went.
  426. // E.g. if it went to some <input>, the selection would disappear from the editor and the test would fail.
  427. domRoot.blur();
  428. // Wait for async selectionchange event on DOM document.
  429. setTimeout( () => {
  430. expect( view.hasDomSelection ).to.be.true;
  431. expect( view.document.isFocused ).to.be.false;
  432. done();
  433. }, 10 );
  434. }, 10 );
  435. }, 10 );
  436. } );
  437. it( 'should be false if selection is outside DOM root element', done => {
  438. domSelection.collapse( domElement, 0 );
  439. // Wait for async selectionchange event on DOM document.
  440. setTimeout( () => {
  441. expect( view.hasDomSelection ).to.be.false;
  442. done();
  443. }, 100 );
  444. } );
  445. } );
  446. describe( 'forceRender()', () => {
  447. it( 'disable observers, renders and enable observers', () => {
  448. const observerMock = view.addObserver( ObserverMock );
  449. const renderStub = sinon.stub( view._renderer, 'render' );
  450. view.forceRender();
  451. sinon.assert.callOrder( observerMock.disable, renderStub, observerMock.enable );
  452. } );
  453. it( 'should fire `render` and `layoutChanged` even if there were no changes', () => {
  454. const renderSpy = sinon.spy();
  455. const layoutChangedSpy = sinon.spy();
  456. view.on( 'render', renderSpy );
  457. view.document.on( 'layoutChanged', layoutChangedSpy );
  458. view.forceRender();
  459. sinon.assert.calledOnce( renderSpy );
  460. sinon.assert.calledOnce( layoutChangedSpy );
  461. } );
  462. it( 'should fire `render` and `layoutChanged` if there is some buffered change', () => {
  463. const renderSpy = sinon.spy();
  464. const layoutChangedSpy = sinon.spy();
  465. view.on( 'render', renderSpy );
  466. view.document.on( 'layoutChanged', layoutChangedSpy );
  467. view.document.selection._setTo( null );
  468. view.forceRender();
  469. sinon.assert.calledOnce( renderSpy );
  470. sinon.assert.calledOnce( layoutChangedSpy );
  471. } );
  472. } );
  473. describe( 'view and DOM integration', () => {
  474. it( 'should remove content of the DOM', () => {
  475. const domDiv = createElement( document, 'div', { id: 'editor' }, [
  476. createElement( document, 'p' ),
  477. createElement( document, 'p' )
  478. ] );
  479. const view = new View( new StylesProcessor() );
  480. const viewDocument = view.document;
  481. createViewRoot( viewDocument, 'div', 'main' );
  482. view.attachDomRoot( domDiv );
  483. view.forceRender();
  484. expect( domDiv.childNodes.length ).to.equal( 1 );
  485. expect( view.domConverter.isBlockFiller( domDiv.childNodes[ 0 ] ) ).to.be.true;
  486. view.destroy();
  487. domDiv.remove();
  488. } );
  489. it( 'should render changes in the Document', () => {
  490. const domDiv = document.createElement( 'div' );
  491. const view = new View( new StylesProcessor() );
  492. const viewDocument = view.document;
  493. createViewRoot( viewDocument, 'div', 'main' );
  494. view.attachDomRoot( domDiv );
  495. viewDocument.getRoot()._appendChild( new ViewElement( viewDocument, 'p' ) );
  496. view.forceRender();
  497. expect( domDiv.childNodes.length ).to.equal( 1 );
  498. expect( domDiv.childNodes[ 0 ].tagName ).to.equal( 'P' );
  499. view.destroy();
  500. } );
  501. it( 'should render attribute changes', () => {
  502. const domRoot = document.createElement( 'div' );
  503. const view = new View( new StylesProcessor() );
  504. const viewDocument = view.document;
  505. const viewRoot = createViewRoot( viewDocument, 'div', 'main' );
  506. view.attachDomRoot( domRoot );
  507. const viewP = new ViewElement( viewDocument, 'p', { class: 'foo' } );
  508. viewRoot._appendChild( viewP );
  509. view.forceRender();
  510. expect( domRoot.childNodes.length ).to.equal( 1 );
  511. expect( domRoot.childNodes[ 0 ].getAttribute( 'class' ) ).to.equal( 'foo' );
  512. viewP._setAttribute( 'class', 'bar' );
  513. view.forceRender();
  514. expect( domRoot.childNodes.length ).to.equal( 1 );
  515. expect( domRoot.childNodes[ 0 ].getAttribute( 'class' ) ).to.equal( 'bar' );
  516. view.destroy();
  517. domRoot.remove();
  518. } );
  519. } );
  520. describe( 'change()', () => {
  521. it( 'should throw when someone tries to change view during rendering', () => {
  522. const domDiv = document.createElement( 'div' );
  523. const viewRoot = createViewRoot( viewDocument, 'div', 'main' );
  524. let renderingCalled = false;
  525. view.attachDomRoot( domDiv );
  526. view.change( writer => {
  527. const p = writer.createContainerElement( 'p' );
  528. const ui = writer.createUIElement( 'span', null, function( domDocument ) {
  529. const element = this.toDomElement( domDocument );
  530. expectToThrowCKEditorError( () => {
  531. view.change( () => {} );
  532. }, /^cannot-change-view-tree/, view );
  533. renderingCalled = true;
  534. return element;
  535. } );
  536. writer.insert( ViewPosition._createAt( p, 0 ), ui );
  537. writer.insert( ViewPosition._createAt( viewRoot, 0 ), p );
  538. } );
  539. expect( renderingCalled ).to.be.true;
  540. domDiv.remove();
  541. } );
  542. it( 'should throw when someone tries to use change() method in post-fixer', () => {
  543. const domDiv = document.createElement( 'div' );
  544. createViewRoot( viewDocument, 'div', 'main' );
  545. view.attachDomRoot( domDiv );
  546. viewDocument.registerPostFixer( () => {
  547. expectToThrowCKEditorError( () => {
  548. view.change( () => {} );
  549. }, /^cannot-change-view-tree/, view );
  550. } );
  551. view.forceRender();
  552. domDiv.remove();
  553. } );
  554. it( 'should fire render event and it should trigger rendering before listeners on normal priority', () => {
  555. const renderSpy = sinon.spy( view._renderer, 'render' );
  556. const eventSpy = sinon.spy();
  557. view.on( 'render', eventSpy );
  558. view.change( writer => {
  559. writer.setSelection( null );
  560. } );
  561. sinon.assert.callOrder( renderSpy, eventSpy );
  562. } );
  563. it( 'should fire render event once for nested change blocks', () => {
  564. const renderSpy = sinon.spy( view._renderer, 'render' );
  565. const eventSpy = sinon.spy();
  566. const viewEditable = createViewRoot( viewDocument, 'div', 'main' );
  567. view.on( 'render', eventSpy );
  568. view.change( writer => {
  569. writer.setSelection( null );
  570. view.change( writer => {
  571. writer.setSelection( viewEditable, 0 );
  572. } );
  573. view.change( writer => {
  574. writer.setSelection( null );
  575. view.change( writer => {
  576. writer.setSelection( viewEditable, 0 );
  577. } );
  578. } );
  579. view.change( writer => {
  580. writer.setSelection( null );
  581. } );
  582. } );
  583. sinon.assert.calledOnce( renderSpy );
  584. sinon.assert.calledOnce( eventSpy );
  585. sinon.assert.callOrder( renderSpy, eventSpy );
  586. } );
  587. it( 'should fire render event once even if render is called during the change', () => {
  588. const renderSpy = sinon.spy( view._renderer, 'render' );
  589. const eventSpy = sinon.spy();
  590. view.on( 'render', eventSpy );
  591. view.change( () => {
  592. view.forceRender();
  593. view.change( writer => {
  594. writer.setSelection( null );
  595. view.forceRender();
  596. } );
  597. view.forceRender();
  598. } );
  599. sinon.assert.calledOnce( renderSpy );
  600. sinon.assert.calledOnce( eventSpy );
  601. sinon.assert.callOrder( renderSpy, eventSpy );
  602. } );
  603. it( 'should call post-fixers after change but before rendering', () => {
  604. const postFixer1 = sinon.spy( () => false );
  605. const postFixer2 = sinon.spy( () => false );
  606. const changeSpy = sinon.spy();
  607. const eventSpy = sinon.spy();
  608. viewDocument.registerPostFixer( postFixer1 );
  609. viewDocument.registerPostFixer( postFixer2 );
  610. view.on( 'render', eventSpy );
  611. view.change( writer => {
  612. changeSpy();
  613. writer.setSelection( null );
  614. } );
  615. sinon.assert.calledOnce( postFixer1 );
  616. sinon.assert.calledOnce( postFixer2 );
  617. sinon.assert.calledOnce( changeSpy );
  618. sinon.assert.calledOnce( eventSpy );
  619. sinon.assert.callOrder( changeSpy, postFixer1, postFixer2, eventSpy );
  620. } );
  621. it( 'should call post-fixers until all are done', () => {
  622. let called = false;
  623. const postFixer1 = sinon.spy();
  624. const postFixer2 = sinon.spy();
  625. const changeSpy = sinon.spy();
  626. const eventSpy = sinon.spy();
  627. viewDocument.registerPostFixer( () => {
  628. if ( !called ) {
  629. called = true;
  630. postFixer1();
  631. return true;
  632. }
  633. postFixer2();
  634. return false;
  635. } );
  636. view.on( 'render', eventSpy );
  637. view.change( writer => {
  638. changeSpy();
  639. writer.setSelection( null );
  640. } );
  641. sinon.assert.calledOnce( postFixer1 );
  642. sinon.assert.calledOnce( postFixer2 );
  643. sinon.assert.calledOnce( changeSpy );
  644. sinon.assert.calledOnce( eventSpy );
  645. sinon.assert.callOrder( changeSpy, postFixer1, postFixer2, eventSpy );
  646. } );
  647. it( 'should return result of the callback', () => {
  648. const result = view.change( () => {
  649. return 'FooBar';
  650. } );
  651. expect( result ).to.equal( 'FooBar' );
  652. } );
  653. it( 'should return result of the callback with nested change block', () => {
  654. let result2 = false;
  655. let result3 = false;
  656. const result1 = view.change( () => {
  657. return view.change( () => {
  658. result2 = view.change( () => {
  659. return true;
  660. } );
  661. result3 = view.change( () => {} );
  662. return 42;
  663. } );
  664. } );
  665. expect( result1 ).to.equal( 42 );
  666. expect( result2 ).to.equal( true );
  667. expect( result3 ).to.undefined;
  668. } );
  669. it( 'should rethrow native errors as they are in the dubug=true mode', () => {
  670. const error = new TypeError( 'foo' );
  671. expect( () => {
  672. view.change( () => {
  673. throw error;
  674. } );
  675. } ).to.throw( TypeError, /foo/ );
  676. } );
  677. it( 'should rethrow custom CKEditorError errors', () => {
  678. expectToThrowCKEditorError( () => {
  679. view.change( () => {
  680. throw new CKEditorError( 'foo', view );
  681. } );
  682. }, /foo/, view );
  683. } );
  684. } );
  685. describe( 'createPositionAt()', () => {
  686. it( 'should return instance of Position', () => {
  687. createViewRoot( viewDocument, 'div', 'main' );
  688. viewDocument.getRoot()._appendChild( new ViewElement( 'p' ) );
  689. expect( view.createPositionAt( viewDocument.getRoot(), 0 ) ).to.be.instanceof( ViewPosition );
  690. } );
  691. } );
  692. describe( 'createPositionAfter()', () => {
  693. it( 'should return instance of Position', () => {
  694. createViewRoot( viewDocument, 'div', 'main' );
  695. viewDocument.getRoot()._appendChild( new ViewElement( 'p' ) );
  696. expect( view.createPositionAfter( viewDocument.getRoot().getChild( 0 ) ) ).to.be.instanceof( ViewPosition );
  697. } );
  698. } );
  699. describe( 'createPositionBefore()', () => {
  700. it( 'should return instance of Position', () => {
  701. createViewRoot( viewDocument, 'div', 'main' );
  702. viewDocument.getRoot()._appendChild( new ViewElement( 'p' ) );
  703. expect( view.createPositionBefore( viewDocument.getRoot().getChild( 0 ) ) ).to.be.instanceof( ViewPosition );
  704. } );
  705. } );
  706. describe( 'createRange()', () => {
  707. it( 'should return instance of Range', () => {
  708. createViewRoot( viewDocument, 'div', 'main' );
  709. viewDocument.getRoot()._appendChild( new ViewElement( 'p' ) );
  710. expect( view.createRange( view.createPositionAt( viewDocument.getRoot(), 0 ) ) ).to.be.instanceof( ViewRange );
  711. } );
  712. } );
  713. describe( 'createRangeIn()', () => {
  714. it( 'should return instance of Range', () => {
  715. createViewRoot( viewDocument, 'div', 'main' );
  716. viewDocument.getRoot()._appendChild( new ViewElement( 'p' ) );
  717. expect( view.createRangeIn( viewDocument.getRoot().getChild( 0 ) ) ).to.be.instanceof( ViewRange );
  718. } );
  719. } );
  720. describe( 'createRangeOn()', () => {
  721. it( 'should return instance of Range', () => {
  722. createViewRoot( viewDocument, 'div', 'main' );
  723. viewDocument.getRoot()._appendChild( new ViewElement( 'p' ) );
  724. expect( view.createRangeOn( viewDocument.getRoot().getChild( 0 ) ) ).to.be.instanceof( ViewRange );
  725. } );
  726. } );
  727. describe( 'createSelection()', () => {
  728. it( 'should return instance of Selection', () => {
  729. createViewRoot( viewDocument, 'div', 'main' );
  730. viewDocument.getRoot()._appendChild( new ViewElement( 'p' ) );
  731. expect( view.createSelection() ).to.be.instanceof( ViewSelection );
  732. } );
  733. } );
  734. describe( 'destroy()', () => {
  735. it( 'should destroy all observers', () => {
  736. const observerMock = view.addObserver( ObserverMock );
  737. view.destroy();
  738. sinon.assert.calledOnce( observerMock.destroy );
  739. } );
  740. } );
  741. } );