binding.js 12 KB

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