binding.js 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382
  1. /**
  2. * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /* globals document */
  6. import ViewElement from '../../../src/view/element';
  7. import ViewSelection from '../../../src/view/selection';
  8. import ViewRange from '../../../src/view/range';
  9. import DomConverter from '../../../src/view/domconverter';
  10. import ViewDocumentFragment from '../../../src/view/documentfragment';
  11. import { INLINE_FILLER } from '../../../src/view/filler';
  12. import { parse } from '../../../src/dev-utils/view';
  13. import createElement from '@ckeditor/ckeditor5-utils/src/dom/createelement';
  14. describe( 'DomConverter', () => {
  15. let converter;
  16. before( () => {
  17. converter = new DomConverter();
  18. } );
  19. describe( 'bindElements()', () => {
  20. it( 'should bind elements', () => {
  21. const domElement = document.createElement( 'p' );
  22. const viewElement = new ViewElement( 'p' );
  23. converter.bindElements( domElement, viewElement );
  24. expect( converter.getCorrespondingView( domElement ) ).to.equal( viewElement );
  25. expect( converter.mapViewToDom( viewElement ) ).to.equal( domElement );
  26. } );
  27. } );
  28. describe( 'bindDocumentFragments()', () => {
  29. it( 'should bind document fragments', () => {
  30. const domFragment = document.createDocumentFragment();
  31. const viewFragment = new ViewDocumentFragment();
  32. converter.bindDocumentFragments( domFragment, viewFragment );
  33. expect( converter.getCorrespondingView( domFragment ) ).to.equal( viewFragment );
  34. expect( converter.mapViewToDom( viewFragment ) ).to.equal( domFragment );
  35. } );
  36. } );
  37. describe( 'getCorrespondingView()', () => {
  38. it( 'should return corresponding view element if element is passed', () => {
  39. const domElement = document.createElement( 'p' );
  40. const viewElement = new ViewElement( 'p' );
  41. converter.bindElements( domElement, viewElement );
  42. expect( converter.getCorrespondingView( domElement ) ).to.equal( viewElement );
  43. } );
  44. it( 'should return corresponding view text if text is passed', () => {
  45. const domText = document.createTextNode( 'foo' );
  46. const domP = document.createElement( 'p' );
  47. domP.appendChild( domText );
  48. const viewP = converter.domToView( domP );
  49. const viewText = viewP.getChild( 0 );
  50. converter.bindElements( domP, viewP );
  51. expect( converter.getCorrespondingView( domText ) ).to.equal( viewText );
  52. } );
  53. it( 'should return corresponding view document fragment', () => {
  54. const domFragment = document.createDocumentFragment();
  55. const viewFragment = converter.domToView( domFragment );
  56. converter.bindElements( domFragment, viewFragment );
  57. expect( converter.getCorrespondingView( domFragment ) ).to.equal( viewFragment );
  58. } );
  59. it( 'should return null if falsy value was passed', () => {
  60. expect( converter.getCorrespondingView( null ) ).to.be.null;
  61. expect( converter.getCorrespondingView( undefined ) ).to.be.null;
  62. } );
  63. } );
  64. describe( 'getCorrespondingViewElement()', () => {
  65. it( 'should return corresponding view element', () => {
  66. const domElement = document.createElement( 'p' );
  67. const viewElement = new ViewElement( 'p' );
  68. converter.bindElements( domElement, viewElement );
  69. expect( converter.getCorrespondingViewElement( domElement ) ).to.equal( viewElement );
  70. } );
  71. } );
  72. describe( 'getCorrespondingViewDocumentFragment()', () => {
  73. it( 'should return corresponding view document fragment', () => {
  74. const domFragment = document.createDocumentFragment();
  75. const viewFragment = converter.domToView( domFragment );
  76. converter.bindElements( domFragment, viewFragment );
  77. expect( converter.getCorrespondingViewDocumentFragment( domFragment ) ).to.equal( viewFragment );
  78. } );
  79. } );
  80. describe( 'getCorrespondingViewText()', () => {
  81. it( 'should return corresponding view text based on sibling', () => {
  82. const domImg = document.createElement( 'img' );
  83. const domText = document.createTextNode( 'foo' );
  84. const domP = createElement( document, 'p', null, [ domImg, domText ] );
  85. const viewImg = new ViewElement( 'img' );
  86. converter.bindElements( domImg, viewImg );
  87. const viewP = converter.domToView( domP );
  88. const viewText = viewP.getChild( 1 );
  89. expect( converter.getCorrespondingViewText( domText ) ).to.equal( viewText );
  90. } );
  91. it( 'should return corresponding view text based on parent', () => {
  92. const domText = document.createTextNode( 'foo' );
  93. const domP = createElement( document, 'p', null, domText );
  94. const viewP = converter.domToView( domP );
  95. const viewText = viewP.getChild( 0 );
  96. converter.bindElements( domP, viewP );
  97. expect( converter.getCorrespondingViewText( domText ) ).to.equal( viewText );
  98. } );
  99. it( 'should return null if sibling is not bound', () => {
  100. const domImg = document.createElement( 'img' );
  101. const domText = document.createTextNode( 'foo' );
  102. const domP = createElement( document, 'p', null, [ domImg, domText ] );
  103. const viewP = converter.domToView( domP );
  104. converter.bindElements( domP, viewP );
  105. expect( converter.getCorrespondingViewText( domText ) ).to.be.null;
  106. } );
  107. it( 'should return null if sibling is not element', () => {
  108. const domTextFoo = document.createTextNode( 'foo' );
  109. const domTextBar = document.createTextNode( 'bar' );
  110. const domP = createElement( document, 'p', null, [ domTextFoo, domTextBar ] );
  111. const viewP = converter.domToView( domP );
  112. converter.bindElements( domP, viewP );
  113. expect( converter.getCorrespondingViewText( domTextBar ) ).to.be.null;
  114. } );
  115. it( 'should return null if parent is not bound', () => {
  116. const domText = document.createTextNode( 'foo' );
  117. createElement( document, 'p', null, domText );
  118. expect( converter.getCorrespondingViewText( domText ) ).to.be.null;
  119. } );
  120. it( 'should return null for inline filler', () => {
  121. const domFiller = document.createTextNode( INLINE_FILLER );
  122. const domP = createElement( document, 'p', null, domFiller );
  123. const viewP = converter.domToView( domP );
  124. converter.bindElements( domP, viewP );
  125. expect( converter.getCorrespondingViewText( domFiller ) ).to.be.null;
  126. } );
  127. it( 'should return null if there is no text node sibling in view', () => {
  128. const domB = document.createElement( 'b' );
  129. const domI = document.createElement( 'i' );
  130. const domText = document.createTextNode( 'x' );
  131. const domP = createElement( document, 'p', null, [ domB, domText, domI ] );
  132. const viewP = parse( '<p><b></b><i></i></p>' );
  133. const viewB = viewP.getChild( 0 );
  134. const viewI = viewP.getChild( 1 );
  135. converter.bindElements( domP, viewP );
  136. converter.bindElements( domI, viewI );
  137. converter.bindElements( domB, viewB );
  138. expect( converter.getCorrespondingViewText( domText ) ).to.be.null;
  139. } );
  140. it( 'should return null if there is no child text node in view', () => {
  141. const domText = document.createTextNode( 'x' );
  142. const domP = createElement( document, 'p', null, domText );
  143. const viewP = parse( '<p></p>' );
  144. converter.bindElements( domP, viewP );
  145. expect( converter.getCorrespondingViewText( domText ) ).to.be.null;
  146. } );
  147. } );
  148. describe( 'mapViewToDom()', () => {
  149. it( 'should return corresponding DOM element if element was passed', () => {
  150. const domElement = document.createElement( 'p' );
  151. const viewElement = new ViewElement( 'p' );
  152. converter.bindElements( domElement, viewElement );
  153. expect( converter.mapViewToDom( viewElement ) ).to.equal( domElement );
  154. } );
  155. it( 'should return corresponding DOM document fragment', () => {
  156. const domFragment = document.createDocumentFragment();
  157. const viewFragment = new ViewDocumentFragment();
  158. converter.bindElements( domFragment, viewFragment );
  159. expect( converter.mapViewToDom( viewFragment ) ).to.equal( domFragment );
  160. } );
  161. it( 'should return undefined if wrong parameter is passed', () => {
  162. expect( converter.mapViewToDom( null ) ).to.be.undefined;
  163. } );
  164. } );
  165. describe( 'findCorrespondingDomText()', () => {
  166. it( 'should return corresponding DOM text based on sibling', () => {
  167. const domImg = document.createElement( 'img' );
  168. const domText = document.createTextNode( 'foo' );
  169. const domP = document.createElement( 'p' );
  170. domP.appendChild( domImg );
  171. domP.appendChild( domText );
  172. const viewImg = new ViewElement( 'img' );
  173. converter.bindElements( domImg, viewImg );
  174. const viewP = converter.domToView( domP );
  175. const viewText = viewP.getChild( 1 );
  176. expect( converter.findCorrespondingDomText( viewText ) ).to.equal( domText );
  177. } );
  178. it( 'should return corresponding DOM text based on parent', () => {
  179. const domText = document.createTextNode( 'foo' );
  180. const domP = document.createElement( 'p' );
  181. domP.appendChild( domText );
  182. const viewP = converter.domToView( domP );
  183. const viewText = viewP.getChild( 0 );
  184. converter.bindElements( domP, viewP );
  185. expect( converter.findCorrespondingDomText( viewText ) ).to.equal( domText );
  186. } );
  187. it( 'should return null if sibling is not bound', () => {
  188. const domImg = document.createElement( 'img' );
  189. const domText = document.createTextNode( 'foo' );
  190. const domP = document.createElement( 'p' );
  191. domP.appendChild( domImg );
  192. domP.appendChild( domText );
  193. const viewP = converter.domToView( domP );
  194. const viewText = viewP.getChild( 1 );
  195. converter.bindElements( domP, viewP );
  196. expect( converter.findCorrespondingDomText( viewText ) ).to.be.null;
  197. } );
  198. it( 'should return null if parent is not bound', () => {
  199. const domText = document.createTextNode( 'foo' );
  200. const domP = document.createElement( 'p' );
  201. domP.appendChild( domText );
  202. const viewP = converter.domToView( domP );
  203. const viewText = viewP.getChild( 0 );
  204. expect( converter.findCorrespondingDomText( viewText ) ).to.be.null;
  205. } );
  206. it( 'should return null if there is no previous sibling and parent', () => {
  207. const domText = document.createTextNode( 'foo' );
  208. const viewText = converter.domToView( domText );
  209. expect( converter.findCorrespondingDomText( viewText ) ).to.be.null;
  210. } );
  211. } );
  212. describe( 'bindFakeSelection', () => {
  213. let domEl, selection, viewElement;
  214. beforeEach( () => {
  215. viewElement = new ViewElement();
  216. domEl = document.createElement( 'div' );
  217. selection = new ViewSelection();
  218. selection.addRange( ViewRange.createIn( viewElement ) );
  219. converter.bindFakeSelection( domEl, selection );
  220. } );
  221. it( 'should bind DOM element to selection', () => {
  222. const bindSelection = converter.fakeSelectionToView( domEl );
  223. expect( bindSelection ).to.be.defined;
  224. expect( bindSelection.isEqual( selection ) ).to.be.true;
  225. } );
  226. it( 'should keep a copy of selection', () => {
  227. const selectionCopy = ViewSelection.createFromSelection( selection );
  228. selection.addRange( ViewRange.createIn( new ViewElement() ), true );
  229. const bindSelection = converter.fakeSelectionToView( domEl );
  230. expect( bindSelection ).to.be.defined;
  231. expect( bindSelection ).to.not.equal( selection );
  232. expect( bindSelection.isEqual( selection ) ).to.be.false;
  233. expect( bindSelection.isEqual( selectionCopy ) ).to.be.true;
  234. } );
  235. } );
  236. describe( 'unbindDomElement', () => {
  237. it( 'should unbind elements', () => {
  238. const domElement = document.createElement( 'p' );
  239. const viewElement = new ViewElement( 'p' );
  240. converter.bindElements( domElement, viewElement );
  241. expect( converter.getCorrespondingView( domElement ) ).to.equal( viewElement );
  242. expect( converter.mapViewToDom( viewElement ) ).to.equal( domElement );
  243. converter.unbindDomElement( domElement );
  244. expect( converter.getCorrespondingView( domElement ) ).to.be.undefined;
  245. expect( converter.mapViewToDom( viewElement ) ).to.be.undefined;
  246. } );
  247. it( 'should unbind element\'s child nodes', () => {
  248. const domElement = document.createElement( 'p' );
  249. const domChild = document.createElement( 'span' );
  250. domElement.appendChild( domChild );
  251. const viewElement = new ViewElement( 'p' );
  252. const viewChild = new ViewElement( 'span' );
  253. converter.bindElements( domElement, viewElement );
  254. converter.bindElements( domChild, viewChild );
  255. expect( converter.getCorrespondingView( domChild ) ).to.equal( viewChild );
  256. expect( converter.mapViewToDom( viewChild ) ).to.equal( domChild );
  257. converter.unbindDomElement( domElement );
  258. expect( converter.getCorrespondingView( domChild ) ).to.be.undefined;
  259. expect( converter.mapViewToDom( viewChild ) ).to.be.undefined;
  260. } );
  261. it( 'should do nothing if there are no elements bind', () => {
  262. const domElement = document.createElement( 'p' );
  263. const viewElement = new ViewElement( 'p' );
  264. expect( converter.getCorrespondingView( domElement ) ).to.be.undefined;
  265. expect( converter.mapViewToDom( viewElement ) ).to.be.undefined;
  266. converter.unbindDomElement( domElement );
  267. expect( converter.getCorrespondingView( domElement ) ).to.be.undefined;
  268. expect( converter.mapViewToDom( viewElement ) ).to.be.undefined;
  269. } );
  270. } );
  271. } );