org.apache.xerces.dom

Class TextImpl

public class TextImpl extends CharacterDataImpl implements CharacterData, 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 org.w3c.dom.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: $Id: TextImpl.java,v 1.29 2004/11/08 22:21:39 nddelima Exp $

UNKNOWN:

Constructor Summary
TextImpl()
Default constructor
TextImpl(CoreDocumentImpl ownerDoc, String data)
Factory constructor.
Method Summary
StringgetNodeName()
Returns the node name.
shortgetNodeType()
A short integer indicating what type of node this is.
StringgetWholeText()
DOM Level 3 WD - Experimental.
protected voidinsertTextContent(StringBuffer buf)
internal method taking a StringBuffer in parameter and inserts the text content at the start of the buffer
booleanisElementContentWhitespace()
DOM L3 Core CR - Experimental Returns whether this text node contains element content whitespace, often abusively called "ignorable whitespace".
booleanisIgnorableWhitespace()
NON-DOM: Returns whether this Text is ignorable whitespace.
StringremoveData()
NON-DOM (used by DOMParser: Sets data to empty string.
voidreplaceData(String value)
NON-DOM (used by DOMParser): Reset data for the node.
TextreplaceWholeText(String content)
Replaces the text of the current node and all logically-adjacent text nodes with the specified text.
voidsetIgnorableWhitespace(boolean ignore)
NON-DOM: Set whether this Text is ignorable whitespace.
voidsetValues(CoreDocumentImpl ownerDoc, String data)
NON-DOM: resets node and sets specified values for the current node
TextsplitText(int offset)
Break a text node into two sibling nodes.

Constructor Detail

TextImpl

public TextImpl()
Default constructor

TextImpl

public TextImpl(CoreDocumentImpl ownerDoc, String data)
Factory constructor.

Method Detail

getNodeName

public String getNodeName()
Returns the node name.

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.

getWholeText

public String getWholeText()
DOM Level 3 WD - Experimental. Returns all text of Text nodes logically-adjacent text nodes to this node, concatenated in document order.

Since: DOM Level 3

insertTextContent

protected void insertTextContent(StringBuffer buf)
internal method taking a StringBuffer in parameter and inserts the text content at the start of the buffer

Parameters: buf

isElementContentWhitespace

public boolean isElementContentWhitespace()
DOM L3 Core CR - Experimental Returns whether this text node contains element content whitespace, often abusively called "ignorable whitespace". The text node is determined to contain whitespace in element content during the load of the document or if validation occurs while using Document.normalizeDocument().

Since: DOM Level 3

isIgnorableWhitespace

public boolean isIgnorableWhitespace()
NON-DOM: Returns whether this Text is ignorable whitespace.

removeData

public String removeData()
NON-DOM (used by DOMParser: Sets data to empty string. Returns the value the data was set to.

replaceData

public void replaceData(String value)
NON-DOM (used by DOMParser): Reset data for the node.

replaceWholeText

public Text replaceWholeText(String content)
Replaces the text of the current node and all logically-adjacent text nodes with the specified text. All logically-adjacent text nodes are removed including the current node unless it was the recipient of the replacement text.

Parameters: content The content of the replacing Text node.

Returns: text - The Text node created with the specified content.

Since: DOM Level 3

setIgnorableWhitespace

public void setIgnorableWhitespace(boolean ignore)
NON-DOM: Set whether this Text is ignorable whitespace.

setValues

public void setValues(CoreDocumentImpl ownerDoc, String data)
NON-DOM: resets node and sets specified values for the current node

Parameters: ownerDoc data

splitText

public Text splitText(int offset)
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.)

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

Returns: A reference to the new node (containing data after the offset point). The original node will contain data up to that point.

Throws: DOMException(INDEX_SIZE_ERR) if offset is <0 or >length. DOMException(NO_MODIFICATION_ALLOWED_ERR) if node is read-only.

Copyright B) 1999-2005 Apache XML Project. All Rights Reserved.