dom-to-view.js 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432
  1. /**
  2. * @license Copyright (c) 2003-2015, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* bender-tags: treeview, domconverter, browser-only */
  6. 'use strict';
  7. import ViewElement from '/ckeditor5/engine/treeview/element.js';
  8. import DomConverter from '/ckeditor5/engine/treeview/domconverter.js';
  9. import ViewDocumentFragment from '/ckeditor5/engine/treeview/documentfragment.js';
  10. import { INLINE_FILLER, INLINE_FILLER_LENGTH, NBSP_FILLER } from '/ckeditor5/engine/treeview/filler.js';
  11. import { parse, stringify } from '/tests/engine/_utils/view.js';
  12. import count from '/ckeditor5/utils/count.js';
  13. import createElement from '/ckeditor5/utils/dom/createelement.js';
  14. describe( 'DomConverter', () => {
  15. let converter;
  16. before( () => {
  17. converter = new DomConverter();
  18. } );
  19. describe( 'domToView', () => {
  20. it( 'should create tree of view elements from DOM elements', () => {
  21. const domImg = createElement( document, 'img' );
  22. const domText = document.createTextNode( 'foo' );
  23. const domP = createElement( document, 'p', { 'class': 'foo' }, [ domImg, domText ] );
  24. const viewImg = new ViewElement( 'img' );
  25. converter.bindElements( domImg, viewImg );
  26. const viewP = converter.domToView( domP );
  27. expect( viewP ).to.be.an.instanceof( ViewElement );
  28. expect( viewP.name ).to.equal( 'p' );
  29. expect( viewP.getAttribute( 'class' ) ).to.equal( 'foo' );
  30. expect( count( viewP.getAttributeKeys() ) ).to.equal( 1 );
  31. expect( viewP.getChildCount() ).to.equal( 2 );
  32. expect( viewP.getChild( 0 ).name ).to.equal( 'img' );
  33. expect( viewP.getChild( 1 ).data ).to.equal( 'foo' );
  34. expect( converter.getCorrespondingDom( viewP ) ).to.not.equal( domP );
  35. expect( converter.getCorrespondingDom( viewP.getChild( 0 ) ) ).to.equal( domImg );
  36. } );
  37. it( 'should create tree of view elements from DOM elements and bind elements', () => {
  38. const domImg = createElement( document, 'img' );
  39. const domText = document.createTextNode( 'foo' );
  40. const domP = createElement( document, 'p', { 'class': 'foo' }, [ domImg, domText ] );
  41. const viewP = converter.domToView( domP, { bind: true } );
  42. expect( viewP ).to.be.an.instanceof( ViewElement );
  43. expect( viewP.name ).to.equal( 'p' );
  44. expect( viewP.getAttribute( 'class' ) ).to.equal( 'foo' );
  45. expect( count( viewP.getAttributeKeys() ) ).to.equal( 1 );
  46. expect( viewP.getChildCount() ).to.equal( 2 );
  47. expect( viewP.getChild( 0 ).name ).to.equal( 'img' );
  48. expect( viewP.getChild( 1 ).data ).to.equal( 'foo' );
  49. expect( converter.getCorrespondingDom( viewP ) ).to.equal( domP );
  50. expect( converter.getCorrespondingDom( viewP.getChild( 0 ) ) ).to.equal( domP.childNodes[ 0 ] );
  51. } );
  52. it( 'should create tree of view elements from DOM element without children', () => {
  53. const domImg = createElement( document, 'img' );
  54. const domText = document.createTextNode( 'foo' );
  55. const domP = createElement( document, 'p', { 'class': 'foo' }, [ domImg, domText ] );
  56. const viewImg = new ViewElement( 'img' );
  57. converter.bindElements( domImg, viewImg );
  58. const viewP = converter.domToView( domP, { withChildren: false } );
  59. expect( viewP ).to.be.an.instanceof( ViewElement );
  60. expect( viewP.name ).to.equal( 'p' );
  61. expect( viewP.getAttribute( 'class' ) ).to.equal( 'foo' );
  62. expect( count( viewP.getAttributeKeys() ) ).to.equal( 1 );
  63. expect( viewP.getChildCount() ).to.equal( 0 );
  64. expect( converter.getCorrespondingDom( viewP ) ).to.not.equal( domP );
  65. } );
  66. it( 'should create view document fragment from DOM document fragment', () => {
  67. const domImg = createElement( document, 'img' );
  68. const domText = document.createTextNode( 'foo' );
  69. const domFragment = document.createDocumentFragment();
  70. domFragment.appendChild( domImg );
  71. domFragment.appendChild( domText );
  72. const viewFragment = converter.domToView( domFragment, { bind: true } );
  73. expect( viewFragment ).to.be.an.instanceof( ViewDocumentFragment );
  74. expect( viewFragment.getChildCount() ).to.equal( 2 );
  75. expect( viewFragment.getChild( 0 ).name ).to.equal( 'img' );
  76. expect( viewFragment.getChild( 1 ).data ).to.equal( 'foo' );
  77. expect( converter.getCorrespondingDom( viewFragment ) ).to.equal( domFragment );
  78. expect( converter.getCorrespondingDom( viewFragment.getChild( 0 ) ) ).to.equal( domFragment.childNodes[ 0 ] );
  79. } );
  80. it( 'should create view document fragment from DOM document fragment without children', () => {
  81. const domImg = createElement( document, 'img' );
  82. const domText = document.createTextNode( 'foo' );
  83. const domFragment = document.createDocumentFragment();
  84. domFragment.appendChild( domImg );
  85. domFragment.appendChild( domText );
  86. const viewImg = new ViewElement( 'img' );
  87. converter.bindElements( domImg, viewImg );
  88. const viewFragment = converter.domToView( domFragment, { withChildren: false } );
  89. expect( viewFragment ).to.be.an.instanceof( ViewDocumentFragment );
  90. expect( viewFragment.getChildCount() ).to.equal( 0 );
  91. expect( converter.getCorrespondingDom( viewFragment ) ).to.not.equal( domFragment );
  92. } );
  93. it( 'should return already bind document fragment', () => {
  94. const domFragment = document.createDocumentFragment();
  95. const viewFragment = new ViewDocumentFragment();
  96. converter.bindDocumentFragments( domFragment, viewFragment );
  97. const viewFragment2 = converter.domToView( domFragment );
  98. expect( viewFragment2 ).to.equal( viewFragment );
  99. } );
  100. it( 'should return null for block filler', () => {
  101. const domFiller = converter.blockFiller( document );
  102. const viewFiller = converter.domToView( domFiller );
  103. expect( viewFiller ).to.be.null;
  104. } );
  105. } );
  106. describe( 'domChildrenToView', () => {
  107. it( 'should convert children', () => {
  108. const domImg = createElement( document, 'img' );
  109. const domText = document.createTextNode( 'foo' );
  110. const domP = createElement( document, 'p', null, [ domImg, domText ] );
  111. const viewChildren = Array.from( converter.domChildrenToView( domP ) );
  112. expect( viewChildren.length ).to.equal( 2 );
  113. expect( stringify( viewChildren[ 0 ] ) ).to.equal( '<img></img>' );
  114. expect( stringify( viewChildren[ 1 ] ) ).to.equal( 'foo' );
  115. } );
  116. it( 'should skip filler', () => {
  117. const domFiller = converter.blockFiller( document );
  118. const domP = createElement( document, 'p', null, domFiller );
  119. const viewChildren = Array.from( converter.domChildrenToView( domP ) );
  120. expect( viewChildren.length ).to.equal( 0 );
  121. } );
  122. it( 'should pass options', () => {
  123. const domText = document.createTextNode( 'foo' );
  124. const domB = createElement( document, 'b', null, 'bar' );
  125. const domP = createElement( document, 'p', null, [ domB, domText ] );
  126. const viewChildren = Array.from( converter.domChildrenToView( domP, { withChildren: false } ) );
  127. expect( viewChildren.length ).to.equal( 2 );
  128. expect( stringify( viewChildren[ 0 ] ) ).to.equal( '<b></b>' );
  129. expect( stringify( viewChildren[ 1 ] ) ).to.equal( 'foo' );
  130. } );
  131. } );
  132. describe( 'domPositionToView', () => {
  133. it( 'should converter position in text', () => {
  134. const domText = document.createTextNode( 'foo' );
  135. const domB = createElement( document, 'b', null, 'bar' );
  136. const domP = createElement( document, 'p', null, [ domText, domB ] );
  137. const viewP = parse( '<p>foo<b>bar</b></p>' );
  138. converter.bindElements( domP, viewP );
  139. converter.bindElements( domB, viewP.getChild( 0 ) );
  140. const viewPosition = converter.domPositionToView( domText, 2 );
  141. expect( stringify( viewP, viewPosition ) ).to.equal( '<p>fo{}o<b>bar</b></p>' );
  142. } );
  143. it( 'should converter position in element', () => {
  144. const domText = document.createTextNode( 'foo' );
  145. const domB = createElement( document, 'b', null, 'bar' );
  146. const domP = createElement( document, 'p', null, [ domText, domB ] );
  147. const viewP = parse( '<p>foo<b>bar</b></p>' );
  148. converter.bindElements( domP, viewP );
  149. converter.bindElements( domB, viewP.getChild( 0 ) );
  150. const viewPosition = converter.domPositionToView( domP, 1 );
  151. expect( stringify( viewP, viewPosition ) ).to.equal( '<p>foo[]<b>bar</b></p>' );
  152. } );
  153. it( 'should converter position at the beginning', () => {
  154. const domText = document.createTextNode( 'foo' );
  155. const domP = createElement( document, 'p', null, domText );
  156. const viewP = parse( '<p>foo</p>' );
  157. converter.bindElements( domP, viewP );
  158. const viewPosition = converter.domPositionToView( domP, 0 );
  159. expect( stringify( viewP, viewPosition ) ).to.equal( '<p>[]foo</p>' );
  160. } );
  161. it( 'should converter position inside block filler', () => {
  162. const converter = new DomConverter( { blockFiller: NBSP_FILLER } );
  163. const domFiller = NBSP_FILLER( document );
  164. const domP = createElement( document, 'p', null, domFiller );
  165. const viewP = parse( '<p></p>' );
  166. converter.bindElements( domP, viewP );
  167. const viewPosition = converter.domPositionToView( domFiller, 0 );
  168. expect( stringify( viewP, viewPosition ) ).to.equal( '<p>[]</p>' );
  169. } );
  170. it( 'should converter position inside inline filler', () => {
  171. const domFiller = document.createTextNode( INLINE_FILLER );
  172. const domText = document.createTextNode( 'foo' );
  173. const domB = createElement( document, 'b', null, domFiller );
  174. const domP = createElement( document, 'p', null, [ domText, domB ] );
  175. const viewP = parse( '<p>foo<b></b></p>' );
  176. converter.bindElements( domP, viewP );
  177. converter.bindElements( domB, viewP.getChild( 1 ) );
  178. const viewPosition = converter.domPositionToView( domFiller, INLINE_FILLER_LENGTH );
  179. expect( stringify( viewP, viewPosition ) ).to.equal( '<p>foo<b>[]</b></p>' );
  180. } );
  181. it( 'should converter position inside inline filler with text', () => {
  182. const domFiller = document.createTextNode( INLINE_FILLER + 'bar' );
  183. const domText = document.createTextNode( 'foo' );
  184. const domB = createElement( document, 'b', null, domFiller );
  185. const domP = createElement( document, 'p', null, [ domText, domB ] );
  186. const viewP = parse( '<p>foo<b>bar</b></p>' );
  187. converter.bindElements( domP, viewP );
  188. converter.bindElements( domB, viewP.getChild( 1 ) );
  189. const viewPosition = converter.domPositionToView( domFiller, INLINE_FILLER_LENGTH + 2 );
  190. expect( viewPosition.offset ).to.equal( 2 );
  191. expect( stringify( viewP, viewPosition ) ).to.equal( '<p>foo<b>ba{}r</b></p>' );
  192. } );
  193. it( 'should converter position inside inline filler with text at the beginning', () => {
  194. const domFiller = document.createTextNode( INLINE_FILLER + 'bar' );
  195. const domText = document.createTextNode( 'foo' );
  196. const domB = createElement( document, 'b', null, domFiller );
  197. const domP = createElement( document, 'p', null, [ domText, domB ] );
  198. const viewP = parse( '<p>foo<b>bar</b></p>' );
  199. converter.bindElements( domP, viewP );
  200. converter.bindElements( domB, viewP.getChild( 1 ) );
  201. const viewPosition = converter.domPositionToView( domFiller, INLINE_FILLER_LENGTH - 1 );
  202. expect( viewPosition.offset ).to.equal( 0 );
  203. expect( stringify( viewP, viewPosition ) ).to.equal( '<p>foo<b>{}bar</b></p>' );
  204. } );
  205. it( 'should converter position at the end', () => {
  206. const domText = document.createTextNode( 'foo' );
  207. const domP = createElement( document, 'p', null, domText );
  208. const viewP = parse( '<p>foo</p>' );
  209. converter.bindElements( domP, viewP );
  210. const viewPosition = converter.domPositionToView( domP, 1 );
  211. expect( stringify( viewP, viewPosition ) ).to.equal( '<p>foo[]</p>' );
  212. } );
  213. it( 'should return null if there is no corresponding parent node', () => {
  214. const domText = document.createTextNode( 'foo' );
  215. const domP = createElement( document, 'p', null, domText );
  216. const viewPosition = converter.domPositionToView( domP, 0 );
  217. expect( viewPosition ).to.be.null;
  218. } );
  219. it( 'should return null if there is no corresponding sibling node', () => {
  220. const domB = createElement( document, 'b', null, 'bar' );
  221. const domText = document.createTextNode( 'foo' );
  222. const domP = createElement( document, 'p', null, [ domB, domText ] );
  223. const viewPosition = converter.domPositionToView( domP, 1 );
  224. expect( viewPosition ).to.be.null;
  225. } );
  226. it( 'should return null if there is no corresponding text node', () => {
  227. const domText = document.createTextNode( 'foo' );
  228. const viewPosition = converter.domPositionToView( domText, 1 );
  229. expect( viewPosition ).to.be.null;
  230. } );
  231. } );
  232. describe( 'domRangeToView', () => {
  233. it( 'should converter DOM range', () => {
  234. const domFoo = document.createTextNode( 'foo' );
  235. const domBar = document.createTextNode( 'bar' );
  236. const domB = createElement( document, 'b', null, domBar );
  237. const domP = createElement( document, 'p', null, [ domFoo, domB ] );
  238. const viewP = parse( '<p>foo<b>bar</b></p>' );
  239. converter.bindElements( domP, viewP );
  240. converter.bindElements( domB, viewP.getChild( 1 ) );
  241. const domRange = new Range();
  242. domRange.setStart( domFoo, 1 );
  243. domRange.setEnd( domBar, 2 );
  244. const viewRange = converter.domRangeToView( domRange );
  245. expect( stringify( viewP, viewRange ) ).to.equal( '<p>f{oo<b>ba}r</b></p>' );
  246. } );
  247. it( 'should return null if start or end is null', () => {
  248. const domFoo = document.createTextNode( 'foo' );
  249. const domBar = document.createTextNode( 'bar' );
  250. const domB = createElement( document, 'b', null, domBar );
  251. createElement( document, 'p', null, [ domFoo, domB ] );
  252. const domRange = new Range();
  253. domRange.setStart( domFoo, 1 );
  254. domRange.setEnd( domBar, 2 );
  255. const viewRange = converter.domRangeToView( domRange );
  256. expect( viewRange ).to.be.null;
  257. } );
  258. } );
  259. describe( 'domSelectionToView', () => {
  260. it( 'should converter selection', () => {
  261. const domFoo = document.createTextNode( 'foo' );
  262. const domBar = document.createTextNode( 'bar' );
  263. const domB = createElement( document, 'b', null, domBar );
  264. const domP = createElement( document, 'p', null, [ domFoo, domB ] );
  265. const viewP = parse( '<p>foo<b>bar</b></p>' );
  266. converter.bindElements( domP, viewP );
  267. converter.bindElements( domB, viewP.getChild( 1 ) );
  268. document.body.appendChild( domP );
  269. const domRange = new Range();
  270. domRange.setStart( domFoo, 1 );
  271. domRange.setEnd( domBar, 2 );
  272. const domSelection = document.getSelection();
  273. domSelection.removeAllRanges();
  274. domSelection.addRange( domRange );
  275. const viewSelection = converter.domSelectionToView( domSelection );
  276. expect( viewSelection.rangeCount ).to.equal( 1 );
  277. expect( stringify( viewP, viewSelection.getFirstRange() ) ).to.equal( '<p>f{oo<b>ba}r</b></p>' );
  278. } );
  279. it( 'should converter empty selection to empty selection', () => {
  280. const domSelection = document.getSelection();
  281. domSelection.removeAllRanges();
  282. const viewSelection = converter.domSelectionToView( domSelection );
  283. expect( viewSelection.rangeCount ).to.equal( 0 );
  284. } );
  285. it( 'should not add null ranges', () => {
  286. const domFoo = document.createTextNode( 'foo' );
  287. const domBar = document.createTextNode( 'bar' );
  288. const domB = createElement( document, 'b', null, domBar );
  289. const domP = createElement( document, 'p', null, [ domFoo, domB ] );
  290. document.body.appendChild( domP );
  291. const domRange = new Range();
  292. domRange.setStart( domFoo, 1 );
  293. domRange.setEnd( domBar, 2 );
  294. const domSelection = document.getSelection();
  295. domSelection.removeAllRanges();
  296. domSelection.addRange( domRange );
  297. const viewSelection = converter.domSelectionToView( domSelection );
  298. expect( viewSelection.rangeCount ).to.equal( 0 );
  299. } );
  300. } );
  301. } );