ModelText

• data : string

  readonly

  module:engine/model/text~ModelText#data

  Returns a text data contained in the node.

  See source (with github icon)

• document : null | ModelDocument

  readonlyinherited

  module:engine/model/text~ModelText#document

  Document that owns this root element.

  See source (with github icon)

• endOffset : null | number

  readonlyinherited

  module:engine/model/text~ModelText#endOffset

  Offset at which this node ends in its parent. It is equal to the sum of this node's start offset and offset size. Equals to null if the node has no parent.

  See source (with github icon)

• index : null | number

  readonlyinherited

  module:engine/model/text~ModelText#index

  Index of this node in its parent or null if the node has no parent.

  See source (with github icon)

• nextSibling : null | ModelNode

  readonlyinherited

  module:engine/model/text~ModelText#nextSibling

  Node's next sibling or null if the node is a last child of it's parent or if the node has no parent.

  See source (with github icon)

• offsetSize : number

  readonly

  module:engine/model/text~ModelText#offsetSize

  Offset size of this node.

  Represents how much "offset space" is occupied by the node in its parent. It is important for position. When node has offsetSize greater than 1, position can be placed between that node start and end. offsetSize greater than 1 is for nodes that represents more than one entity, i.e. a text node.

  See source (with github icon)

• parent : null | ModelElement | ModelDocumentFragment

  readonlyinherited

  module:engine/model/text~ModelText#parent

  Parent of this node. It could be ModelElement or ModelDocumentFragment. Equals to null if the node has no parent.

  See source (with github icon)

• previousSibling : null | ModelNode

  readonlyinherited

  module:engine/model/text~ModelText#previousSibling

  Node's previous sibling or null if the node is a first child of it's parent or if the node has no parent.

  See source (with github icon)

• root : ModelNode | ModelDocumentFragment

  readonlyinherited

  module:engine/model/text~ModelText#root

  The top-most ancestor of the node. If node has no parent it is the root itself. If the node is a part of ModelDocumentFragment, it's root is equal to that DocumentFragment.

  See source (with github icon)

• rootName : undefined | string

  readonlyinherited

  module:engine/model/text~ModelText#rootName

  Unique root name used to identify this root element by ModelDocument.

  See source (with github icon)

• startOffset : null | number

  readonlyinherited

  module:engine/model/text~ModelText#startOffset

  Offset at which this node starts in its parent. It is equal to the sum of offsetSize of all its previous siblings. Equals to null if node has no parent.

  See source (with github icon)

• _data : string

  internal

  module:engine/model/text~ModelText#_data

  Text data contained in this text node.

  See source (with github icon)

• _index : null | number

  internalinherited

  module:engine/model/text~ModelText#_index

  Index of this node in its parent or null if the node has no parent.

  See source (with github icon)

• _startOffset : null | number

  internalinherited

  module:engine/model/text~ModelText#_startOffset

  Offset at which this node starts in its parent or null if the node has no parent.

  See source (with github icon)

• constructor( [ data ], [ attrs ] )

  internal

  module:engine/model/text~ModelText#constructor

  Creates a text node.

  Note: Constructor of this class shouldn't be used directly in the code. Use the createText method instead.

  See source (with github icon)

  Parameters

  [ data ] : string

  Node's text.

  [ attrs ] : ModelNodeAttributes

  Node's attributes. See toMap for a list of accepted values.

• getAncestors( options = { [options.includeSelf], [options.parentFirst] } ) → Array<ModelNode | ModelDocumentFragment>

  inherited

  module:engine/model/text~ModelText#getAncestors

  Returns ancestors array of this node.

  See source (with github icon)

  Parameters

  options : object

  Options object.

  Properties

  [ options.includeSelf ] : boolean

  When set to true this node will be also included in parent's array.

  [ options.parentFirst ] : boolean

  When set to true, array will be sorted from node's parent to root element, otherwise root element will be the first item in the array.

  Defaults to {}

  Returns

  Array<ModelNode | ModelDocumentFragment>

  Array with ancestors.

