net.sf.saxon.dom

Class TextOverNodeInfo

public class TextOverNodeInfo extends NodeOverNodeInfo implements Text, Comment

This class is an implementation of the DOM Text and Comment interfaces that wraps a Saxon NodeInfo representation of a text or comment node.
Method Summary
voidappendData(String arg)
Append the string to the end of the character data of the node.
voiddeleteData(int offset, int count)
Remove a range of 16-bit units from the node.
StringgetData()
Get the character data of a Text or Comment node.
intgetLength()
Get the length of a Text or Comment node.
StringgetWholeText()
Returns all text of Text nodes logically-adjacent text nodes to this node, concatenated in document order.
voidinsertData(int offset, String arg)
Insert a string at the specified character offset.
booleanisElementContentWhitespace()
Returns whether this text node contains element content whitespace, often abusively called "ignorable whitespace".
voidreplaceData(int offset, int count, String arg)
Replace the characters starting at the specified 16-bit unit offset with the specified string.
TextreplaceWholeText(String content)
Replaces the text of the current node and all logically-adjacent text nodes with the specified text.
voidsetData(String data)
Set the character data of a Text or Comment node.
TextsplitText(int offset)
Break this node into two nodes at the specified offset, keeping both in the tree as siblings.
StringsubstringData(int offset, int count)
Extract a range of data from a Text or Comment node.

Method Detail

appendData

public void appendData(String arg)
Append the string to the end of the character data of the node. DOM method: always fails.

Parameters: arg The DOMString to append.

Throws: org.w3c.dom.DOMException NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

deleteData

public void deleteData(int offset, int count)
Remove a range of 16-bit units from the node. DOM method: always fails.

Parameters: offset The offset from which to start removing. count The number of 16-bit units to delete.

Throws: org.w3c.dom.DOMException

getData

public String getData()
Get the character data of a Text or Comment node. DOM method.

getLength

public int getLength()
Get the length of a Text or Comment node. DOM method.

getWholeText

public String getWholeText()
Returns all text of Text nodes logically-adjacent text nodes to this node, concatenated in document order.
For instance, in the example below wholeText on the Text node that contains "bar" returns "barfoo", while on the Text node that contains "foo" it returns "barfoo".

Since: DOM Level 3

insertData

public void insertData(int offset, String arg)
Insert a string at the specified character offset. DOM method: always fails.

Parameters: offset The character offset at which to insert. arg The DOMString to insert.

Throws: org.w3c.dom.DOMException

isElementContentWhitespace

public boolean isElementContentWhitespace()
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

replaceData

public void replaceData(int offset, int count, String arg)
Replace the characters starting at the specified 16-bit unit offset with the specified string. DOM method: always fails.

Parameters: offset The offset from which to start replacing. count The number of 16-bit units to replace. arg The DOMString with which the range must be replaced.

Throws: org.w3c.dom.DOMException NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

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.
This method returns the node which received the replacement text. The returned node is:
For instance, in the above example calling replaceWholeText on the Text node that contains "bar" with "yo" in argument results in the following:
Where the nodes to be removed are read-only descendants of an EntityReference, the EntityReference must be removed instead of the read-only nodes. If any EntityReference to be removed has descendants that are not EntityReference, Text, or CDATASection nodes, the replaceWholeText method must fail before performing any modification of the document, raising a DOMException with the code NO_MODIFICATION_ALLOWED_ERR.
For instance, in the example below calling replaceWholeText on the Text node that contains "bar" fails, because the EntityReference node "ent" contains an Element node which cannot be removed.

Parameters: content The content of the replacing Text node.

Returns: The Text node created with the specified content.

Throws: org.w3c.dom.DOMException NO_MODIFICATION_ALLOWED_ERR: Raised if one of the Text nodes being replaced is readonly.

Since: DOM Level 3

setData

public void setData(String data)
Set the character data of a Text or Comment node. DOM method: always fails, Saxon tree is immutable.

splitText

public Text splitText(int offset)
Break this node into two nodes at the specified offset, keeping both in the tree as siblings. DOM method, always fails.

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: org.w3c.dom.DOMException

substringData

public String substringData(int offset, int count)
Extract a range of data from a Text or Comment node. DOM method.

Parameters: offset Start offset of substring to extract. count The number of 16-bit units to extract.

Returns: The specified substring. If the sum of offset and count exceeds the length , then all 16-bit units to the end of the data are returned.

Throws: org.w3c.dom.DOMException INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of 16-bit units in data , or if the specified count is negative.