binding.js 11 KB

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