• getAttribute( key ) → unknown

  inherited

  module:engine/model/text~ModelText#getAttribute

  Gets an attribute value for given key or undefined if that attribute is not set on node.

  See source (with github icon)

  Parameters

  key : string

  Key of attribute to look for.

  Returns

  unknown

  Attribute value or undefined.

• getAttributeKeys() → IterableIterator<string>

  inherited

  module:engine/model/text~ModelText#getAttributeKeys

  Returns iterator that iterates over this node's attribute keys.

  See source (with github icon)

  Returns

  IterableIterator<string>

• getAttributes() → IterableIterator<tuple>

  inherited

  module:engine/model/text~ModelText#getAttributes

  Returns iterator that iterates over this node's attributes.

  Attributes are returned as arrays containing two items. First one is attribute key and second is attribute value. This format is accepted by native Map object and also can be passed in Node constructor.

  See source (with github icon)

  Returns

  IterableIterator<tuple>

• getCommonAncestor( node, options = { [options.includeSelf] } ) → null | ModelElement | ModelDocumentFragment

  inherited

  module:engine/model/text~ModelText#getCommonAncestor

  Returns a ModelElement or ModelDocumentFragment which is a common ancestor of both nodes.

  See source (with github icon)

  Parameters

  node : ModelNode

  The second node.

  options : object

  Options object.

  Properties

  [ options.includeSelf ] : boolean

  When set to true both nodes will be considered "ancestors" too. Which means that if e.g. node A is inside B, then their common ancestor will be B.

  Defaults to {}

  Returns

  null | ModelElement | ModelDocumentFragment

• getPath() → Array<number>

  inherited

  module:engine/model/text~ModelText#getPath

  Gets path to the node. The path is an array containing starting offsets of consecutive ancestors of this node, beginning from root, down to this node's starting offset. The path can be used to create Position instance.

  const abc = new Text( 'abc' );
  const foo = new Text( 'foo' );
  const h1 = new ModelElement( 'h1', null, new Text( 'header' ) );
  const p = new ModelElement( 'p', null, [ abc, foo ] );
  const div = new ModelElement( 'div', null, [ h1, p ] );
  foo.getPath(); // Returns [ 1, 3 ]. `foo` is in `p` which is in `div`. `p` starts at offset 1, while `foo` at 3.
  h1.getPath(); // Returns [ 0 ].
  div.getPath(); // Returns [].
  

  Copy code

  See source (with github icon)

  Returns

  Array<number>

• hasAttribute( key ) → boolean

  inherited

  module:engine/model/text~ModelText#hasAttribute

  Checks if the node has an attribute with given key.

  See source (with github icon)

  Parameters

  key : string

  Key of attribute to check.

  Returns

  boolean

  true if attribute with given key is set on node, false otherwise.

• is( type ) → this is ModelElement | ModelRootElement

  inherited

  module:engine/model/text~ModelText#is:ELEMENT

  Checks whether the object is of type ModelElement or its subclass.

  element.is( 'element' ); // -> true
  element.is( 'node' ); // -> true
  element.is( 'model:element' ); // -> true
  element.is( 'model:node' ); // -> true
  
  element.is( 'view:element' ); // -> false
  element.is( 'documentSelection' ); // -> false
  

  Copy code

  Assuming that the object being checked is an element, you can also check its name:

  element.is( 'element', 'imageBlock' ); // -> true if this is an <imageBlock> element
  text.is( 'element', 'imageBlock' ); -> false
  

  Copy code

  See source (with github icon)

  Parameters

  type : 'element' | 'model:element'

  Returns

  this is ModelElement | ModelRootElement

• is( type ) → this is ModelRootElement

  inherited

  module:engine/model/text~ModelText#is:ROOT_ELEMENT

  Checks whether the object is of type ModelRootElement.

  rootElement.is( 'rootElement' ); // -> true
  rootElement.is( 'element' ); // -> true
  rootElement.is( 'node' ); // -> true
  rootElement.is( 'model:rootElement' ); // -> true
  rootElement.is( 'model:element' ); // -> true
  rootElement.is( 'model:node' ); // -> true
  
  rootElement.is( 'view:element' ); // -> false
  rootElement.is( 'documentFragment' ); // -> false
  

  Copy code

  Assuming that the object being checked is an element, you can also check its name:

  rootElement.is( 'rootElement', '$root' ); // -> same as above
  

  Copy code

  See source (with github icon)

  Parameters

  type : 'rootElement' | 'model:rootElement'

  Returns

  this is ModelRootElement

