binding.js 12 KB

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