8
0

datacontroller.js 7.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205
  1. /**
  2. * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. 'use strict';
  6. import Mapper from './conversion/mapper.js';
  7. import ModelConversionDispatcher from './conversion/modelconversiondispatcher.js';
  8. import { insertText } from './conversion/model-to-view-converters.js';
  9. import ViewConversionDispatcher from './conversion/viewconversiondispatcher.js';
  10. import { convertText, convertToModelFragment } from './conversion/view-to-model-converters.js';
  11. import Writer from './view/writer.js';
  12. import ViewDocumentFragment from './view/documentfragment.js';
  13. import DomConverter from './view/domconverter.js';
  14. import { NBSP_FILLER } from './view/filler.js';
  15. import ModelRange from './model/range.js';
  16. import ModelPosition from './model/position.js';
  17. /**
  18. * Controller for the data pipeline. The data pipeline controls how data is retrieved from the document
  19. * and set inside it. Hence, the controller features two methods which allow to {@link engine.DataController#get get}
  20. * and {@link engine.DataController#set set} data of the {@link engine.DataController#model model}
  21. * using given:
  22. *
  23. * * {@link engine.dataProcessor.DataProcessor data processor},
  24. * * {@link engine.conversion.ModelConversionDispatcher model to view} and
  25. * {@link engine.conversion.ViewConversionDispatcher view to model} converters.
  26. *
  27. * @memberOf engine
  28. */
  29. export default class DataController {
  30. /**
  31. * Creates data controller instance.
  32. *
  33. * @param {engine.model.Document} model Document model.
  34. * @param {engine.dataProcessor.DataProcessor} [dataProcessor] Data processor which should used by the controller.
  35. */
  36. constructor( model, dataProcessor ) {
  37. /**
  38. * Document model.
  39. *
  40. * @readonly
  41. * @member {engine.model.document} engine.DataController#model
  42. */
  43. this.model = model;
  44. /**
  45. * Data processor used during the conversion.
  46. *
  47. * @readonly
  48. * @member {engine.dataProcessor.DataProcessor} engine.DataController#processor
  49. */
  50. this.processor = dataProcessor;
  51. /**
  52. * Mapper used for the conversion. It has no permanent bindings, because they are created when getting data and
  53. * cleared directly after data are converted. However, the mapper is defined as class property, because
  54. * it needs to be passed to the `ModelConversionDispatcher` as a conversion API.
  55. *
  56. * @private
  57. * @member {engine.conversion.Mapper} engine.DataController#_mapper
  58. */
  59. this._mapper = new Mapper();
  60. /**
  61. * Writer used during the conversion.
  62. *
  63. * @private
  64. * @member {engine.view.Writer} engine.DataController#_writer
  65. */
  66. this._writer = new Writer();
  67. /**
  68. * DOM converter used during the conversion.
  69. *
  70. * @private
  71. * @member {engine.view.DomConverter} engine.DataController#_domConverter
  72. */
  73. this._domConverter = new DomConverter( { blockFiller: NBSP_FILLER } );
  74. /**
  75. * Model to view conversion dispatcher used by the {@link engine.DataController#get get method}.
  76. * To attach model to view converter to the data pipeline you need to add lister to this property:
  77. *
  78. * data.modelToView( 'insert:$element', customInsertConverter );
  79. *
  80. * Or use {@link engine.conversion.ModelConverterBuilder}:
  81. *
  82. * BuildModelConverterFor( data.modelToView ).fromAttribute( 'bold' ).toElement( 'b' );
  83. *
  84. * @readonly
  85. * @member {engine.conversion.ModelConversionDispatcher} engine.DataController#modelToView
  86. */
  87. this.modelToView = new ModelConversionDispatcher( {
  88. writer: this._writer,
  89. mapper: this._mapper
  90. } );
  91. this.modelToView.on( 'insert:$text', insertText() );
  92. /**
  93. * View to model conversion dispatcher used by the {@link engine.DataController#set set method}.
  94. * To attach view to model converter to the data pipeline you need to add lister to this property:
  95. *
  96. * data.viewToModel( 'element', customElementConverter );
  97. *
  98. * Or use {@link engine.conversion.ViewConverterBuilder}:
  99. *
  100. * BuildViewConverterFor( data.viewToModel ).fromElement( 'b' ).toAttribute( 'bold', 'true' );
  101. *
  102. * @readonly
  103. * @member {engine.conversion.ViewConversionDispatcher} engine.DataController#viewToModel
  104. */
  105. this.viewToModel = new ViewConversionDispatcher( {
  106. schema: model.schema
  107. } );
  108. // Define default converters for text and elements.
  109. //
  110. // Note that if there is no default converter for the element it will be skipped, for instance `<b>foo</b>` will be
  111. // converted to nothing. We add `convertToModelFragment` as a last converter so it converts children of that
  112. // element to the document fragment so `<b>foo</b>` will be converted to `foo` if there is no converter for `<b>`.
  113. this.viewToModel.on( 'text', convertText() );
  114. this.viewToModel.on( 'element', convertToModelFragment(), null, 9999 );
  115. this.viewToModel.on( 'documentFragment', convertToModelFragment(), null, 9999 );
  116. }
  117. /**
  118. * Returns model's data converted by the {@link engine.DataController#modelToView model to view converters} and
  119. * formatted by the {@link engine.DataController#processor data processor}.
  120. *
  121. * @param {String} [rootName='main'] Root name.
  122. * @returns {String} Output data.
  123. */
  124. get( rootName = 'main' ) {
  125. // Get model range.
  126. const modelRoot = this.model.getRoot( rootName );
  127. const modelRange = ModelRange.createFromElement( modelRoot );
  128. // model -> view.
  129. const viewDocumentFragment = new ViewDocumentFragment();
  130. this._mapper.bindElements( modelRoot, viewDocumentFragment );
  131. this.modelToView.convertInsert( modelRange );
  132. this._mapper.clearBindings();
  133. // view -> DOM.
  134. const domDocumentFragment = this._domConverter.viewToDom( viewDocumentFragment, document );
  135. // DOM -> data.
  136. return this.processor.toData( domDocumentFragment );
  137. }
  138. /**
  139. * Sets input data parsed by the {@link engine.DataController#processor data processor} and
  140. * converted by the {@link engine.DataController#viewToModel view to model converters}.
  141. *
  142. * This method also creates a batch with all the changes applied. If all you need is to parse data use
  143. * the {@link engine.dataController#parse} method.
  144. *
  145. * @param {String} data Input data.
  146. * @param {String} [rootName='main'] Root name.
  147. */
  148. set( data, rootName = 'main' ) {
  149. // Save to model.
  150. const modelRoot = this.model.getRoot( rootName );
  151. this.model.enqueueChanges( () => {
  152. this.model.batch()
  153. .remove( ModelRange.createFromElement( modelRoot ) )
  154. .insert( ModelPosition.createAt( modelRoot, 0 ), this.parse( data ) );
  155. } );
  156. }
  157. /**
  158. * Returns data parsed by the {@link engine.DataController#processor data processor} and then
  159. * converted by the {@link engine.DataController#viewToModel view to model converters}.
  160. *
  161. * @see engine.DataController#set
  162. * @param {String} data Data to parse.
  163. * @returns {engine.model.DocumentFragment} Parsed data.
  164. */
  165. parse( data ) {
  166. // data -> DOM.
  167. const domDocumentFragment = this.processor.toDom( data );
  168. // DOM -> view.
  169. const viewDocumentFragment = this._domConverter.domToView( domDocumentFragment );
  170. // view -> model.
  171. const modelDocumentFragment = this.viewToModel.convert( viewDocumentFragment, { context: [ '$root' ] } );
  172. return modelDocumentFragment;
  173. }
  174. /**
  175. * Removes all event listeners set by the DataController.
  176. */
  177. destroy() {}
  178. }