• is( type ) → this is ModelPosition | ModelLivePosition

  inherited

  module:engine/model/text~ModelText#is:POSITION

  Checks whether the object is of type ModelPosition or its subclass.

  position.is( 'position' ); // -> true
  position.is( 'model:position' ); // -> true
  
  position.is( 'view:position' ); // -> false
  position.is( 'documentSelection' ); // -> false
  

  Copy code

  See source (with github icon)

  Parameters

  type : 'position' | 'model:position'

  Returns

  this is ModelPosition | ModelLivePosition

• is( type ) → this is ModelText

  inherited

  module:engine/model/text~ModelText#is:TEXT

  Checks whether the object is of type ModelText.

  text.is( '$text' ); // -> true
  text.is( 'node' ); // -> true
  text.is( 'model:$text' ); // -> true
  text.is( 'model:node' ); // -> true
  
  text.is( 'view:$text' ); // -> false
  text.is( 'documentSelection' ); // -> false
  

  Copy code

  Note: Until version 20.0.0 this method wasn't accepting '$text' type. The legacy 'text' type is still accepted for backward compatibility.

  See source (with github icon)

  Parameters

  type : '$text' | 'model:$text'

  Returns

  this is ModelText

• is( type ) → this is ModelRange | ModelLiveRange

  inherited

  module:engine/model/text~ModelText#is:RANGE

  Checks whether the object is of type ModelRange or its subclass.

  range.is( 'range' ); // -> true
  range.is( 'model:range' ); // -> true
  
  range.is( 'view:range' ); // -> false
  range.is( 'documentSelection' ); // -> false
  

  Copy code

  See source (with github icon)

  Parameters

  type : 'range' | 'model:range'

  Returns

  this is ModelRange | ModelLiveRange

• is( type ) → this is ModelDocumentSelection

  inherited

  module:engine/model/text~ModelText#is:DOCUMENT_SELECTION

  Checks whether the object is of type ModelDocumentSelection.

  selection.is( 'selection' ); // -> true
  selection.is( 'documentSelection' ); // -> true
  selection.is( 'model:selection' ); // -> true
  selection.is( 'model:documentSelection' ); // -> true
  
  selection.is( 'view:selection' ); // -> false
  selection.is( 'element' ); // -> false
  selection.is( 'node' ); // -> false
  

  Copy code

  See source (with github icon)

  Parameters

  type : 'documentSelection' | 'model:documentSelection'

  Returns

  this is ModelDocumentSelection

• is( type, name ) → boolean

  inherited

  module:engine/model/text~ModelText#is:ELEMENT_NAME

  Checks whether the object is of type ModelElement or its subclass and has the specified name.

  element.is( 'element', 'imageBlock' ); // -> true if this is an <imageBlock> element
  text.is( 'element', 'imageBlock' ); -> false
  

  Copy code

  See source (with github icon)

  Type parameters

  N : extends string

  Parameters

  type : 'element' | 'model:element'

  name : N

  Returns

  boolean

• is( type ) → this is ModelTextProxy

  inherited

  module:engine/model/text~ModelText#is:TEXT_PROXY

  Checks whether the object is of type ModelTextProxy.

  textProxy.is( '$textProxy' ); // -> true
  textProxy.is( 'model:$textProxy' ); // -> true
  
  textProxy.is( 'view:$textProxy' ); // -> false
  textProxy.is( 'range' ); // -> false
  

  Copy code

  Note: Until version 20.0.0 this method wasn't accepting '$textProxy' type. The legacy 'textProxt' type is still accepted for backward compatibility.

  See source (with github icon)

  Parameters

  type : '$textProxy' | 'model:$textProxy'

  Returns

  this is ModelTextProxy

