view.js 26 KB

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