editingcontroller.js 5.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159
  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 ViewDocument from '../view/document';
  9. import Mapper from '../conversion/mapper';
  10. import ModelConversionDispatcher from '../conversion/modelconversiondispatcher';
  11. import {
  12. insertText,
  13. remove
  14. } from '../conversion/model-to-view-converters';
  15. import { convertSelectionChange } from '../conversion/view-selection-to-model-converters';
  16. import {
  17. convertRangeSelection,
  18. convertCollapsedSelection,
  19. clearAttributes,
  20. clearFakeSelection
  21. } from '../conversion/model-selection-to-view-converters';
  22. import ObservableMixin from '@ckeditor/ckeditor5-utils/src/observablemixin';
  23. import mix from '@ckeditor/ckeditor5-utils/src/mix';
  24. /**
  25. * Controller for the editing pipeline. The editing pipeline controls {@link ~EditingController#model model} rendering,
  26. * including selection handling. It also creates {@link ~EditingController#view view document} which build a
  27. * browser-independent virtualization over the DOM elements. Editing controller also attach default converters.
  28. *
  29. * @mixes module:utils/observablemixin~ObservableMixin
  30. */
  31. export default class EditingController {
  32. /**
  33. * Creates editing controller instance.
  34. *
  35. * @param {module:engine/model/model~Model} model Editing model.
  36. */
  37. constructor( model ) {
  38. /**
  39. * Editing model.
  40. *
  41. * @readonly
  42. * @member {module:engine/model/model~Model}
  43. */
  44. this.model = model;
  45. /**
  46. * View document.
  47. *
  48. * @readonly
  49. * @member {module:engine/view/document~Document}
  50. */
  51. this.view = new ViewDocument();
  52. /**
  53. * Mapper which describes model-view binding.
  54. *
  55. * @readonly
  56. * @member {module:engine/conversion/mapper~Mapper}
  57. */
  58. this.mapper = new Mapper();
  59. /**
  60. * Model to view conversion dispatcher, which converts changes from the model to
  61. * {@link #view editing view}.
  62. *
  63. * To attach model to view converter to the editing pipeline you need to add lister to this property:
  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.document, {
  75. mapper: this.mapper,
  76. viewSelection: this.view.selection
  77. } );
  78. // Convert changes in model to view.
  79. this.listenTo( this.model.document, 'change', ( evt, type, changes ) => {
  80. this.modelToView.convertChange( type, changes );
  81. }, { priority: 'low' } );
  82. // Convert model selection to view.
  83. this.listenTo( this.model.document, 'changesDone', () => {
  84. const selection = this.model.selection;
  85. this.modelToView.convertSelection( selection );
  86. this.view.render();
  87. }, { priority: 'low' } );
  88. // Convert model markers changes.
  89. this.listenTo( this.model.markers, 'add', ( evt, marker ) => {
  90. this.modelToView.convertMarker( 'addMarker', marker.name, marker.getRange() );
  91. } );
  92. this.listenTo( this.model.markers, 'remove', ( evt, marker ) => {
  93. this.modelToView.convertMarker( 'removeMarker', marker.name, marker.getRange() );
  94. } );
  95. // Convert view selection to model.
  96. this.listenTo( this.view, 'selectionChange', convertSelectionChange( this.model.document, this.mapper ) );
  97. // Attach default content converters.
  98. this.modelToView.on( 'insert:$text', insertText(), { priority: 'lowest' } );
  99. this.modelToView.on( 'remove', remove(), { priority: 'low' } );
  100. // Attach default selection converters.
  101. this.modelToView.on( 'selection', clearAttributes(), { priority: 'low' } );
  102. this.modelToView.on( 'selection', clearFakeSelection(), { priority: 'low' } );
  103. this.modelToView.on( 'selection', convertRangeSelection(), { priority: 'low' } );
  104. this.modelToView.on( 'selection', convertCollapsedSelection(), { priority: 'low' } );
  105. }
  106. /**
  107. * {@link module:engine/view/document~Document#createRoot Creates} a view root
  108. * and {@link module:engine/conversion/mapper~Mapper#bindElements binds}
  109. * the model root with view root and and view root with DOM element:
  110. *
  111. * editing.createRoot( document.querySelector( div#editor ) );
  112. *
  113. * If the DOM element is not available at the time you want to create a view root, for instance it is iframe body
  114. * element, it is possible to create view element and bind the DOM element later:
  115. *
  116. * editing.createRoot( 'body' );
  117. * editing.view.attachDomRoot( iframe.contentDocument.body );
  118. *
  119. * @param {Element|String} domRoot DOM root element or the name of view root element if the DOM element will be
  120. * attached later.
  121. * @param {String} [name='main'] Root name.
  122. * @returns {module:engine/view/containerelement~ContainerElement} View root element.
  123. */
  124. createRoot( domRoot, name = 'main' ) {
  125. const viewRoot = this.view.createRoot( domRoot, name );
  126. const modelRoot = this.model.document.getRoot( name );
  127. this.mapper.bindElements( modelRoot, viewRoot );
  128. return viewRoot;
  129. }
  130. /**
  131. * Removes all event listeners attached to the `EditingController`. Destroys all objects created
  132. * by `EditingController` that need to be destroyed.
  133. */
  134. destroy() {
  135. this.view.destroy();
  136. this.stopListening();
  137. }
  138. }
  139. mix( EditingController, ObservableMixin );