W3C DOM Level 2 version 1.0 - Java API: Interface Text

Overview

Package

Class

Tree

Index

Help

PREV CLASS NEXT CLASS

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.w3c.dom
Interface Text

All Superinterfaces:: CharacterData, Node

All Known Subinterfaces:: CDATASection

public interface Text
extends CharacterData

The Text interface inherits from CharacterData and 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 the information items (elements, comments, etc.) 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 Node merges any such adjacent Text objects into a single node for each block of text.

Fields inherited from interface 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 node into two 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,
getLocalName,
getNamespaceURI,
getNextSibling,
getNodeName,
getNodeType,
getNodeValue,
getOwnerDocument,
getParentNode,
getPrefix,
getPreviousSibling,
hasAttributes,
hasChildNodes,

insertBefore, 
isSupported, normalize,

removeChild, 
replaceChild, setNodeValue,
setPrefix

Method Detail

splitText

public Text splitText(int offset)
               throws DOMException

Breaks this node into two nodes at the specified offset, keeping both in the tree as siblings. After being split, this node will contain all the content up to the offset point. A new node of the same type, which contains all the content at and after the offset point, is returned. If the original node had a parent node, the new node is inserted as the next sibling of the original node. When the offset is equal to the length of this node, the new node has no data.

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