8
0

binding.js 12 KB

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