org.apache.xerces.dom
Class TextImpl

java.lang.Object
  |
  +--org.apache.xerces.dom.NodeImpl
        |
        +--org.apache.xerces.dom.ChildNode
              |
              +--org.apache.xerces.dom.CharacterDataImpl
                    |
                    +--org.apache.xerces.dom.TextImpl

All Implemented Interfaces:

org.w3c.dom.CharacterData, java.lang.Cloneable, org.w3c.dom.events.EventTarget, org.w3c.dom.Node, org.apache.xerces.dom3.Node3, org.w3c.dom.NodeList, java.io.Serializable, org.w3c.dom.Text

Direct Known Subclasses:

CDATASectionImpl, DeferredTextImpl

public class TextImpl

extends CharacterDataImpl

implements org.w3c.dom.CharacterData, org.w3c.dom.Text

Text nodes hold the non-markup, non-Entity content of an Element or Attribute.

When a document is first made available to the DOM, there is only one Text object for each block of adjacent plain-text. Users (ie, applications) may create multiple adjacent Texts during editing -- see Node.normalize() for discussion.

Note that CDATASection is a subclass of Text. This is conceptually valid, since they're really just two different ways of quoting characters when they're written out as part of an XML stream.

Since:

PR-DOM-Level-1-19980818.

Version:

$Id: TextImpl.java,v 1.13 2002/01/29 01:15:07 lehors Exp $

See Also:

Serialized Form

Fields inherited from class org.apache.xerces.dom.CharacterDataImpl

data

Fields inherited from class org.apache.xerces.dom.ChildNode

nextSibling, previousSibling

Fields inherited from class org.apache.xerces.dom.NodeImpl

ELEMENT_DEFINITION_NODE, FIRSTCHILD, flags, HASSTRING, IGNORABLEWS, OWNED, ownerNode, READONLY, SPECIFIED, SYNCCHILDREN, SYNCDATA, UNNORMALIZED

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

Fields inherited from interface org.apache.xerces.dom3.Node3

TREE_POSITION_ANCESTOR, TREE_POSITION_DESCENDANT, TREE_POSITION_DISCONNECTED, TREE_POSITION_EQUIVALENT, TREE_POSITION_FOLLOWING, TREE_POSITION_PRECEDING, TREE_POSITION_SAME_NODE

Constructor Summary

TextImpl(CoreDocumentImpl ownerDoc, java.lang.String data)
Factory constructor.

Method Summary

java.lang.String	getNodeName() Returns the node name.
short	getNodeType() A short integer indicating what type of node this is.
boolean	isIgnorableWhitespace() NON-DOM: Returns whether this Text is ignorable whitespace.
void	setIgnorableWhitespace(boolean ignore) NON-DOM: Set whether this Text is ignorable whitespace.
org.w3c.dom.Text	splitText(int offset) Break a text node into two sibling nodes.

Methods inherited from class org.apache.xerces.dom.CharacterDataImpl

appendData, deleteData, getChildNodes, getData, getLength, getNodeValue, insertData, replaceData, setData, setNodeValue, setNodeValueInternal, substringData

Methods inherited from class org.apache.xerces.dom.ChildNode

cloneNode, getNextSibling, getParentNode, getPreviousSibling

Methods inherited from class org.apache.xerces.dom.NodeImpl

addEventListener, appendChild, changed, changes, compareTreePosition, dispatchEvent, getAttributes, getBaseURI, getFirstChild, getInterface, getLastChild, getLocalName, getNamespaceURI, getOwnerDocument, getPrefix, getReadOnly, getTextContent, getUserData, getUserData, hasAttributes, hasChildNodes, insertBefore, isEqualNode, isSameNode, isSupported, item, lookupNamespacePrefix, lookupNamespaceURI, needsSyncChildren, normalize, removeChild, removeEventListener, replaceChild, setPrefix, setReadOnly, setTextContent, setUserData, setUserData, synchronizeData, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, hasAttributes, hasChildNodes, insertBefore, isSupported, normalize, removeChild, replaceChild, setNodeValue, setPrefix

Constructor Detail

TextImpl

public TextImpl(CoreDocumentImpl ownerDoc,
                java.lang.String data)

Factory constructor.

Method Detail

getNodeType

public short getNodeType()

A short integer indicating what type of node this is. The named constants for this value are defined in the org.w3c.dom.Node interface.

Specified by:

getNodeType in interface org.w3c.dom.Node

Overrides:

getNodeType in class NodeImpl

getNodeName

public java.lang.String getNodeName()

Returns the node name.

Specified by:

getNodeName in interface org.w3c.dom.Node

Overrides:

getNodeName in class NodeImpl

setIgnorableWhitespace

public void setIgnorableWhitespace(boolean ignore)

NON-DOM: Set whether this Text is ignorable whitespace.

isIgnorableWhitespace

public boolean isIgnorableWhitespace()

NON-DOM: Returns whether this Text is ignorable whitespace.

splitText

public org.w3c.dom.Text splitText(int offset)
                           throws org.w3c.dom.DOMException

Break a text node into two sibling nodes. (Note that if the current node has no parent, they won't wind up as "siblings" -- they'll both be orphans.)

Specified by:

splitText in interface org.w3c.dom.Text

Parameters:

offset - The offset at which to split. If offset is at the end of the available data, the second node will be empty.

Throws:

DOMException(INDEX_SIZE_ERR) - if offset is <0 or >length.

DOMException(NO_MODIFICATION_ALLOWED_ERR) - if node is read-only.