| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172 |
- /**
- * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
- /**
- * @module engine/controller/editingcontroller
- */
- import ViewDocument from '../view/document';
- import Mapper from '../conversion/mapper';
- import ModelConversionDispatcher from '../conversion/modelconversiondispatcher';
- import {
- insertText,
- remove
- } from '../conversion/model-to-view-converters';
- import { convertSelectionChange } from '../conversion/view-selection-to-model-converters';
- import {
- convertRangeSelection,
- convertCollapsedSelection,
- clearAttributes,
- clearFakeSelection
- } from '../conversion/model-selection-to-view-converters';
- import ObservableMixin from '@ckeditor/ckeditor5-utils/src/observablemixin';
- import mix from '@ckeditor/ckeditor5-utils/src/mix';
- /**
- * Controller for the editing pipeline. The editing pipeline controls {@link ~EditingController#model model} rendering,
- * including selection handling. It also creates {@link ~EditingController#view view document} which build a
- * browser-independent virtualization over the DOM elements. Editing controller also attach default converters.
- *
- * @mixes module:utils/observablemixin~ObservableMixin
- */
- export default class EditingController {
- /**
- * Creates editing controller instance.
- *
- * @param {module:engine/model/document~Document} model Document model.
- */
- constructor( model ) {
- /**
- * Document model.
- *
- * @readonly
- * @member {module:engine/model/document~Document}
- */
- this.model = model;
- /**
- * View document.
- *
- * @readonly
- * @member {module:engine/view/document~Document}
- */
- this.view = new ViewDocument();
- /**
- * Mapper which describes model-view binding.
- *
- * @readonly
- * @member {module:engine/conversion/mapper~Mapper}
- */
- this.mapper = new Mapper();
- /**
- * Defines whether controller is in read-only mode.
- *
- * When controller is read-ony then {module:engine/view/document~Document view document} is read-only as well.
- *
- * @observable
- * @member {Boolean} #isReadOnly
- */
- this.set( 'isReadOnly', false );
- // When controller is read-only the view document is read-only as well.
- this.view.bind( 'isReadOnly' ).to( this );
- /**
- * Model to view conversion dispatcher, which converts changes from the model to
- * {@link #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 module:engine/conversion/buildmodelconverter~ModelConverterBuilder}:
- *
- * buildModelConverter().for( editing.modelToView ).fromAttribute( 'bold' ).toElement( 'b' );
- *
- * @readonly
- * @member {module:engine/conversion/modelconversiondispatcher~ModelConversionDispatcher} #modelToView
- */
- this.modelToView = new ModelConversionDispatcher( this.model, {
- mapper: this.mapper,
- viewSelection: this.view.selection
- } );
- // Convert changes in model to view.
- this.listenTo( this.model, 'change', ( evt, type, changes ) => {
- this.modelToView.convertChange( type, changes );
- }, { priority: 'low' } );
- // Convert model selection to view.
- this.listenTo( this.model, 'changesDone', () => {
- const selection = this.model.selection;
- this.modelToView.convertSelection( selection );
- this.view.render();
- }, { priority: 'low' } );
- // Convert model markers changes.
- this.listenTo( this.model.markers, 'add', ( evt, marker ) => {
- this.modelToView.convertMarker( 'addMarker', marker.name, marker.getRange() );
- } );
- this.listenTo( this.model.markers, 'remove', ( evt, marker ) => {
- this.modelToView.convertMarker( 'removeMarker', marker.name, marker.getRange() );
- } );
- // Convert view selection to model.
- this.listenTo( this.view, 'selectionChange', convertSelectionChange( this.model, this.mapper ) );
- // Attach default content converters.
- this.modelToView.on( 'insert:$text', insertText(), { priority: 'lowest' } );
- this.modelToView.on( 'remove', remove(), { priority: 'low' } );
- // Attach default selection converters.
- this.modelToView.on( 'selection', clearAttributes(), { priority: 'low' } );
- this.modelToView.on( 'selection', clearFakeSelection(), { priority: 'low' } );
- this.modelToView.on( 'selection', convertRangeSelection(), { priority: 'low' } );
- this.modelToView.on( 'selection', convertCollapsedSelection(), { priority: 'low' } );
- }
- /**
- * {@link module:engine/view/document~Document#createRoot Creates} a view root
- * and {@link module:engine/conversion/mapper~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 {module:engine/view/containerelement~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 to the `EditingController`. Destroys all objects created
- * by `EditingController` that need to be destroyed.
- */
- destroy() {
- this.view.destroy();
- this.stopListening();
- }
- }
- mix( EditingController, ObservableMixin );
|