• is( type ) → this is Marker

  inherited

  module:engine/model/text~ModelText#is:MARKER

  Checks whether the object is of type Marker.

  marker.is( 'marker' ); // -> true
  marker.is( 'model:marker' ); // -> true
  
  marker.is( 'view:element' ); // -> false
  marker.is( 'documentSelection' ); // -> false
  

  Copy code

  See source (with github icon)

  Parameters

  type : 'marker' | 'model:marker'

  Returns

  this is Marker

• is( type ) → this is ModelSelection | ModelDocumentSelection

  inherited

  module:engine/model/text~ModelText#is:SELECTION

  Checks whether the object is of type ModelSelection or ModelDocumentSelection.

  selection.is( 'selection' ); // -> true
  selection.is( 'model:selection' ); // -> true
  
  selection.is( 'view:selection' ); // -> false
  selection.is( 'range' ); // -> false
  

  Copy code

  See source (with github icon)

  Parameters

  type : 'selection' | 'model:selection'

  Returns

  this is ModelSelection | ModelDocumentSelection

• is( type ) → this is ModelDocumentFragment

  inherited

  module:engine/model/text~ModelText#is:DOCUMENT_FRAGMENT

  Checks whether the object is of type ModelDocumentFragment.

  docFrag.is( 'documentFragment' ); // -> true
  docFrag.is( 'model:documentFragment' ); // -> true
  
  docFrag.is( 'view:documentFragment' ); // -> false
  docFrag.is( 'element' ); // -> false
  docFrag.is( 'node' ); // -> false
  

  Copy code

  See source (with github icon)

  Parameters

  type : 'documentFragment' | 'model:documentFragment'

  Returns

  this is ModelDocumentFragment

• is( type ) → this is ModelLiveRange

  inherited

  module:engine/model/text~ModelText#is:LIVE_RANGE

  Checks whether the object is of type ModelLiveRange.

  liveRange.is( 'range' ); // -> true
  liveRange.is( 'model:range' ); // -> true
  liveRange.is( 'liveRange' ); // -> true
  liveRange.is( 'model:liveRange' ); // -> true
  
  liveRange.is( 'view:range' ); // -> false
  liveRange.is( 'documentSelection' ); // -> false
  

  Copy code

  See source (with github icon)

  Parameters

  type : 'liveRange' | 'model:liveRange'

  Returns

  this is ModelLiveRange

• is( type ) → this is ModelLivePosition

  inherited

  module:engine/model/text~ModelText#is:LIVE_POSITION

  Checks whether the object is of type ModelLivePosition.

  livePosition.is( 'position' ); // -> true
  livePosition.is( 'model:position' ); // -> true
  livePosition.is( 'liveposition' ); // -> true
  livePosition.is( 'model:livePosition' ); // -> true
  
  livePosition.is( 'view:position' ); // -> false
  livePosition.is( 'documentSelection' ); // -> false
  

  Copy code

  See source (with github icon)

  Parameters

  type : 'livePosition' | 'model:livePosition'

  Returns

  this is ModelLivePosition

• is( type, name ) → boolean

  inherited

  module:engine/model/text~ModelText#is:ROOT_ELEMENT_NAME

  Checks whether the object is of type ModelRootElement and has the specified name.

  rootElement.is( 'rootElement', '$root' );
  

  Copy code

  See source (with github icon)

  Type parameters

  N : extends string

  Parameters

  type : 'rootElement' | 'model:rootElement'

  name : N

  Returns

  boolean

