XML for Java 2.0.15

com.ibm.xml.dom
Class TextImpl

java.lang.Object
  |
  +--com.ibm.xml.dom.NodeImpl
        |
        +--com.ibm.xml.dom.CharacterDataImpl
              |
              +--com.ibm.xml.dom.TextImpl
Direct Known Subclasses:
CDATASectionImpl, DeferredTextImpl

public class TextImpl
extends CharacterDataImpl
implements 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 Element.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:
Revision: 69 1.9 src/com/ibm/xml/dom/TextImpl.java, parser, xml4j2, xml4j2_0_15
See Also:
Serialized Form

Field Summary
protected  boolean ignorableWhitespace
          Ignorable whitespace.
 
Fields inherited from class com.ibm.xml.dom.NodeImpl
ELEMENT_DEFINITION_NODE, firstChild, kidOK, lastChild, name, nextSibling, ownerDocument, parentNode, previousSibling, readOnly, syncChildren, syncData, userData, value
 
Constructor Summary
TextImpl(DocumentImpl ownerDoc, java.lang.String data)
          Factory constructor.
 
Method Summary
 Node cloneNode(boolean deep)
          Clones this node.
 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.
 Text splitText(int offset)
          Break a text node into two sibling nodes.
 
Methods inherited from class com.ibm.xml.dom.CharacterDataImpl
appendData, deleteData, getChildNodes, getData, getLength, insertData, replaceData, setData, substringData
 
Methods inherited from class com.ibm.xml.dom.NodeImpl
appendChild, changed, getAttributes, getFirstChild, getLastChild, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getPreviousSibling, getReadOnly, getUserData, hasChildNodes, insertBefore, isKidOK, item, removeChild, replaceChild, setNodeValue, setReadOnly, setUserData, synchronizeChildren, synchronizeData, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

ignorableWhitespace

protected boolean ignorableWhitespace
Ignorable whitespace.
Constructor Detail

TextImpl

public TextImpl(DocumentImpl 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.
Overrides:
getNodeType in class NodeImpl

getNodeName

public java.lang.String getNodeName()
Returns the node name.
Overrides:
getNodeName in class CharacterDataImpl

cloneNode

public Node cloneNode(boolean deep)
Clones this node.
Overrides:
cloneNode 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 Text splitText(int offset)
               throws 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 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.

XML for Java 2.0.15