editingcontroller.js 5.0 KB

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