: Interface Text

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.w3c.dom
Interface Text

All Known Subinterfaces:: CDATASection

All Known Implementing Classes:: TextImpl

public abstract interface Text
extends CharacterData

The Text interface represents the textual content (termed character data in XML) of an Element or Attr. If there is no markup inside an element's content, the text is contained in a single object implementing the Text interface that is the only child of the element. If there is markup, it is parsed into a list of elements and Text nodes that form the list of children of the element.

When a document is first made available via the DOM, there is only one Text node for each block of text. Users may create adjacent Text nodes that represent the contents of a given element without any intervening markup, but should be aware that there is no way to represent the separations between these nodes in XML or HTML, so they will not (in general) persist between DOM editing sessions. The normalize() method on Element merges any such adjacent Text objects into a single node for each block of text; this is recommended before employing operations that depend on a particular document structure, such as navigation with XPointers.

Fields inherited from class org.w3c.dom.Node

ATTRIBUTE_NODE,  
CDATA_SECTION_NODE,  
COMMENT_NODE,  
DOCUMENT_FRAGMENT_NODE,  
DOCUMENT_NODE,  
DOCUMENT_TYPE_NODE,  
ELEMENT_NODE,  
ENTITY_NODE,  
ENTITY_REFERENCE_NODE,  
NOTATION_NODE,  
PROCESSING_INSTRUCTION_NODE,  
TEXT_NODE

Method Summary
`Text`	`splitText(int offset)` Breaks this `Text` node into two Text nodes at the specified offset, keeping both in the tree as siblings.

Methods inherited from interface org.w3c.dom.CharacterData

appendData, 
deleteData, 
getData, 
getLength, 
insertData, 
replaceData, 
setData, 
substringData

Methods inherited from interface org.w3c.dom.Node

appendChild, 
cloneNode, 
getAttributes, 
getChildNodes, 
getFirstChild, 
getLastChild, 
getNextSibling, 
getNodeName, 
getNodeType, 
getNodeValue, 
getOwnerDocument, 
getParentNode, 
getPreviousSibling, 
hasChildNodes, 
insertBefore, 
removeChild, 
replaceChild, 
setNodeValue

Method Detail

splitText

public Text splitText(int offset)
               throws DOMException

Breaks this Text node into two Text nodes at the specified offset, keeping both in the tree as siblings. This node then only contains all the content up to the offset point. And a new Text node, which is inserted as the next sibling of this node, contains all the content at and after the offset point.

Parameters:: offset - The offset at which to split, starting from 0.
Returns:: The new Text node.
Throws:: DOMException - INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of characters in data.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.