/** * @license Copyright (c) 2003-2015, CKSource - Frederico Knabben. All rights reserved. * For licensing, see LICENSE.md. */ 'use strict'; /** * TextProxy is a wrapper for substring of {@link engine.view.Text}. Instance of this class is created by * {@link engine.view.TreeWalker} when only a part of {@link engine.view.Text} needs to be returned. * * **Note:** `TextProxy` instances are created on the fly basing on the current state of parent {@link engine.view.Text}. * Because of this it is highly unrecommended to store references to `TextProxy` instances because they might get * invalidated due to operations on the document. Also, `TextProxy` is not a {@link engine.view.Node} so it cannot be * inserted as a child of {@link engine.view.Element}. * * You should never create an instance of this class by your own. * * @memberOf engine.view */ export default class TextProxy { /** * Creates a tree view text proxy. * * @param {engine.view.Text} textNode Text node which text proxy is a substring. * @param {Number} startOffset Offset from beginning of {#textNode} and first character of {#data}. * @param {Number} [length] Length of substring. If is not set then the end offset is at the end of {#textNode}. */ constructor( textNode, startOffset, length ) { /** * Element that is a parent of this text proxy. * * @readonly * @member {engine.view.Element|engine.view.DocumentFragment|null} engine.view.Node#parent */ this.parent = textNode.parent; /** * Reference to the {@link engine.view.Text} element which TextProxy is a substring. * * @readonly * @member {engine.view.Text} engine.view.TextProxy#textNode */ this.textNode = textNode; /** * Index of the substring in the `textParent`. * * @readonly * @member {Number} engine.view.TextProxy#index */ this.index = startOffset; /** * The text content. * * @readonly * @member {String} engine.view.TextProxy#data */ this.data = textNode.data.substring( startOffset, startOffset + ( length || textNode.data.length - startOffset ) ); } /** * Gets {@link engine.view.Document} reference, from the {@link engine.view.Node#getRoot root} of * {#textNode} or returns null if the root has no reference to the {@link engine.view.Document}. * * @returns {engine.view.Document|null} View Document of the text proxy or null. */ getDocument() { return this.textNode.getDocument(); } /** * Gets the top parent for the {#textNode}. If there is no parent {#textNode} is the root. * * @returns {engine.view.Node} */ getRoot() { return this.textNode.getRoot(); } /** * Returns ancestors array of this text proxy. * * @param {Object} options Options object. * @param {Boolean} [options.includeNode=false] When set to `true` {#textNode} will be also included in parent's array. * @param {Boolean} [options.parentFirst=false] When set to `true`, array will be sorted from text proxy parent to * root element, otherwise root element will be the first item in the array. * @returns {Array} Array with ancestors. */ getAncestors( options = { includeNode: false, parentFirst: false } ) { const ancestors = []; let parent = options.includeNode ? this.textNode : this.parent; while ( parent !== null ) { ancestors[ options.parentFirst ? 'push' : 'unshift' ]( parent ); parent = parent.parent; } return ancestors; } }