ckeditor5-image-upload-base64
Version:
The development environment of CKEditor 5 – the best browser-based rich text editor.
140 lines (122 loc) • 4.33 kB
JavaScript
/**
* @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
*/
/**
* @module engine/model/operation/operation
*/
/**
* Abstract base operation class.
*
* @abstract
*/
export default class Operation {
/**
* Base operation constructor.
*
* @param {Number|null} baseVersion Document {@link module:engine/model/document~Document#version} on which operation
* can be applied or `null` if the operation operates on detached (non-document) tree.
*/
constructor( baseVersion ) {
/**
* {@link module:engine/model/document~Document#version} on which operation can be applied. If you try to
* {@link module:engine/model/model~Model#applyOperation apply} operation with different base version than the
* {@link module:engine/model/document~Document#version document version} the
* {@link module:utils/ckeditorerror~CKEditorError model-document-applyOperation-wrong-version} error is thrown.
*
* @member {Number}
*/
this.baseVersion = baseVersion;
/**
* Defines whether operation is executed on attached or detached {@link module:engine/model/item~Item items}.
*
* @readonly
* @member {Boolean} #isDocumentOperation
*/
this.isDocumentOperation = this.baseVersion !== null;
/**
* {@link module:engine/model/batch~Batch Batch} to which the operation is added or `null` if the operation is not
* added to any batch yet.
*
* @member {module:engine/model/batch~Batch|null} #batch
*/
this.batch = null;
/**
* Operation type.
*
* @readonly
* @member {String} #type
*/
/**
* Creates and returns an operation that has the same parameters as this operation.
*
* @method #clone
* @returns {module:engine/model/operation/operation~Operation} Clone of this operation.
*/
/**
* Creates and returns a reverse operation. Reverse operation when executed right after
* the original operation will bring back tree model state to the point before the original
* operation execution. In other words, it reverses changes done by the original operation.
*
* Keep in mind that tree model state may change since executing the original operation,
* so reverse operation will be "outdated". In that case you will need to transform it by
* all operations that were executed after the original operation.
*
* @method #getReversed
* @returns {module:engine/model/operation/operation~Operation} Reversed operation.
*/
/**
* Executes the operation - modifications described by the operation properties will be applied to the model tree.
*
* @protected
* @method #_execute
*/
}
/**
* Checks whether the operation's parameters are correct and the operation can be correctly executed. Throws
* an error if operation is not valid.
*
* @protected
* @method #_validate
*/
_validate() {
}
/**
* Custom toJSON method to solve child-parent circular dependencies.
*
* @method #toJSON
* @returns {Object} Clone of this object with the operation property replaced with string.
*/
toJSON() {
// This method creates only a shallow copy, all nested objects should be defined separately.
// See https://github.com/ckeditor/ckeditor5-engine/issues/1477.
const json = Object.assign( {}, this );
json.__className = this.constructor.className;
// Remove reference to the parent `Batch` to avoid circular dependencies.
delete json.batch;
// Only document operations are shared with other clients so it is not necessary to keep this information.
delete json.isDocumentOperation;
return json;
}
/**
* Name of the operation class used for serialization.
*
* @type {String}
*/
static get className() {
return 'Operation';
}
/**
* Creates Operation object from deserilized object, i.e. from parsed JSON string.
*
* @param {Object} json Deserialized JSON object.
* @param {module:engine/model/document~Document} doc Document on which this operation will be applied.
* @returns {module:engine/model/operation/operation~Operation}
*/
static fromJSON( json ) {
return new this( json.baseVersion );
}
// @if CK_DEBUG_ENGINE // log() {
// @if CK_DEBUG_ENGINE // console.log( this.toString() );
// @if CK_DEBUG_ENGINE // }
}