editingcontroller.js 6.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175
  1. /**
  2. * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
  3. * For licensing, see LICENSE.md.
  4. */
  5. /**
  6. * @module engine/controller/editingcontroller
  7. */
  8. import RootEditableElement from '../view/rooteditableelement';
  9. import ModelDiffer from '../model/differ';
  10. import View from '../view/view';
  11. import Mapper from '../conversion/mapper';
  12. import ModelConversionDispatcher from '../conversion/modelconversiondispatcher';
  13. import {
  14. insertText,
  15. remove
  16. } from '../conversion/model-to-view-converters';
  17. import { convertSelectionChange } from '../conversion/view-selection-to-model-converters';
  18. import {
  19. convertRangeSelection,
  20. convertCollapsedSelection,
  21. clearAttributes,
  22. clearFakeSelection
  23. } from '../conversion/model-selection-to-view-converters';
  24. import ObservableMixin from '@ckeditor/ckeditor5-utils/src/observablemixin';
  25. import mix from '@ckeditor/ckeditor5-utils/src/mix';
  26. /**
  27. * Controller for the editing pipeline. The editing pipeline controls {@link ~EditingController#model model} rendering,
  28. * including selection handling. It also creates {@link ~EditingController#view view document} which build a
  29. * browser-independent virtualization over the DOM elements. Editing controller also attach default converters.
  30. *
  31. * @mixes module:utils/observablemixin~ObservableMixin
  32. */
  33. export default class EditingController {
  34. /**
  35. * Creates editing controller instance.
  36. *
  37. * @param {module:engine/model/model~Model} model Editing model.
  38. */
  39. constructor( model ) {
  40. /**
  41. * Editing model.
  42. *
  43. * @readonly
  44. * @member {module:engine/model/model~Model}
  45. */
  46. this.model = model;
  47. /**
  48. * Editing view.
  49. *
  50. * @readonly
  51. * @member {module:engine/view/view~View}
  52. */
  53. this.view = new View();
  54. /**
  55. * Mapper which describes model-view binding.
  56. *
  57. * @readonly
  58. * @member {module:engine/conversion/mapper~Mapper}
  59. */
  60. this.mapper = new Mapper();
  61. /**
  62. * Model to view conversion dispatcher, which converts changes from the model to {@link #view the editing view}.
  63. *
  64. * To attach model-to-view converter to the editing pipeline you need to add a listener to this dispatcher:
  65. *
  66. * editing.modelToView( 'insert:$element', customInsertConverter );
  67. *
  68. * Or use {@link module:engine/conversion/buildmodelconverter~ModelConverterBuilder}:
  69. *
  70. * buildModelConverter().for( editing.modelToView ).fromAttribute( 'bold' ).toElement( 'b' );
  71. *
  72. * @readonly
  73. * @member {module:engine/conversion/modelconversiondispatcher~ModelConversionDispatcher} #modelToView
  74. */
  75. this.modelToView = new ModelConversionDispatcher( this.model, {
  76. mapper: this.mapper,
  77. viewSelection: this.view.document.selection
  78. } );
  79. // Model differ object. It's role is to buffer changes done on model and then calculates a diff of those changes.
  80. // The diff is then passed to model conversion dispatcher which generates proper events and kicks-off conversion.
  81. const modelDiffer = new ModelDiffer();
  82. // Before an operation is applied on model, buffer the change in differ.
  83. this.listenTo( this.model, 'applyOperation', ( evt, args ) => {
  84. const operation = args[ 0 ];
  85. if ( operation.isDocumentOperation ) {
  86. modelDiffer.bufferOperation( operation );
  87. }
  88. }, { priority: 'high' } );
  89. // Buffer marker changes.
  90. // This is not covered in buffering operations because markers may change outside of them (when they
  91. // are modified using `model.document.markers` collection, not through `MarkerOperation`).
  92. this.listenTo( this.model.markers, 'add', ( evt, marker ) => {
  93. // Whenever a new marker is added, buffer that change.
  94. modelDiffer.bufferMarkerChange( marker.name, null, marker.getRange() );
  95. // Whenever marker changes, buffer that.
  96. marker.on( 'change', ( evt, oldRange ) => {
  97. modelDiffer.bufferMarkerChange( marker.name, oldRange, marker.getRange() );
  98. } );
  99. } );
  100. this.listenTo( this.model.markers, 'remove', ( evt, marker ) => {
  101. // Whenever marker is removed, buffer that change.
  102. modelDiffer.bufferMarkerChange( marker.name, marker.getRange(), null );
  103. } );
  104. // When all changes are done, get the model diff containing all the changes and convert them to view and then render to DOM.
  105. this.listenTo( this.model, 'changesDone', () => {
  106. // Convert changes stored in `modelDiffer`.
  107. this.modelToView.convertChanges( modelDiffer );
  108. // Reset model diff object. When next operation is applied, new diff will be created.
  109. modelDiffer.reset();
  110. // After the view is ready, convert selection from model to view.
  111. this.modelToView.convertSelection( this.model.document.selection );
  112. // When everything is converted to the view, render it to DOM.
  113. this.view.render();
  114. }, { priority: 'low' } );
  115. // Convert selection from view to model.
  116. this.listenTo( this.view.document, 'selectionChange', convertSelectionChange( this.model, this.mapper ) );
  117. // Attach default model converters.
  118. this.modelToView.on( 'insert:$text', insertText(), { priority: 'lowest' } );
  119. this.modelToView.on( 'remove', remove(), { priority: 'low' } );
  120. // Attach default model selection converters.
  121. this.modelToView.on( 'selection', clearAttributes(), { priority: 'low' } );
  122. this.modelToView.on( 'selection', clearFakeSelection(), { priority: 'low' } );
  123. this.modelToView.on( 'selection', convertRangeSelection(), { priority: 'low' } );
  124. this.modelToView.on( 'selection', convertCollapsedSelection(), { priority: 'low' } );
  125. // Binds {@link module:engine/view/document~Document#roots view roots collection} to
  126. // {@link module:engine/model/document~Document#roots model roots collection} so creating
  127. // model root automatically creates corresponding view root.
  128. this.view.document.roots.bindTo( this.model.document.roots ).using( root => {
  129. // $graveyard is a special root that has no reflection in the view.
  130. if ( root.rootName == '$graveyard' ) {
  131. return null;
  132. }
  133. const viewRoot = new RootEditableElement( root.name );
  134. viewRoot.rootName = root.rootName;
  135. viewRoot.document = this.view.document;
  136. this.mapper.bindElements( root, viewRoot );
  137. return viewRoot;
  138. } );
  139. }
  140. /**
  141. * Removes all event listeners attached to the `EditingController`. Destroys all objects created
  142. * by `EditingController` that need to be destroyed.
  143. */
  144. destroy() {
  145. this.view.destroy();
  146. this.stopListening();
  147. }
  148. }
  149. mix( EditingController, ObservableMixin );