8
0

editingcontroller.js 4.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139
  1. /**
  2. * @license Copyright (c) 2003-2018, 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 View from '../view/view';
  10. import Mapper from '../conversion/mapper';
  11. import ModelConversionDispatcher from '../conversion/modelconversiondispatcher';
  12. import {
  13. insertText,
  14. remove
  15. } from '../conversion/model-to-view-converters';
  16. import { convertSelectionChange } from '../conversion/view-selection-to-model-converters';
  17. import {
  18. convertRangeSelection,
  19. convertCollapsedSelection,
  20. clearAttributes,
  21. clearFakeSelection
  22. } from '../conversion/model-selection-to-view-converters';
  23. import ObservableMixin from '@ckeditor/ckeditor5-utils/src/observablemixin';
  24. import mix from '@ckeditor/ckeditor5-utils/src/mix';
  25. /**
  26. * Controller for the editing pipeline. The editing pipeline controls {@link ~EditingController#model model} rendering,
  27. * including selection handling. It also creates {@link ~EditingController#view view document} which build a
  28. * browser-independent virtualization over the DOM elements. Editing controller also attach default converters.
  29. *
  30. * @mixes module:utils/observablemixin~ObservableMixin
  31. */
  32. export default class EditingController {
  33. /**
  34. * Creates editing controller instance.
  35. *
  36. * @param {module:engine/model/model~Model} model Editing model.
  37. */
  38. constructor( model ) {
  39. /**
  40. * Editing model.
  41. *
  42. * @readonly
  43. * @member {module:engine/model/model~Model}
  44. */
  45. this.model = model;
  46. /**
  47. * Editing view.
  48. *
  49. * @readonly
  50. * @member {module:engine/view/view~View}
  51. */
  52. this.view = new View();
  53. /**
  54. * Mapper which describes model-view binding.
  55. *
  56. * @readonly
  57. * @member {module:engine/conversion/mapper~Mapper}
  58. */
  59. this.mapper = new Mapper();
  60. /**
  61. * Model to view conversion dispatcher, which converts changes from the model to {@link #view the editing view}.
  62. *
  63. * To attach model-to-view converter to the editing pipeline you need to add a listener to this dispatcher:
  64. *
  65. * editing.modelToView( 'insert:$element', customInsertConverter );
  66. *
  67. * Or use {@link module:engine/conversion/buildmodelconverter~ModelConverterBuilder}:
  68. *
  69. * buildModelConverter().for( editing.modelToView ).fromAttribute( 'bold' ).toElement( 'b' );
  70. *
  71. * @readonly
  72. * @member {module:engine/conversion/modelconversiondispatcher~ModelConversionDispatcher} #modelToView
  73. */
  74. this.modelToView = new ModelConversionDispatcher( this.model, this.view, {
  75. mapper: this.mapper,
  76. viewSelection: this.view.document.selection
  77. } );
  78. const doc = this.model.document;
  79. // When all changes are done, get the model diff containing all the changes and convert them to view and then render to DOM.
  80. this.listenTo( doc, 'change', () => {
  81. // Convert changes stored in `modelDiffer`.
  82. this.modelToView.convertChanges( doc.differ );
  83. // After the view is ready, convert selection from model to view.
  84. this.modelToView.convertSelection( doc.selection );
  85. }, { priority: 'low' } );
  86. // Convert selection from view to model.
  87. this.listenTo( this.view.document, 'selectionChange', convertSelectionChange( this.model, this.mapper ) );
  88. // Attach default model converters.
  89. this.modelToView.on( 'insert:$text', insertText(), { priority: 'lowest' } );
  90. this.modelToView.on( 'remove', remove(), { priority: 'low' } );
  91. // Attach default model selection converters.
  92. this.modelToView.on( 'selection', clearAttributes(), { priority: 'low' } );
  93. this.modelToView.on( 'selection', clearFakeSelection(), { priority: 'low' } );
  94. this.modelToView.on( 'selection', convertRangeSelection(), { priority: 'low' } );
  95. this.modelToView.on( 'selection', convertCollapsedSelection(), { priority: 'low' } );
  96. // Binds {@link module:engine/view/document~Document#roots view roots collection} to
  97. // {@link module:engine/model/document~Document#roots model roots collection} so creating
  98. // model root automatically creates corresponding view root.
  99. this.view.document.roots.bindTo( this.model.document.roots ).using( root => {
  100. // $graveyard is a special root that has no reflection in the view.
  101. if ( root.rootName == '$graveyard' ) {
  102. return null;
  103. }
  104. const viewRoot = new RootEditableElement( root.name );
  105. viewRoot.rootName = root.rootName;
  106. viewRoot.document = this.view.document;
  107. this.mapper.bindElements( root, viewRoot );
  108. return viewRoot;
  109. } );
  110. }
  111. /**
  112. * Removes all event listeners attached to the `EditingController`. Destroys all objects created
  113. * by `EditingController` that need to be destroyed.
  114. */
  115. destroy() {
  116. this.view.destroy();
  117. this.stopListening();
  118. }
  119. }
  120. mix( EditingController, ObservableMixin );