• is( type ) → this is ModelNode | ModelText | ModelElement | ModelRootElement

  inherited

  module:engine/model/text~ModelText#is:NODE

  Checks whether the object is of type ModelNode or its subclass.

  This method is useful when processing model objects that are of unknown type. For example, a function may return a ModelDocumentFragment or a ModelNode that can be either a text node or an element. This method can be used to check what kind of object is returned.

  someObject.is( 'element' ); // -> true if this is an element
  someObject.is( 'node' ); // -> true if this is a node (a text node or an element)
  someObject.is( 'documentFragment' ); // -> true if this is a document fragment
  

  Copy code

  Since this method is also available on a range of view objects, you can prefix the type of the object with model: or view: to check, for example, if this is the model's or view's element:

  modelElement.is( 'model:element' ); // -> true
  modelElement.is( 'view:element' ); // -> false
  

  Copy code

  By using this method it is also possible to check a name of an element:

  imageElement.is( 'element', 'imageBlock' ); // -> true
  imageElement.is( 'element', 'imageBlock' ); // -> same as above
  imageElement.is( 'model:element', 'imageBlock' ); // -> same as above, but more precise
  

  Copy code

  See source (with github icon)

  Parameters

  type : 'node' | 'model:node'

  Returns

  this is ModelNode | ModelText | ModelElement | ModelRootElement

• isAfter( node ) → boolean

  inherited

  module:engine/model/text~ModelText#isAfter

  Returns whether this node is after given node. false is returned if nodes are in different trees (for example, in different ModelDocumentFragments).

  See source (with github icon)

  Parameters

  node : ModelNode

  Node to compare with.

  Returns

  boolean

• isAttached() → boolean

  inherited

  module:engine/model/text~ModelText#isAttached

  Returns true if the node is inside a document root that is attached to the document.

  See source (with github icon)

  Returns

  boolean

• isBefore( node ) → boolean

  inherited

  module:engine/model/text~ModelText#isBefore

  Returns whether this node is before given node. false is returned if nodes are in different trees (for example, in different ModelDocumentFragments).

  See source (with github icon)

  Parameters

  node : ModelNode

  Node to compare with.

  Returns

  boolean

• toJSON() → unknown

  module:engine/model/text~ModelText#toJSON

  Converts Text instance to plain object and returns it.

  @returnsText instance converted to plain object.

  See source (with github icon)

  Returns

  unknown

• _clearAttributes() → void

  internalinherited

  module:engine/model/text~ModelText#_clearAttributes

  Removes all attributes from the node.

  See source (with github icon)

  Returns

  void

  Related:

  • ModelWriter#clearAttributes

• _clone() → ModelText

  internal

  module:engine/model/text~ModelText#_clone

  Creates a copy of this text node and returns it. Created text node has same text data and attributes as original text node.

  See source (with github icon)

  Returns

  ModelText

  Text instance created using given plain object.

• _remove() → void

  internalinherited

  module:engine/model/text~ModelText#_remove

  Removes this node from its parent.

  See source (with github icon)

  Returns

  void

  Related:

  • ModelWriter#remove

• _removeAttribute( key ) → boolean

  internalinherited

  module:engine/model/text~ModelText#_removeAttribute

  Removes an attribute with given key from the node.

  See source (with github icon)

  Parameters

  key : string

  Key of attribute to remove.

  Returns

  boolean

  true if the attribute was set on the element, false otherwise.

  Related:

  • ModelWriter#removeAttribute

• _setAttribute( key, value ) → void

  internalinherited

  module:engine/model/text~ModelText#_setAttribute

  Sets attribute on the node. If attribute with the same key already is set, it's value is overwritten.

  See source (with github icon)

  Parameters

  key : string

  Key of attribute to set.

  value : unknown

  Attribute value.

  Returns

  void

  Related:

  • ModelWriter#setAttribute

• _setAttributesTo( attrs ) → void

  internalinherited

  module:engine/model/text~ModelText#_setAttributesTo

  Removes all attributes from the node and sets given attributes.

  See source (with github icon)

  Parameters

  attrs : ModelNodeAttributes

  Attributes to set. See toMap for a list of accepted values.

  Returns

  void

  Related:

  • ModelWriter#setAttributes

Static methods

• fromJSON( json ) → ModelText

  static

  module:engine/model/text~ModelText.fromJSON

  Creates a Text instance from given plain object (i.e. parsed JSON string).

  See source (with github icon)

  Parameters

  json : any

  Plain object to be converted to Text.

  Returns

  ModelText

  Text instance created using given plain object.