| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141 |
- /**
- * @license Copyright (c) 2003-2016, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
- import ViewDocument from './view/document.js';
- import Mapper from './conversion/mapper.js';
- import ModelConversionDispatcher from './conversion/modelconversiondispatcher.js';
- import { insertText, remove, move } from './conversion/model-to-view-converters.js';
- import { convertSelectionChange } from './conversion/view-selection-to-model-converters.js';
- import {
- convertRangeSelection,
- convertCollapsedSelection,
- clearAttributes
- } from './conversion/model-selection-to-view-converters.js';
- import EmitterMixin from '../utils/emittermixin.js';
- /**
- * Controller for the editing pipeline. The editing pipeline controls {@link engine.EditingController#model model} rendering,
- * including selection handling. It also creates {@link engine.EditingController#view view document} which build a
- * browser-independent virtualization over the DOM elements. Editing controller also attach default converters.
- *
- * @memberOf engine
- */
- export default class EditingController {
- /**
- * Creates editing controller instance.
- *
- * @param {engine.model.Document} model Document model.
- */
- constructor( model ) {
- /**
- * Document model.
- *
- * @readonly
- * @member {engine.model.document} engine.EditingController#model
- */
- this.model = model;
- /**
- * View document.
- *
- * @readonly
- * @member {engine.view.document} engine.EditingController#view
- */
- this.view = new ViewDocument();
- /**
- * Mapper which describes model-view binding.
- *
- * @readonly
- * @member {engine.conversion.Mapper} engine.EditingController#mapper
- */
- this.mapper = new Mapper();
- /**
- * Model to view conversion dispatcher, which converts changes from the model to
- * {@link engine.EditingController#view editing view}.
- *
- * To attach model to view converter to the editing pipeline you need to add lister to this property:
- *
- * editing.modelToView( 'insert:$element', customInsertConverter );
- *
- * Or use {@link engine.conversion.ModelConverterBuilder}:
- *
- * buildModelConverter().for( editing.modelToView ).fromAttribute( 'bold' ).toElement( 'b' );
- *
- * @readonly
- * @member {engine.conversion.ModelConversionDispatcher} engine.EditingController#modelToView
- */
- this.modelToView = new ModelConversionDispatcher( {
- mapper: this.mapper,
- viewSelection: this.view.selection
- } );
- /**
- * Property keeping all listenters attached by controller on other objects, so it can
- * stop listening on {@link engine.EditingController#destroy}.
- *
- * @private
- * @member {utils.EmitterMixin} engine.EditingController#_listenter
- */
- this._listenter = Object.create( EmitterMixin );
- // Convert view selection to model.
- this._listenter.listenTo( this.view, 'selectionChange', convertSelectionChange( model, this.mapper ) );
- this._listenter.listenTo( this.model, 'change', ( evt, type, changes ) => {
- this.modelToView.convertChange( type, changes );
- } );
- this._listenter.listenTo( this.model, 'changesDone', () => {
- this.modelToView.convertSelection( model.selection );
- this.view.render();
- } );
- // Attach default content converters.
- this.modelToView.on( 'insert:$text', insertText() );
- this.modelToView.on( 'remove', remove() );
- this.modelToView.on( 'move', move() );
- // Attach default selection converters.
- this.modelToView.on( 'selection', clearAttributes() );
- this.modelToView.on( 'selection', convertRangeSelection() );
- this.modelToView.on( 'selection', convertCollapsedSelection() );
- }
- /**
- * {@link engine.view.Document#createRoot Creates} a view root and {@link engine.conversion.Mapper#bindElements binds}
- * the model root with view root and and view root with DOM element:
- *
- * editing.createRoot( document.querySelector( div#editor ) );
- *
- * If the DOM element is not available at the time you want to create a view root, for instance it is iframe body
- * element, it is possible to create view element and bind the DOM element later:
- *
- * editing.createRoot( 'body' );
- * editing.view.attachDomRoot( iframe.contentDocument.body );
- *
- * @param {Element|String} domRoot DOM root element or the name of view root element if the DOM element will be
- * attached later.
- * @param {String} [name='main'] Root name.
- * @returns {engine.view.ContainerElement} View root element.
- */
- createRoot( domRoot, name = 'main' ) {
- const viewRoot = this.view.createRoot( domRoot, name );
- const modelRoot = this.model.getRoot( name );
- this.mapper.bindElements( modelRoot, viewRoot );
- return viewRoot;
- }
- /**
- * Removes all event listeners attached by the EditingController.
- */
- destroy() {
- this._listenter.stopListening();
- }
- }
|