domconverter.js 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433
  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 utils from '/ckeditor5/utils/utils.js';
  8. import ViewElement from '/ckeditor5/core/treeview/element.js';
  9. import ViewText from '/ckeditor5/core/treeview/text.js';
  10. import DomConverter from '/ckeditor5/core/treeview/domconverter.js';
  11. describe( 'DomConverter', () => {
  12. let converter;
  13. before( () => {
  14. converter = new DomConverter();
  15. } );
  16. describe( 'bindElements', () => {
  17. it( 'should bind elements', () => {
  18. const domElement = document.createElement( 'p' );
  19. const viewElement = new ViewElement( 'p' );
  20. converter.bindElements( domElement, viewElement );
  21. expect( converter.getCorrespondingView( domElement ) ).to.equal( viewElement );
  22. expect( converter.getCorrespondingDom( viewElement ) ).to.equal( domElement );
  23. } );
  24. } );
  25. describe( 'compareNodes', () => {
  26. it( 'should return false for nodes not matching types', () => {
  27. const domElement = document.createElement( 'p' );
  28. const viewText = new ViewText( 'foo' );
  29. expect( converter.compareNodes( domElement, viewText ) ).to.be.false;
  30. } );
  31. it( 'should return true for bound elements', () => {
  32. const domElement = document.createElement( 'p' );
  33. const viewElement = new ViewElement( 'p' );
  34. converter.bindElements( domElement, viewElement );
  35. expect( converter.compareNodes( domElement, viewElement ) ).to.be.true;
  36. } );
  37. it( 'should return true for the same texts', () => {
  38. const domText = document.createTextNode( 'foo' );
  39. const viewText = new ViewText( 'foo' );
  40. expect( converter.compareNodes( domText, viewText ) ).to.be.true;
  41. } );
  42. } );
  43. describe( 'domToView', () => {
  44. it( 'should create tree of view elements from DOM elements', () => {
  45. const domImg = document.createElement( 'img' );
  46. const domText = document.createTextNode( 'foo' );
  47. const domP = document.createElement( 'p' );
  48. domP.setAttribute( 'class', 'foo' );
  49. domP.appendChild( domImg );
  50. domP.appendChild( domText );
  51. const viewImg = new ViewElement( 'img' );
  52. converter.bindElements( domImg, viewImg );
  53. const viewP = converter.domToView( domP );
  54. expect( viewP ).to.be.an.instanceof( ViewElement );
  55. expect( viewP.name ).to.equal( 'p' );
  56. expect( viewP.getAttribute( 'class' ) ).to.equal( 'foo' );
  57. expect( utils.count( viewP.getAttributeKeys() ) ).to.equal( 1 );
  58. expect( viewP.getChildCount() ).to.equal( 2 );
  59. expect( viewP.getChild( 0 ).name ).to.equal( 'img' );
  60. expect( viewP.getChild( 1 ).data ).to.equal( 'foo' );
  61. expect( converter.getCorrespondingDom( viewP ) ).to.not.equal( domP );
  62. expect( converter.getCorrespondingDom( viewP.getChild( 0 ) ) ).to.equal( domImg );
  63. } );
  64. it( 'should create tree of view elements from DOM elements and bind elements', () => {
  65. const domImg = document.createElement( 'img' );
  66. const domText = document.createTextNode( 'foo' );
  67. const domP = document.createElement( 'p' );
  68. domP.setAttribute( 'class', 'foo' );
  69. domP.appendChild( domImg );
  70. domP.appendChild( domText );
  71. const viewP = converter.domToView( domP, { bind: true } );
  72. expect( viewP ).to.be.an.instanceof( ViewElement );
  73. expect( viewP.name ).to.equal( 'p' );
  74. expect( viewP.getAttribute( 'class' ) ).to.equal( 'foo' );
  75. expect( utils.count( viewP.getAttributeKeys() ) ).to.equal( 1 );
  76. expect( viewP.getChildCount() ).to.equal( 2 );
  77. expect( viewP.getChild( 0 ).name ).to.equal( 'img' );
  78. expect( viewP.getChild( 1 ).data ).to.equal( 'foo' );
  79. expect( converter.getCorrespondingDom( viewP ) ).to.equal( domP );
  80. expect( converter.getCorrespondingDom( viewP.getChild( 0 ) ) ).to.equal( domP.childNodes[ 0 ] );
  81. } );
  82. it( 'should create tree of view elements from DOM element without children', () => {
  83. const domImg = document.createElement( 'img' );
  84. const domText = document.createTextNode( 'foo' );
  85. const domP = document.createElement( 'p' );
  86. domP.setAttribute( 'class', 'foo' );
  87. domP.appendChild( domImg );
  88. domP.appendChild( domText );
  89. const viewImg = new ViewElement( 'img' );
  90. converter.bindElements( domImg, viewImg );
  91. const viewP = converter.domToView( domP, { withChildren: false } );
  92. expect( viewP ).to.be.an.instanceof( ViewElement );
  93. expect( viewP.name ).to.equal( 'p' );
  94. expect( viewP.getAttribute( 'class' ) ).to.equal( 'foo' );
  95. expect( utils.count( viewP.getAttributeKeys() ) ).to.equal( 1 );
  96. expect( viewP.getChildCount() ).to.equal( 0 );
  97. expect( converter.getCorrespondingDom( viewP ) ).to.not.equal( domP );
  98. } );
  99. } );
  100. describe( 'viewToDom', () => {
  101. it( 'should create tree of DOM elements from view elements', () => {
  102. const viewImg = new ViewElement( 'img' );
  103. const viewText = new ViewText( 'foo' );
  104. const viewP = new ViewElement( 'p' );
  105. viewP.setAttribute( 'class', 'foo' );
  106. viewP.appendChildren( viewImg );
  107. viewP.appendChildren( viewText );
  108. const domImg = document.createElement( 'img' );
  109. converter.bindElements( domImg, viewImg );
  110. const domP = converter.viewToDom( viewP, document );
  111. expect( domP ).to.be.an.instanceof( HTMLElement );
  112. expect( domP.tagName ).to.equal( 'P' );
  113. expect( domP.getAttribute( 'class' ) ).to.equal( 'foo' );
  114. expect( domP.attributes.length ).to.equal( 1 );
  115. expect( domP.childNodes.length ).to.equal( 2 );
  116. expect( domP.childNodes[ 0 ].tagName ).to.equal( 'IMG' );
  117. expect( domP.childNodes[ 1 ].data ).to.equal( 'foo' );
  118. expect( converter.getCorrespondingView( domP ) ).not.to.equal( viewP );
  119. expect( converter.getCorrespondingView( domP.childNodes[ 0 ] ) ).to.equal( viewImg );
  120. } );
  121. it( 'should create tree of DOM elements from view elements and bind elements', () => {
  122. const viewImg = new ViewElement( 'img' );
  123. const viewText = new ViewText( 'foo' );
  124. const viewP = new ViewElement( 'p' );
  125. viewP.setAttribute( 'class', 'foo' );
  126. viewP.appendChildren( viewImg );
  127. viewP.appendChildren( viewText );
  128. const domP = converter.viewToDom( viewP, document, { bind: true } );
  129. expect( domP ).to.be.an.instanceof( HTMLElement );
  130. expect( domP.tagName ).to.equal( 'P' );
  131. expect( domP.getAttribute( 'class' ) ).to.equal( 'foo' );
  132. expect( domP.attributes.length ).to.equal( 1 );
  133. expect( domP.childNodes.length ).to.equal( 2 );
  134. expect( domP.childNodes[ 0 ].tagName ).to.equal( 'IMG' );
  135. expect( domP.childNodes[ 1 ].data ).to.equal( 'foo' );
  136. expect( converter.getCorrespondingView( domP ) ).to.equal( viewP );
  137. expect( converter.getCorrespondingView( domP.childNodes[ 0 ] ) ).to.equal( viewP.getChild( 0 ) );
  138. } );
  139. it( 'should create tree of DOM elements from view element without children', () => {
  140. const viewImg = new ViewElement( 'img' );
  141. const viewText = new ViewText( 'foo' );
  142. const viewP = new ViewElement( 'p' );
  143. viewP.setAttribute( 'class', 'foo' );
  144. viewP.appendChildren( viewImg );
  145. viewP.appendChildren( viewText );
  146. const domImg = document.createElement( 'img' );
  147. converter.bindElements( domImg, viewImg );
  148. const domP = converter.viewToDom( viewP, document, { withChildren: false } );
  149. expect( domP ).to.be.an.instanceof( HTMLElement );
  150. expect( domP.tagName ).to.equal( 'P' );
  151. expect( domP.getAttribute( 'class' ) ).to.equal( 'foo' );
  152. expect( domP.attributes.length ).to.equal( 1 );
  153. expect( domP.childNodes.length ).to.equal( 0 );
  154. expect( converter.getCorrespondingView( domP ) ).not.to.equal( viewP );
  155. } );
  156. } );
  157. describe( 'getCorrespondingView', () => {
  158. it( 'should return corresponding view element if element is passed', () => {
  159. const domElement = document.createElement( 'p' );
  160. const viewElement = new ViewElement( 'p' );
  161. converter.bindElements( domElement, viewElement );
  162. expect( converter.getCorrespondingView( domElement ) ).to.equal( viewElement );
  163. } );
  164. it( 'should return corresponding view text if text is passed', () => {
  165. const domText = document.createTextNode( 'foo' );
  166. const domP = document.createElement( 'p' );
  167. domP.appendChild( domText );
  168. const viewP = converter.domToView( domP );
  169. const viewText = viewP.getChild( 0 );
  170. converter.bindElements( domP, viewP );
  171. expect( converter.getCorrespondingView( domText ) ).to.equal( viewText );
  172. } );
  173. } );
  174. describe( 'getCorrespondingViewElement', () => {
  175. it( 'should return corresponding view element', () => {
  176. const domElement = document.createElement( 'p' );
  177. const viewElement = new ViewElement( 'p' );
  178. converter.bindElements( domElement, viewElement );
  179. expect( converter.getCorrespondingViewElement( domElement ) ).to.equal( viewElement );
  180. } );
  181. } );
  182. describe( 'getCorrespondingViewText', () => {
  183. it( 'should return corresponding view text based on sibling', () => {
  184. const domImg = document.createElement( 'img' );
  185. const domText = document.createTextNode( 'foo' );
  186. const domP = document.createElement( 'p' );
  187. domP.appendChild( domImg );
  188. domP.appendChild( domText );
  189. const viewImg = new ViewElement( 'img' );
  190. converter.bindElements( domImg, viewImg );
  191. const viewP = converter.domToView( domP );
  192. const viewText = viewP.getChild( 1 );
  193. expect( converter.getCorrespondingViewText( domText ) ).to.equal( viewText );
  194. } );
  195. it( 'should return corresponding view text based on parent', () => {
  196. const domText = document.createTextNode( 'foo' );
  197. const domP = document.createElement( 'p' );
  198. domP.appendChild( domText );
  199. const viewP = converter.domToView( domP );
  200. const viewText = viewP.getChild( 0 );
  201. converter.bindElements( domP, viewP );
  202. expect( converter.getCorrespondingViewText( domText ) ).to.equal( viewText );
  203. } );
  204. it( 'should return null if sibling is not bound', () => {
  205. const domImg = document.createElement( 'img' );
  206. const domText = document.createTextNode( 'foo' );
  207. const domP = document.createElement( 'p' );
  208. domP.appendChild( domImg );
  209. domP.appendChild( domText );
  210. const viewP = converter.domToView( domP );
  211. converter.bindElements( domP, viewP );
  212. expect( converter.getCorrespondingViewText( domText ) ).to.be.null;
  213. } );
  214. it( 'should return null if sibling is not element', () => {
  215. const domTextFoo = document.createTextNode( 'foo' );
  216. const domTextBar = document.createTextNode( 'bar' );
  217. const domP = document.createElement( 'p' );
  218. domP.appendChild( domTextFoo );
  219. domP.appendChild( domTextBar );
  220. const viewP = converter.domToView( domP );
  221. converter.bindElements( domP, viewP );
  222. expect( converter.getCorrespondingViewText( domTextBar ) ).to.be.null;
  223. } );
  224. it( 'should return null if parent is not bound', () => {
  225. const domText = document.createTextNode( 'foo' );
  226. const domP = document.createElement( 'p' );
  227. domP.appendChild( domText );
  228. expect( converter.getCorrespondingViewText( domText ) ).to.be.null;
  229. } );
  230. } );
  231. describe( 'getCorrespondingDom', () => {
  232. it( 'should return corresponding DOM element if element was passed', () => {
  233. const domElement = document.createElement( 'p' );
  234. const viewElement = new ViewElement( 'p' );
  235. converter.bindElements( domElement, viewElement );
  236. expect( converter.getCorrespondingDom( viewElement ) ).to.equal( domElement );
  237. } );
  238. it( 'should return corresponding DOM text if text was passed', () => {
  239. const domText = document.createTextNode( 'foo' );
  240. const domP = document.createElement( 'p' );
  241. domP.appendChild( domText );
  242. const viewP = converter.domToView( domP );
  243. const viewText = viewP.getChild( 0 );
  244. converter.bindElements( domP, viewP );
  245. expect( converter.getCorrespondingDom( viewText ) ).to.equal( domText );
  246. } );
  247. } );
  248. describe( 'getCorrespondingDomElement', () => {
  249. it( 'should return corresponding DOM element', () => {
  250. const domElement = document.createElement( 'p' );
  251. const viewElement = new ViewElement( 'p' );
  252. converter.bindElements( domElement, viewElement );
  253. expect( converter.getCorrespondingDomElement( viewElement ) ).to.equal( domElement );
  254. } );
  255. } );
  256. describe( 'getCorrespondingDomText', () => {
  257. it( 'should return corresponding DOM 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.getCorrespondingDomText( viewText ) ).to.equal( domText );
  268. } );
  269. it( 'should return corresponding DOM 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.getCorrespondingDomText( viewText ) ).to.equal( domText );
  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. const viewText = viewP.getChild( 1 );
  286. converter.bindElements( domP, viewP );
  287. expect( converter.getCorrespondingDomText( viewText ) ).to.be.null;
  288. } );
  289. it( 'should return null if parent is not bound', () => {
  290. const domText = document.createTextNode( 'foo' );
  291. const domP = document.createElement( 'p' );
  292. domP.appendChild( domText );
  293. const viewP = converter.domToView( domP );
  294. const viewText = viewP.getChild( 0 );
  295. expect( converter.getCorrespondingDomText( viewText ) ).to.be.null;
  296. } );
  297. } );
  298. } );