editingcontroller.js 5.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163
  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 ViewDocument from './view/document.js';
  7. import MutationObserver from './view/observer/mutationobserver.js';
  8. import SelectionObserver from './view/observer/selectionobserver.js';
  9. import FocusObserver from './view/observer/focusobserver.js';
  10. import KeyObserver from './view/observer/keyobserver.js';
  11. import Mapper from './conversion/mapper.js';
  12. import ModelConversionDispatcher from './conversion/modelconversiondispatcher.js';
  13. import { insertText, remove, move } from './conversion/model-to-view-converters.js';
  14. import { convertSelectionChange } from './conversion/view-selection-to-model-converters.js';
  15. import {
  16. convertRangeSelection,
  17. convertCollapsedSelection,
  18. clearAttributes
  19. } from './conversion/model-selection-to-view-converters.js';
  20. import EmitterMixin from '../utils/emittermixin.js';
  21. /**
  22. * Controller for the editing pipeline. The editing pipeline controls {@link engine.EditingController#model model} rendering,
  23. * including selection handling. It also creates {@link engine.EditingController#view view document} which build a
  24. * browser-independent virtualization over the DOM elements. Editing controller also attach default converters and
  25. * observers.
  26. *
  27. * Note that the following observers are attached by the controller and are always available:
  28. *
  29. * * {@link view.observer.MutationObserver},
  30. * * {@link view.observer.SelectionObserver},
  31. * * {@link view.observer.FocusObserver},
  32. * * {@link view.observer.KeyObserver}.
  33. *
  34. * @memberOf engine
  35. */
  36. export default class EditingController {
  37. /**
  38. * Creates editing controller instance.
  39. *
  40. * @param {engine.model.Document} model Document model.
  41. */
  42. constructor( model ) {
  43. /**
  44. * Document model.
  45. *
  46. * @readonly
  47. * @member {engine.model.document} engine.EditingController#model
  48. */
  49. this.model = model;
  50. /**
  51. * View document.
  52. *
  53. * @readonly
  54. * @member {engine.view.document} engine.EditingController#view
  55. */
  56. this.view = new ViewDocument();
  57. // Attach default observers.
  58. this.view.addObserver( MutationObserver );
  59. this.view.addObserver( SelectionObserver );
  60. this.view.addObserver( FocusObserver );
  61. this.view.addObserver( KeyObserver );
  62. /**
  63. * Mapper which describes model-view binding.
  64. *
  65. * @readonly
  66. * @member {engine.conversion.Mapper} engine.EditingController#mapper
  67. */
  68. this.mapper = new Mapper();
  69. /**
  70. * Model to view conversion dispatcher, which converts changes from the model to
  71. * {@link engine.EditingController#view editing view}.
  72. *
  73. * To attach model to view converter to the editing pipeline you need to add lister to this property:
  74. *
  75. * editing.modelToView( 'insert:$element', customInsertConverter );
  76. *
  77. * Or use {@link engine.conversion.ModelConverterBuilder}:
  78. *
  79. * BuildModelConverterFor( editing.modelToView ).fromAttribute( 'bold' ).toElement( 'b' );
  80. *
  81. * @readonly
  82. * @member {engine.conversion.ModelConversionDispatcher} engine.EditingController#modelToView
  83. */
  84. this.modelToView = new ModelConversionDispatcher( {
  85. writer: this.view.writer,
  86. mapper: this.mapper,
  87. viewSelection: this.view.selection
  88. } );
  89. /**
  90. * Property keeping all listenters attached by controller on other objects, so it can
  91. * stop listening on {@link engine.EditingController#destroy}.
  92. *
  93. * @private
  94. * @member {utils.EmitterMixin} engine.EditingController#_listenter
  95. */
  96. this._listenter = Object.create( EmitterMixin );
  97. // Convert view selection to model.
  98. this._listenter.listenTo( this.view, 'selectionChange', convertSelectionChange( model, this.mapper ) );
  99. this._listenter.listenTo( this.model, 'change', ( evt, type, changes ) => {
  100. this.modelToView.convertChange( type, changes );
  101. } );
  102. this._listenter.listenTo( this.model, 'changesDone', () => {
  103. this.modelToView.convertSelection( model.selection );
  104. this.view.render();
  105. } );
  106. // Attach default content converters.
  107. this.modelToView.on( 'insert:$text', insertText() );
  108. this.modelToView.on( 'remove', remove() );
  109. this.modelToView.on( 'move', move() );
  110. // Attach default selection converters.
  111. this.modelToView.on( 'selection', clearAttributes() );
  112. this.modelToView.on( 'selection', convertRangeSelection() );
  113. this.modelToView.on( 'selection', convertCollapsedSelection() );
  114. }
  115. /**
  116. * {@link engine.view.Document#createRoot Creates} a view root and {@link engine.conversion.Mapper#bindElements binds}
  117. * the model root with view root and and view root with DOM element:
  118. *
  119. * editing.createRoot( document.querySelector( div#editor ) );
  120. *
  121. * If the DOM element is not available at the time you want to create a view root, for instance it is iframe body
  122. * element, it is possible to create view element and bind the DOM element later:
  123. *
  124. * editing.createRoot( 'body' );
  125. * editing.view.attachDomRoot( iframe.contentDocument.body );
  126. *
  127. * @param {Element|String} domRoot DOM root element or the name of view root element if the DOM element will be
  128. * attached later.
  129. * @param {String} [name='main'] Root name.
  130. * @returns {engine.view.ContainerElement} View root element.
  131. */
  132. createRoot( domRoot, name = 'main' ) {
  133. const viewRoot = this.view.createRoot( domRoot, name );
  134. const modelRoot = this.model.getRoot( name );
  135. this.mapper.bindElements( modelRoot, viewRoot );
  136. return viewRoot;
  137. }
  138. /**
  139. * Removes all event listeners attached by the EditingController.
  140. */
  141. destroy() {
  142. this._listenter.stopListening();
  143. }
  144. }