domconverter.js 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561
  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( 'domToView', () => {
  36. it( 'should create tree of view elements from DOM elements', () => {
  37. const domImg = document.createElement( 'img' );
  38. const domText = document.createTextNode( 'foo' );
  39. const domP = document.createElement( 'p' );
  40. domP.setAttribute( 'class', 'foo' );
  41. domP.appendChild( domImg );
  42. domP.appendChild( domText );
  43. const viewImg = new ViewElement( 'img' );
  44. converter.bindElements( domImg, viewImg );
  45. const viewP = converter.domToView( domP );
  46. expect( viewP ).to.be.an.instanceof( ViewElement );
  47. expect( viewP.name ).to.equal( 'p' );
  48. expect( viewP.getAttribute( 'class' ) ).to.equal( 'foo' );
  49. expect( count( viewP.getAttributeKeys() ) ).to.equal( 1 );
  50. expect( viewP.getChildCount() ).to.equal( 2 );
  51. expect( viewP.getChild( 0 ).name ).to.equal( 'img' );
  52. expect( viewP.getChild( 1 ).data ).to.equal( 'foo' );
  53. expect( converter.getCorrespondingDom( viewP ) ).to.not.equal( domP );
  54. expect( converter.getCorrespondingDom( viewP.getChild( 0 ) ) ).to.equal( domImg );
  55. } );
  56. it( 'should create tree of view elements from DOM elements and bind elements', () => {
  57. const domImg = document.createElement( 'img' );
  58. const domText = document.createTextNode( 'foo' );
  59. const domP = document.createElement( 'p' );
  60. domP.setAttribute( 'class', 'foo' );
  61. domP.appendChild( domImg );
  62. domP.appendChild( domText );
  63. const viewP = converter.domToView( domP, { bind: true } );
  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.equal( domP );
  72. expect( converter.getCorrespondingDom( viewP.getChild( 0 ) ) ).to.equal( domP.childNodes[ 0 ] );
  73. } );
  74. it( 'should create tree of view elements from DOM element without children', () => {
  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 viewImg = new ViewElement( 'img' );
  82. converter.bindElements( domImg, viewImg );
  83. const viewP = converter.domToView( domP, { withChildren: false } );
  84. expect( viewP ).to.be.an.instanceof( ViewElement );
  85. expect( viewP.name ).to.equal( 'p' );
  86. expect( viewP.getAttribute( 'class' ) ).to.equal( 'foo' );
  87. expect( count( viewP.getAttributeKeys() ) ).to.equal( 1 );
  88. expect( viewP.getChildCount() ).to.equal( 0 );
  89. expect( converter.getCorrespondingDom( viewP ) ).to.not.equal( domP );
  90. } );
  91. it( 'should create view document fragment from DOM document fragment', () => {
  92. const domImg = document.createElement( 'img' );
  93. const domText = document.createTextNode( 'foo' );
  94. const domFragment = document.createDocumentFragment();
  95. domFragment.appendChild( domImg );
  96. domFragment.appendChild( domText );
  97. const viewFragment = converter.domToView( domFragment, { bind: true } );
  98. expect( viewFragment ).to.be.an.instanceof( ViewDocumentFragment );
  99. expect( viewFragment.getChildCount() ).to.equal( 2 );
  100. expect( viewFragment.getChild( 0 ).name ).to.equal( 'img' );
  101. expect( viewFragment.getChild( 1 ).data ).to.equal( 'foo' );
  102. expect( converter.getCorrespondingDom( viewFragment ) ).to.equal( domFragment );
  103. expect( converter.getCorrespondingDom( viewFragment.getChild( 0 ) ) ).to.equal( domFragment.childNodes[ 0 ] );
  104. } );
  105. it( 'should create view document fragment from DOM document fragment without children', () => {
  106. const domImg = document.createElement( 'img' );
  107. const domText = document.createTextNode( 'foo' );
  108. const domFragment = document.createDocumentFragment();
  109. domFragment.appendChild( domImg );
  110. domFragment.appendChild( domText );
  111. const viewImg = new ViewElement( 'img' );
  112. converter.bindElements( domImg, viewImg );
  113. const viewFragment = converter.domToView( domFragment, { withChildren: false } );
  114. expect( viewFragment ).to.be.an.instanceof( ViewDocumentFragment );
  115. expect( viewFragment.getChildCount() ).to.equal( 0 );
  116. expect( converter.getCorrespondingDom( viewFragment ) ).to.not.equal( domFragment );
  117. } );
  118. it( 'should return already bind document fragment', () => {
  119. const domFragment = document.createDocumentFragment();
  120. const viewFragment = new ViewDocumentFragment();
  121. converter.bindDocumentFragments( domFragment, viewFragment );
  122. const viewFragment2 = converter.domToView( domFragment );
  123. expect( viewFragment2 ).to.equal( viewFragment );
  124. } );
  125. } );
  126. describe( 'viewToDom', () => {
  127. it( 'should create tree of DOM elements from view elements', () => {
  128. const viewImg = new ViewElement( 'img' );
  129. const viewText = new ViewText( 'foo' );
  130. const viewP = new ViewElement( 'p' );
  131. viewP.setAttribute( 'class', 'foo' );
  132. viewP.appendChildren( viewImg );
  133. viewP.appendChildren( viewText );
  134. const domImg = document.createElement( 'img' );
  135. converter.bindElements( domImg, viewImg );
  136. const domP = converter.viewToDom( viewP, document );
  137. expect( domP ).to.be.an.instanceof( HTMLElement );
  138. expect( domP.tagName ).to.equal( 'P' );
  139. expect( domP.getAttribute( 'class' ) ).to.equal( 'foo' );
  140. expect( domP.attributes.length ).to.equal( 1 );
  141. expect( domP.childNodes.length ).to.equal( 2 );
  142. expect( domP.childNodes[ 0 ].tagName ).to.equal( 'IMG' );
  143. expect( domP.childNodes[ 1 ].data ).to.equal( 'foo' );
  144. expect( converter.getCorrespondingView( domP ) ).not.to.equal( viewP );
  145. expect( converter.getCorrespondingView( domP.childNodes[ 0 ] ) ).to.equal( viewImg );
  146. } );
  147. it( 'should create tree of DOM elements from view elements and bind elements', () => {
  148. const viewImg = new ViewElement( 'img' );
  149. const viewText = new ViewText( 'foo' );
  150. const viewP = new ViewElement( 'p' );
  151. viewP.setAttribute( 'class', 'foo' );
  152. viewP.appendChildren( viewImg );
  153. viewP.appendChildren( viewText );
  154. const domP = converter.viewToDom( viewP, document, { bind: true } );
  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 ) ).to.equal( viewP );
  163. expect( converter.getCorrespondingView( domP.childNodes[ 0 ] ) ).to.equal( viewP.getChild( 0 ) );
  164. } );
  165. it( 'should create tree of DOM elements from view element without children', () => {
  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 domImg = document.createElement( 'img' );
  173. converter.bindElements( domImg, viewImg );
  174. const domP = converter.viewToDom( viewP, document, { withChildren: false } );
  175. expect( domP ).to.be.an.instanceof( HTMLElement );
  176. expect( domP.tagName ).to.equal( 'P' );
  177. expect( domP.getAttribute( 'class' ) ).to.equal( 'foo' );
  178. expect( domP.attributes.length ).to.equal( 1 );
  179. expect( domP.childNodes.length ).to.equal( 0 );
  180. expect( converter.getCorrespondingView( domP ) ).not.to.equal( viewP );
  181. } );
  182. it( 'should create DOM document fragment from view document fragment and bind elements', () => {
  183. const viewImg = new ViewElement( 'img' );
  184. const viewText = new ViewText( 'foo' );
  185. const viewFragment = new ViewDocumentFragment();
  186. viewFragment.appendChildren( viewImg );
  187. viewFragment.appendChildren( viewText );
  188. const domFragment = converter.viewToDom( viewFragment, document, { bind: true } );
  189. expect( domFragment ).to.be.an.instanceof( DocumentFragment );
  190. expect( domFragment.childNodes.length ).to.equal( 2 );
  191. expect( domFragment.childNodes[ 0 ].tagName ).to.equal( 'IMG' );
  192. expect( domFragment.childNodes[ 1 ].data ).to.equal( 'foo' );
  193. expect( converter.getCorrespondingView( domFragment ) ).to.equal( viewFragment );
  194. expect( converter.getCorrespondingView( domFragment.childNodes[ 0 ] ) ).to.equal( viewFragment.getChild( 0 ) );
  195. } );
  196. it( 'should create DOM document fragment from view document without children', () => {
  197. const viewImg = new ViewElement( 'img' );
  198. const viewText = new ViewText( 'foo' );
  199. const viewFragment = new ViewDocumentFragment();
  200. viewFragment.appendChildren( viewImg );
  201. viewFragment.appendChildren( viewText );
  202. const domImg = document.createElement( 'img' );
  203. converter.bindElements( domImg, viewImg );
  204. const domFragment = converter.viewToDom( viewFragment, document, { withChildren: false } );
  205. expect( domFragment ).to.be.an.instanceof( DocumentFragment );
  206. expect( domFragment.childNodes.length ).to.equal( 0 );
  207. expect( converter.getCorrespondingView( domFragment ) ).not.to.equal( viewFragment );
  208. } );
  209. it( 'should return already bind document fragment', () => {
  210. const domFragment = document.createDocumentFragment();
  211. const viewFragment = new ViewDocumentFragment();
  212. converter.bindDocumentFragments( domFragment, viewFragment );
  213. const domFragment2 = converter.viewToDom( viewFragment );
  214. expect( domFragment2 ).to.equal( domFragment );
  215. } );
  216. } );
  217. describe( 'getCorrespondingView', () => {
  218. it( 'should return corresponding view element if element is passed', () => {
  219. const domElement = document.createElement( 'p' );
  220. const viewElement = new ViewElement( 'p' );
  221. converter.bindElements( domElement, viewElement );
  222. expect( converter.getCorrespondingView( domElement ) ).to.equal( viewElement );
  223. } );
  224. it( 'should return corresponding view text if text is passed', () => {
  225. const domText = document.createTextNode( 'foo' );
  226. const domP = document.createElement( 'p' );
  227. domP.appendChild( domText );
  228. const viewP = converter.domToView( domP );
  229. const viewText = viewP.getChild( 0 );
  230. converter.bindElements( domP, viewP );
  231. expect( converter.getCorrespondingView( domText ) ).to.equal( viewText );
  232. } );
  233. it( 'should return corresponding view document fragment', () => {
  234. const domFragment = document.createDocumentFragment();
  235. const viewFragment = converter.domToView( domFragment );
  236. converter.bindElements( domFragment, viewFragment );
  237. expect( converter.getCorrespondingView( domFragment ) ).to.equal( viewFragment );
  238. } );
  239. } );
  240. describe( 'getCorrespondingViewElement', () => {
  241. it( 'should return corresponding view element', () => {
  242. const domElement = document.createElement( 'p' );
  243. const viewElement = new ViewElement( 'p' );
  244. converter.bindElements( domElement, viewElement );
  245. expect( converter.getCorrespondingViewElement( domElement ) ).to.equal( viewElement );
  246. } );
  247. } );
  248. describe( 'getCorrespondingViewDocumentFragment', () => {
  249. it( 'should return corresponding view document fragment', () => {
  250. const domFragment = document.createDocumentFragment();
  251. const viewFragment = converter.domToView( domFragment );
  252. converter.bindElements( domFragment, viewFragment );
  253. expect( converter.getCorrespondingViewDocumentFragment( domFragment ) ).to.equal( viewFragment );
  254. } );
  255. } );
  256. describe( 'getCorrespondingViewText', () => {
  257. it( 'should return corresponding view text based on sibling', () => {
  258. const domImg = document.createElement( 'img' );
  259. const domText = document.createTextNode( 'foo' );
  260. const domP = document.createElement( 'p' );
  261. domP.appendChild( domImg );
  262. domP.appendChild( domText );
  263. const viewImg = new ViewElement( 'img' );
  264. converter.bindElements( domImg, viewImg );
  265. const viewP = converter.domToView( domP );
  266. const viewText = viewP.getChild( 1 );
  267. expect( converter.getCorrespondingViewText( domText ) ).to.equal( viewText );
  268. } );
  269. it( 'should return corresponding view text based on parent', () => {
  270. const domText = document.createTextNode( 'foo' );
  271. const domP = document.createElement( 'p' );
  272. domP.appendChild( domText );
  273. const viewP = converter.domToView( domP );
  274. const viewText = viewP.getChild( 0 );
  275. converter.bindElements( domP, viewP );
  276. expect( converter.getCorrespondingViewText( domText ) ).to.equal( viewText );
  277. } );
  278. it( 'should return null if sibling is not bound', () => {
  279. const domImg = document.createElement( 'img' );
  280. const domText = document.createTextNode( 'foo' );
  281. const domP = document.createElement( 'p' );
  282. domP.appendChild( domImg );
  283. domP.appendChild( domText );
  284. const viewP = converter.domToView( domP );
  285. converter.bindElements( domP, viewP );
  286. expect( converter.getCorrespondingViewText( domText ) ).to.be.null;
  287. } );
  288. it( 'should return null if sibling is not element', () => {
  289. const domTextFoo = document.createTextNode( 'foo' );
  290. const domTextBar = document.createTextNode( 'bar' );
  291. const domP = document.createElement( 'p' );
  292. domP.appendChild( domTextFoo );
  293. domP.appendChild( domTextBar );
  294. const viewP = converter.domToView( domP );
  295. converter.bindElements( domP, viewP );
  296. expect( converter.getCorrespondingViewText( domTextBar ) ).to.be.null;
  297. } );
  298. it( 'should return null if parent is not bound', () => {
  299. const domText = document.createTextNode( 'foo' );
  300. const domP = document.createElement( 'p' );
  301. domP.appendChild( domText );
  302. expect( converter.getCorrespondingViewText( domText ) ).to.be.null;
  303. } );
  304. } );
  305. describe( 'getCorrespondingDom', () => {
  306. it( 'should return corresponding DOM element if element was passed', () => {
  307. const domElement = document.createElement( 'p' );
  308. const viewElement = new ViewElement( 'p' );
  309. converter.bindElements( domElement, viewElement );
  310. expect( converter.getCorrespondingDom( viewElement ) ).to.equal( domElement );
  311. } );
  312. it( 'should return corresponding DOM text if text was passed', () => {
  313. const domText = document.createTextNode( 'foo' );
  314. const domP = document.createElement( 'p' );
  315. domP.appendChild( domText );
  316. const viewP = converter.domToView( domP );
  317. const viewText = viewP.getChild( 0 );
  318. converter.bindElements( domP, viewP );
  319. expect( converter.getCorrespondingDom( viewText ) ).to.equal( domText );
  320. } );
  321. it( 'should return corresponding DOM document fragment', () => {
  322. const domFragment = document.createDocumentFragment();
  323. const viewFragment = new ViewDocumentFragment();
  324. converter.bindElements( domFragment, viewFragment );
  325. expect( converter.getCorrespondingDom( viewFragment ) ).to.equal( domFragment );
  326. } );
  327. } );
  328. describe( 'getCorrespondingDomElement', () => {
  329. it( 'should return corresponding DOM element', () => {
  330. const domElement = document.createElement( 'p' );
  331. const viewElement = new ViewElement( 'p' );
  332. converter.bindElements( domElement, viewElement );
  333. expect( converter.getCorrespondingDomElement( viewElement ) ).to.equal( domElement );
  334. } );
  335. } );
  336. describe( 'getCorrespondingDomDocumentFragment', () => {
  337. it( 'should return corresponding DOM document fragment', () => {
  338. const domFragment = document.createDocumentFragment();
  339. const viewFragment = new ViewDocumentFragment();
  340. converter.bindElements( domFragment, viewFragment );
  341. expect( converter.getCorrespondingDomDocumentFragment( viewFragment ) ).to.equal( domFragment );
  342. } );
  343. } );
  344. describe( 'getCorrespondingDomText', () => {
  345. it( 'should return corresponding DOM text based on sibling', () => {
  346. const domImg = document.createElement( 'img' );
  347. const domText = document.createTextNode( 'foo' );
  348. const domP = document.createElement( 'p' );
  349. domP.appendChild( domImg );
  350. domP.appendChild( domText );
  351. const viewImg = new ViewElement( 'img' );
  352. converter.bindElements( domImg, viewImg );
  353. const viewP = converter.domToView( domP );
  354. const viewText = viewP.getChild( 1 );
  355. expect( converter.getCorrespondingDomText( viewText ) ).to.equal( domText );
  356. } );
  357. it( 'should return corresponding DOM text based on parent', () => {
  358. const domText = document.createTextNode( 'foo' );
  359. const domP = document.createElement( 'p' );
  360. domP.appendChild( domText );
  361. const viewP = converter.domToView( domP );
  362. const viewText = viewP.getChild( 0 );
  363. converter.bindElements( domP, viewP );
  364. expect( converter.getCorrespondingDomText( viewText ) ).to.equal( domText );
  365. } );
  366. it( 'should return null if sibling is not bound', () => {
  367. const domImg = document.createElement( 'img' );
  368. const domText = document.createTextNode( 'foo' );
  369. const domP = document.createElement( 'p' );
  370. domP.appendChild( domImg );
  371. domP.appendChild( domText );
  372. const viewP = converter.domToView( domP );
  373. const viewText = viewP.getChild( 1 );
  374. converter.bindElements( domP, viewP );
  375. expect( converter.getCorrespondingDomText( viewText ) ).to.be.null;
  376. } );
  377. it( 'should return null if parent is not bound', () => {
  378. const domText = document.createTextNode( 'foo' );
  379. const domP = document.createElement( 'p' );
  380. domP.appendChild( domText );
  381. const viewP = converter.domToView( domP );
  382. const viewText = viewP.getChild( 0 );
  383. expect( converter.getCorrespondingDomText( viewText ) ).to.be.null;
  384. } );
  385. } );
  386. } );