8
0

domconverter.js 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586
  1. /**
  2. * @license Copyright (c) 2003-2015, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* bender-tags: treeview */
  6. 'use strict';
  7. import count from '/ckeditor5/utils/count.js';
  8. import ViewElement from '/ckeditor5/engine/treeview/element.js';
  9. import ViewText from '/ckeditor5/engine/treeview/text.js';
  10. import DomConverter from '/ckeditor5/engine/treeview/domconverter.js';
  11. import ViewDocumentFragment from '/ckeditor5/engine/treeview/documentfragment.js';
  12. describe( 'DomConverter', () => {
  13. let converter;
  14. before( () => {
  15. converter = new DomConverter();
  16. } );
  17. describe( 'bindElements', () => {
  18. it( 'should bind elements', () => {
  19. const domElement = document.createElement( 'p' );
  20. const viewElement = new ViewElement( 'p' );
  21. converter.bindElements( domElement, viewElement );
  22. expect( converter.getCorrespondingView( domElement ) ).to.equal( viewElement );
  23. expect( converter.getCorrespondingDom( viewElement ) ).to.equal( domElement );
  24. } );
  25. } );
  26. describe( 'bindDocumentFragments', () => {
  27. it( 'should bind document fragments', () => {
  28. const domFragment = document.createDocumentFragment();
  29. const viewFragment = new ViewDocumentFragment();
  30. converter.bindDocumentFragments( domFragment, viewFragment );
  31. expect( converter.getCorrespondingView( domFragment ) ).to.equal( viewFragment );
  32. expect( converter.getCorrespondingDom( viewFragment ) ).to.equal( domFragment );
  33. } );
  34. } );
  35. describe( 'compareNodes', () => {
  36. it( 'should return false for nodes not matching types', () => {
  37. const domElement = document.createElement( 'p' );
  38. const viewText = new ViewText( 'foo' );
  39. expect( converter.compareNodes( domElement, viewText ) ).to.be.false;
  40. } );
  41. it( 'should return true for bound elements', () => {
  42. const domElement = document.createElement( 'p' );
  43. const viewElement = new ViewElement( 'p' );
  44. converter.bindElements( domElement, viewElement );
  45. expect( converter.compareNodes( domElement, viewElement ) ).to.be.true;
  46. } );
  47. it( 'should return true for the same texts', () => {
  48. const domText = document.createTextNode( 'foo' );
  49. const viewText = new ViewText( 'foo' );
  50. expect( converter.compareNodes( domText, viewText ) ).to.be.true;
  51. } );
  52. } );
  53. describe( 'domToView', () => {
  54. it( 'should create tree of view elements from DOM elements', () => {
  55. const domImg = document.createElement( 'img' );
  56. const domText = document.createTextNode( 'foo' );
  57. const domP = document.createElement( 'p' );
  58. domP.setAttribute( 'class', 'foo' );
  59. domP.appendChild( domImg );
  60. domP.appendChild( domText );
  61. const viewImg = new ViewElement( 'img' );
  62. converter.bindElements( domImg, viewImg );
  63. const viewP = converter.domToView( domP );
  64. expect( viewP ).to.be.an.instanceof( ViewElement );
  65. expect( viewP.name ).to.equal( 'p' );
  66. expect( viewP.getAttribute( 'class' ) ).to.equal( 'foo' );
  67. expect( count( viewP.getAttributeKeys() ) ).to.equal( 1 );
  68. expect( viewP.getChildCount() ).to.equal( 2 );
  69. expect( viewP.getChild( 0 ).name ).to.equal( 'img' );
  70. expect( viewP.getChild( 1 ).data ).to.equal( 'foo' );
  71. expect( converter.getCorrespondingDom( viewP ) ).to.not.equal( domP );
  72. expect( converter.getCorrespondingDom( viewP.getChild( 0 ) ) ).to.equal( domImg );
  73. } );
  74. it( 'should create tree of view elements from DOM elements and bind elements', () => {
  75. const domImg = document.createElement( 'img' );
  76. const domText = document.createTextNode( 'foo' );
  77. const domP = document.createElement( 'p' );
  78. domP.setAttribute( 'class', 'foo' );
  79. domP.appendChild( domImg );
  80. domP.appendChild( domText );
  81. const viewP = converter.domToView( domP, { bind: true } );
  82. expect( viewP ).to.be.an.instanceof( ViewElement );
  83. expect( viewP.name ).to.equal( 'p' );
  84. expect( viewP.getAttribute( 'class' ) ).to.equal( 'foo' );
  85. expect( count( viewP.getAttributeKeys() ) ).to.equal( 1 );
  86. expect( viewP.getChildCount() ).to.equal( 2 );
  87. expect( viewP.getChild( 0 ).name ).to.equal( 'img' );
  88. expect( viewP.getChild( 1 ).data ).to.equal( 'foo' );
  89. expect( converter.getCorrespondingDom( viewP ) ).to.equal( domP );
  90. expect( converter.getCorrespondingDom( viewP.getChild( 0 ) ) ).to.equal( domP.childNodes[ 0 ] );
  91. } );
  92. it( 'should create tree of view elements from DOM element without children', () => {
  93. const domImg = document.createElement( 'img' );
  94. const domText = document.createTextNode( 'foo' );
  95. const domP = document.createElement( 'p' );
  96. domP.setAttribute( 'class', 'foo' );
  97. domP.appendChild( domImg );
  98. domP.appendChild( domText );
  99. const viewImg = new ViewElement( 'img' );
  100. converter.bindElements( domImg, viewImg );
  101. const viewP = converter.domToView( domP, { withChildren: false } );
  102. expect( viewP ).to.be.an.instanceof( ViewElement );
  103. expect( viewP.name ).to.equal( 'p' );
  104. expect( viewP.getAttribute( 'class' ) ).to.equal( 'foo' );
  105. expect( count( viewP.getAttributeKeys() ) ).to.equal( 1 );
  106. expect( viewP.getChildCount() ).to.equal( 0 );
  107. expect( converter.getCorrespondingDom( viewP ) ).to.not.equal( domP );
  108. } );
  109. it( 'should create view document fragment from DOM document fragment', () => {
  110. const domImg = document.createElement( 'img' );
  111. const domText = document.createTextNode( 'foo' );
  112. const domFragment = document.createDocumentFragment();
  113. domFragment.appendChild( domImg );
  114. domFragment.appendChild( domText );
  115. const viewFragment = converter.domToView( domFragment, { bind: true } );
  116. expect( viewFragment ).to.be.an.instanceof( ViewDocumentFragment );
  117. expect( viewFragment.getChildCount() ).to.equal( 2 );
  118. expect( viewFragment.getChild( 0 ).name ).to.equal( 'img' );
  119. expect( viewFragment.getChild( 1 ).data ).to.equal( 'foo' );
  120. expect( converter.getCorrespondingDom( viewFragment ) ).to.equal( domFragment );
  121. expect( converter.getCorrespondingDom( viewFragment.getChild( 0 ) ) ).to.equal( domFragment.childNodes[ 0 ] );
  122. } );
  123. it( 'should create view document fragment from DOM document fragment without children', () => {
  124. const domImg = document.createElement( 'img' );
  125. const domText = document.createTextNode( 'foo' );
  126. const domFragment = document.createDocumentFragment();
  127. domFragment.appendChild( domImg );
  128. domFragment.appendChild( domText );
  129. const viewImg = new ViewElement( 'img' );
  130. converter.bindElements( domImg, viewImg );
  131. const viewFragment = converter.domToView( domFragment, { withChildren: false } );
  132. expect( viewFragment ).to.be.an.instanceof( ViewDocumentFragment );
  133. expect( viewFragment.getChildCount() ).to.equal( 0 );
  134. expect( converter.getCorrespondingDom( viewFragment ) ).to.not.equal( domFragment );
  135. } );
  136. it( 'should return already bind document fragment', () => {
  137. const domFragment = document.createDocumentFragment();
  138. const viewFragment = new ViewDocumentFragment();
  139. converter.bindDocumentFragments( domFragment, viewFragment );
  140. const viewFragment2 = converter.domToView( domFragment );
  141. expect( viewFragment2 ).to.equal( viewFragment );
  142. } );
  143. } );
  144. describe( 'viewToDom', () => {
  145. it( 'should create tree of DOM elements from view elements', () => {
  146. const viewImg = new ViewElement( 'img' );
  147. const viewText = new ViewText( 'foo' );
  148. const viewP = new ViewElement( 'p' );
  149. viewP.setAttribute( 'class', 'foo' );
  150. viewP.appendChildren( viewImg );
  151. viewP.appendChildren( viewText );
  152. const domImg = document.createElement( 'img' );
  153. converter.bindElements( domImg, viewImg );
  154. const domP = converter.viewToDom( viewP, document );
  155. expect( domP ).to.be.an.instanceof( HTMLElement );
  156. expect( domP.tagName ).to.equal( 'P' );
  157. expect( domP.getAttribute( 'class' ) ).to.equal( 'foo' );
  158. expect( domP.attributes.length ).to.equal( 1 );
  159. expect( domP.childNodes.length ).to.equal( 2 );
  160. expect( domP.childNodes[ 0 ].tagName ).to.equal( 'IMG' );
  161. expect( domP.childNodes[ 1 ].data ).to.equal( 'foo' );
  162. expect( converter.getCorrespondingView( domP ) ).not.to.equal( viewP );
  163. expect( converter.getCorrespondingView( domP.childNodes[ 0 ] ) ).to.equal( viewImg );
  164. } );
  165. it( 'should create tree of DOM elements from view elements and bind elements', () => {
  166. const viewImg = new ViewElement( 'img' );
  167. const viewText = new ViewText( 'foo' );
  168. const viewP = new ViewElement( 'p' );
  169. viewP.setAttribute( 'class', 'foo' );
  170. viewP.appendChildren( viewImg );
  171. viewP.appendChildren( viewText );
  172. const domP = converter.viewToDom( viewP, document, { bind: true } );
  173. expect( domP ).to.be.an.instanceof( HTMLElement );
  174. expect( domP.tagName ).to.equal( 'P' );
  175. expect( domP.getAttribute( 'class' ) ).to.equal( 'foo' );
  176. expect( domP.attributes.length ).to.equal( 1 );
  177. expect( domP.childNodes.length ).to.equal( 2 );
  178. expect( domP.childNodes[ 0 ].tagName ).to.equal( 'IMG' );
  179. expect( domP.childNodes[ 1 ].data ).to.equal( 'foo' );
  180. expect( converter.getCorrespondingView( domP ) ).to.equal( viewP );
  181. expect( converter.getCorrespondingView( domP.childNodes[ 0 ] ) ).to.equal( viewP.getChild( 0 ) );
  182. } );
  183. it( 'should create tree of DOM elements from view element without children', () => {
  184. const viewImg = new ViewElement( 'img' );
  185. const viewText = new ViewText( 'foo' );
  186. const viewP = new ViewElement( 'p' );
  187. viewP.setAttribute( 'class', 'foo' );
  188. viewP.appendChildren( viewImg );
  189. viewP.appendChildren( viewText );
  190. const domImg = document.createElement( 'img' );
  191. converter.bindElements( domImg, viewImg );
  192. const domP = converter.viewToDom( viewP, document, { withChildren: false } );
  193. expect( domP ).to.be.an.instanceof( HTMLElement );
  194. expect( domP.tagName ).to.equal( 'P' );
  195. expect( domP.getAttribute( 'class' ) ).to.equal( 'foo' );
  196. expect( domP.attributes.length ).to.equal( 1 );
  197. expect( domP.childNodes.length ).to.equal( 0 );
  198. expect( converter.getCorrespondingView( domP ) ).not.to.equal( viewP );
  199. } );
  200. it( 'should create DOM document fragment from view document fragment and bind elements', () => {
  201. const viewImg = new ViewElement( 'img' );
  202. const viewText = new ViewText( 'foo' );
  203. const viewFragment = new ViewDocumentFragment();
  204. viewFragment.appendChildren( viewImg );
  205. viewFragment.appendChildren( viewText );
  206. const domFragment = converter.viewToDom( viewFragment, document, { bind: true } );
  207. expect( domFragment ).to.be.an.instanceof( DocumentFragment );
  208. expect( domFragment.childNodes.length ).to.equal( 2 );
  209. expect( domFragment.childNodes[ 0 ].tagName ).to.equal( 'IMG' );
  210. expect( domFragment.childNodes[ 1 ].data ).to.equal( 'foo' );
  211. expect( converter.getCorrespondingView( domFragment ) ).to.equal( viewFragment );
  212. expect( converter.getCorrespondingView( domFragment.childNodes[ 0 ] ) ).to.equal( viewFragment.getChild( 0 ) );
  213. } );
  214. it( 'should create DOM document fragment from view document without children', () => {
  215. const viewImg = new ViewElement( 'img' );
  216. const viewText = new ViewText( 'foo' );
  217. const viewFragment = new ViewDocumentFragment();
  218. viewFragment.appendChildren( viewImg );
  219. viewFragment.appendChildren( viewText );
  220. const domImg = document.createElement( 'img' );
  221. converter.bindElements( domImg, viewImg );
  222. const domFragment = converter.viewToDom( viewFragment, document, { withChildren: false } );
  223. expect( domFragment ).to.be.an.instanceof( DocumentFragment );
  224. expect( domFragment.childNodes.length ).to.equal( 0 );
  225. expect( converter.getCorrespondingView( domFragment ) ).not.to.equal( viewFragment );
  226. } );
  227. it( 'should return already bind document fragment', () => {
  228. const domFragment = document.createDocumentFragment();
  229. const viewFragment = new ViewDocumentFragment();
  230. converter.bindDocumentFragments( domFragment, viewFragment );
  231. const domFragment2 = converter.viewToDom( viewFragment );
  232. expect( domFragment2 ).to.equal( domFragment );
  233. } );
  234. } );
  235. describe( 'getCorrespondingView', () => {
  236. it( 'should return corresponding view element if element is passed', () => {
  237. const domElement = document.createElement( 'p' );
  238. const viewElement = new ViewElement( 'p' );
  239. converter.bindElements( domElement, viewElement );
  240. expect( converter.getCorrespondingView( domElement ) ).to.equal( viewElement );
  241. } );
  242. it( 'should return corresponding view text if text is passed', () => {
  243. const domText = document.createTextNode( 'foo' );
  244. const domP = document.createElement( 'p' );
  245. domP.appendChild( domText );
  246. const viewP = converter.domToView( domP );
  247. const viewText = viewP.getChild( 0 );
  248. converter.bindElements( domP, viewP );
  249. expect( converter.getCorrespondingView( domText ) ).to.equal( viewText );
  250. } );
  251. it( 'should return corresponding view document fragment', () => {
  252. const domFragment = document.createDocumentFragment();
  253. const viewFragment = converter.domToView( domFragment );
  254. converter.bindElements( domFragment, viewFragment );
  255. expect( converter.getCorrespondingView( domFragment ) ).to.equal( viewFragment );
  256. } );
  257. } );
  258. describe( 'getCorrespondingViewElement', () => {
  259. it( 'should return corresponding view element', () => {
  260. const domElement = document.createElement( 'p' );
  261. const viewElement = new ViewElement( 'p' );
  262. converter.bindElements( domElement, viewElement );
  263. expect( converter.getCorrespondingViewElement( domElement ) ).to.equal( viewElement );
  264. } );
  265. } );
  266. describe( 'getCorrespondingViewDocumentFragment', () => {
  267. it( 'should return corresponding view document fragment', () => {
  268. const domFragment = document.createDocumentFragment();
  269. const viewFragment = converter.domToView( domFragment );
  270. converter.bindElements( domFragment, viewFragment );
  271. expect( converter.getCorrespondingViewDocumentFragment( domFragment ) ).to.equal( viewFragment );
  272. } );
  273. } );
  274. describe( 'getCorrespondingViewText', () => {
  275. it( 'should return corresponding view text based on sibling', () => {
  276. const domImg = document.createElement( 'img' );
  277. const domText = document.createTextNode( 'foo' );
  278. const domP = document.createElement( 'p' );
  279. domP.appendChild( domImg );
  280. domP.appendChild( domText );
  281. const viewImg = new ViewElement( 'img' );
  282. converter.bindElements( domImg, viewImg );
  283. const viewP = converter.domToView( domP );
  284. const viewText = viewP.getChild( 1 );
  285. expect( converter.getCorrespondingViewText( domText ) ).to.equal( viewText );
  286. } );
  287. it( 'should return corresponding view text based on parent', () => {
  288. const domText = document.createTextNode( 'foo' );
  289. const domP = document.createElement( 'p' );
  290. domP.appendChild( domText );
  291. const viewP = converter.domToView( domP );
  292. const viewText = viewP.getChild( 0 );
  293. converter.bindElements( domP, viewP );
  294. expect( converter.getCorrespondingViewText( domText ) ).to.equal( viewText );
  295. } );
  296. it( 'should return null if sibling is not bound', () => {
  297. const domImg = document.createElement( 'img' );
  298. const domText = document.createTextNode( 'foo' );
  299. const domP = document.createElement( 'p' );
  300. domP.appendChild( domImg );
  301. domP.appendChild( domText );
  302. const viewP = converter.domToView( domP );
  303. converter.bindElements( domP, viewP );
  304. expect( converter.getCorrespondingViewText( domText ) ).to.be.null;
  305. } );
  306. it( 'should return null if sibling is not element', () => {
  307. const domTextFoo = document.createTextNode( 'foo' );
  308. const domTextBar = document.createTextNode( 'bar' );
  309. const domP = document.createElement( 'p' );
  310. domP.appendChild( domTextFoo );
  311. domP.appendChild( domTextBar );
  312. const viewP = converter.domToView( domP );
  313. converter.bindElements( domP, viewP );
  314. expect( converter.getCorrespondingViewText( domTextBar ) ).to.be.null;
  315. } );
  316. it( 'should return null if parent is not bound', () => {
  317. const domText = document.createTextNode( 'foo' );
  318. const domP = document.createElement( 'p' );
  319. domP.appendChild( domText );
  320. expect( converter.getCorrespondingViewText( domText ) ).to.be.null;
  321. } );
  322. } );
  323. describe( 'getCorrespondingDom', () => {
  324. it( 'should return corresponding DOM element if element was passed', () => {
  325. const domElement = document.createElement( 'p' );
  326. const viewElement = new ViewElement( 'p' );
  327. converter.bindElements( domElement, viewElement );
  328. expect( converter.getCorrespondingDom( viewElement ) ).to.equal( domElement );
  329. } );
  330. it( 'should return corresponding DOM text if text was passed', () => {
  331. const domText = document.createTextNode( 'foo' );
  332. const domP = document.createElement( 'p' );
  333. domP.appendChild( domText );
  334. const viewP = converter.domToView( domP );
  335. const viewText = viewP.getChild( 0 );
  336. converter.bindElements( domP, viewP );
  337. expect( converter.getCorrespondingDom( viewText ) ).to.equal( domText );
  338. } );
  339. it( 'should return corresponding DOM document fragment', () => {
  340. const domFragment = document.createDocumentFragment();
  341. const viewFragment = new ViewDocumentFragment();
  342. converter.bindElements( domFragment, viewFragment );
  343. expect( converter.getCorrespondingDom( viewFragment ) ).to.equal( domFragment );
  344. } );
  345. } );
  346. describe( 'getCorrespondingDomElement', () => {
  347. it( 'should return corresponding DOM element', () => {
  348. const domElement = document.createElement( 'p' );
  349. const viewElement = new ViewElement( 'p' );
  350. converter.bindElements( domElement, viewElement );
  351. expect( converter.getCorrespondingDomElement( viewElement ) ).to.equal( domElement );
  352. } );
  353. } );
  354. describe( 'getCorrespondingDomDocumentFragment', () => {
  355. it( 'should return corresponding DOM document fragment', () => {
  356. const domFragment = document.createDocumentFragment();
  357. const viewFragment = new ViewDocumentFragment();
  358. converter.bindElements( domFragment, viewFragment );
  359. expect( converter.getCorrespondingDomDocumentFragment( viewFragment ) ).to.equal( domFragment );
  360. } );
  361. } );
  362. describe( 'getCorrespondingDomText', () => {
  363. it( 'should return corresponding DOM text based on sibling', () => {
  364. const domImg = document.createElement( 'img' );
  365. const domText = document.createTextNode( 'foo' );
  366. const domP = document.createElement( 'p' );
  367. domP.appendChild( domImg );
  368. domP.appendChild( domText );
  369. const viewImg = new ViewElement( 'img' );
  370. converter.bindElements( domImg, viewImg );
  371. const viewP = converter.domToView( domP );
  372. const viewText = viewP.getChild( 1 );
  373. expect( converter.getCorrespondingDomText( viewText ) ).to.equal( domText );
  374. } );
  375. it( 'should return corresponding DOM text based on parent', () => {
  376. const domText = document.createTextNode( 'foo' );
  377. const domP = document.createElement( 'p' );
  378. domP.appendChild( domText );
  379. const viewP = converter.domToView( domP );
  380. const viewText = viewP.getChild( 0 );
  381. converter.bindElements( domP, viewP );
  382. expect( converter.getCorrespondingDomText( viewText ) ).to.equal( domText );
  383. } );
  384. it( 'should return null if sibling is not bound', () => {
  385. const domImg = document.createElement( 'img' );
  386. const domText = document.createTextNode( 'foo' );
  387. const domP = document.createElement( 'p' );
  388. domP.appendChild( domImg );
  389. domP.appendChild( domText );
  390. const viewP = converter.domToView( domP );
  391. const viewText = viewP.getChild( 1 );
  392. converter.bindElements( domP, viewP );
  393. expect( converter.getCorrespondingDomText( viewText ) ).to.be.null;
  394. } );
  395. it( 'should return null if parent is not bound', () => {
  396. const domText = document.createTextNode( 'foo' );
  397. const domP = document.createElement( 'p' );
  398. domP.appendChild( domText );
  399. const viewP = converter.domToView( domP );
  400. const viewText = viewP.getChild( 0 );
  401. expect( converter.getCorrespondingDomText( viewText ) ).to.be.null;
  402. } );
  403. } );
  404. } );