| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139 |
- /**
- * @license Copyright (c) 2003-2015, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md.
- */
- 'use strict';
- CKEDITOR.define( [
- 'document/element',
- 'document/rootelement',
- 'emittermixin',
- 'utils',
- 'ckeditorerror'
- ], function( Element, RootElement, EmitterMixin, utils, CKEditorError ) {
- var graveyardSymbol = Symbol( 'graveyard' );
- /**
- * Document model.
- *
- * @class document.Document
- */
- class Document {
- /**
- * Creates an empty document instance.
- *
- * @constructor
- */
- constructor() {
- /**
- * List of roots that are owned and managed by this document.
- *
- * @readonly
- * @property {Map} roots
- */
- this.roots = new Map();
- // Graveyard tree root. Document always have a graveyard root, which stores removed nodes.
- this.createRoot( graveyardSymbol );
- /**
- * Document version. It starts from `0` and every operation increases the version number. It is used to ensure that
- * operations are applied on the proper document version. If the {@link document.operation.Operation#baseVersion} will
- * not match document version the {@link document-applyOperation-wrong-version} error is thrown.
- *
- * @readonly
- * @property {Number} version
- */
- this.version = 0;
- }
- /**
- * This is the only entry point for all document changes.
- *
- * @param {document.operation.Operation} operation Operation to be applied.
- */
- applyOperation( operation ) {
- if ( operation.baseVersion !== this.version ) {
- /**
- * Only operations with matching versions can be applied.
- *
- * @error document-applyOperation-wrong-version
- * @param {document.operation.Operation} operation
- */
- throw new CKEditorError(
- 'document-applyOperation-wrong-version: Only operations with matching versions can be applied.',
- { operation: operation } );
- }
- operation._execute();
- this.version++;
- this.fire( 'operationApplied', operation );
- }
- /**
- * Creates a new top-level root.
- *
- * @param {String|Symbol} name Unique root name.
- * @returns {document.RootElement} Created root.
- */
- createRoot( name ) {
- if ( this.roots.has( name ) ) {
- /**
- * Root with specified name already exists.
- *
- * @error document-createRoot-name-exists
- * @param {document.Document} doc
- * @param {String} name
- */
- throw new CKEditorError(
- 'document-createRoot-name-exists: Root with specified name already exists.',
- { name: name }
- );
- }
- var root = new RootElement( this );
- this.roots.set( name, root );
- return root;
- }
- /**
- * Returns top-level root by it's name.
- *
- * @param {String|Symbol} name Name of the root to get.
- * @returns (document.RootElement} Root registered under given name.
- */
- getRoot( name ) {
- if ( !this.roots.has( name ) ) {
- /**
- * Root with specified name does not exist.
- *
- * @error document-createRoot-root-not-exist
- * @param {String} name
- */
- throw new CKEditorError(
- 'document-createRoot-root-not-exist: Root with specified name does not exist.',
- { name: name }
- );
- }
- return this.roots.get( name );
- }
- /**
- * Graveyard tree root. Document always have a graveyard root, which stores removed nodes.
- *
- * @protected
- * @readonly
- * @property {document.RootElement} _graveyard
- */
- get _graveyard() {
- return this.getRoot( graveyardSymbol );
- }
- }
- utils.extend( Document.prototype, EmitterMixin );
- return Document;
- } );
|