Package net.sf.saxon.dom
Class TextOverNodeInfo
java.lang.Object
net.sf.saxon.dom.NodeOverNodeInfo
net.sf.saxon.dom.TextOverNodeInfo
- All Implemented Interfaces:
CharacterData
,Comment
,Node
,Text
- Direct Known Subclasses:
TextOverAttrInfo
This class is an implementation of the DOM Text and Comment interfaces that wraps a Saxon NodeInfo
representation of a text or comment node.
-
Field Summary
Fields inherited from class net.sf.saxon.dom.NodeOverNodeInfo
node
Fields inherited from interface org.w3c.dom.Node
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
appendData
(String arg) Append the string to the end of the character data of the node.void
deleteData
(int offset, int count) Remove a range of 16-bit units from the node.getData()
Get the character data of a Text or Comment node.int
Get the length of a Text or Comment node.Returns all text ofText
nodes logically-adjacent text nodes to this node, concatenated in document order.void
insertData
(int offset, String arg) Insert a string at the specified character offset.boolean
Returns whether this text node contains element content whitespace, often abusively called "ignorable whitespace".void
replaceData
(int offset, int count, String arg) Replace the characters starting at the specified 16-bit unit offset with the specified string.replaceWholeText
(String content) Replaces the text of the current node and all logically-adjacent text nodes with the specified text.void
Set the character data of a Text or Comment node.splitText
(int offset) Break this node into two nodes at the specified offset, keeping both in the tree as siblings.substringData
(int offset, int count) Extract a range of data from a Text or Comment node.Methods inherited from class net.sf.saxon.dom.NodeOverNodeInfo
appendChild, cloneNode, compareDocumentPosition, disallowUpdate, equals, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUnderlyingNodeInfo, getUserData, hasAttributes, hasChildNodes, hashCode, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData, wrap
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.w3c.dom.Node
appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData
-
Constructor Details
-
TextOverNodeInfo
public TextOverNodeInfo()
-
-
Method Details
-
getData
Get the character data of a Text or Comment node. DOM method.- Specified by:
getData
in interfaceCharacterData
-
setData
Set the character data of a Text or Comment node. DOM method: always fails, Saxon tree is immutable.- Specified by:
setData
in interfaceCharacterData
- Throws:
DOMException
-
getLength
public int getLength()Get the length of a Text or Comment node. DOM method.- Specified by:
getLength
in interfaceCharacterData
-
substringData
Extract a range of data from a Text or Comment node. DOM method.- Specified by:
substringData
in interfaceCharacterData
- 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
andcount
exceeds thelength
, then all 16-bit units to the end of the data are returned. - Throws:
DOMException
- INDEX_SIZE_ERR: Raised if the specifiedoffset
is negative or greater than the number of 16-bit units indata
, or if the specifiedcount
is negative.
-
appendData
Append the string to the end of the character data of the node. DOM method: always fails.- Specified by:
appendData
in interfaceCharacterData
- Parameters:
arg
- TheDOMString
to append.- Throws:
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
-
insertData
Insert a string at the specified character offset. DOM method: always fails.- Specified by:
insertData
in interfaceCharacterData
- Parameters:
offset
- The character offset at which to insert.arg
- TheDOMString
to insert.- Throws:
UnsupportedOperationException
- alwaysDOMException
-
deleteData
Remove a range of 16-bit units from the node. DOM method: always fails.- Specified by:
deleteData
in interfaceCharacterData
- Parameters:
offset
- The offset from which to start removing.count
- The number of 16-bit units to delete.- Throws:
UnsupportedOperationException
- alwaysDOMException
-
replaceData
Replace the characters starting at the specified 16-bit unit offset with the specified string. DOM method: always fails.- Specified by:
replaceData
in interfaceCharacterData
- Parameters:
offset
- The offset from which to start replacing.count
- The number of 16-bit units to replace.arg
- TheDOMString
with which the range must be replaced.- Throws:
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
-
splitText
Break this node into two nodes at the specified offset, keeping both in the tree as siblings. DOM method, always fails.- Specified by:
splitText
in interfaceText
- 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
- always (the DOM is read-only)
-
replaceWholeText
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:null
, when the replacement text is the empty string;- the current node, except when the current node is read-only;
- a new
Text
node of the same type (Text
orCDATASection
) as the current node inserted at the location of the replacement.
For instance, in the above example callingreplaceWholeText
on theText
node that contains "bar" with "yo" in argument results in the following:
Where the nodes to be removed are read-only descendants of anEntityReference
, theEntityReference
must be removed instead of the read-only nodes. If anyEntityReference
to be removed has descendants that are notEntityReference
,Text
, orCDATASection
nodes, thereplaceWholeText
method must fail before performing any modification of the document, raising aDOMException
with the codeNO_MODIFICATION_ALLOWED_ERR
.
For instance, in the example below callingreplaceWholeText
on theText
node that contains "bar" fails, because theEntityReference
node "ent" contains anElement
node which cannot be removed.- Specified by:
replaceWholeText
in interfaceText
- Parameters:
content
- The content of the replacingText
node.- Returns:
- The
Text
node created with the specified content. - Throws:
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised if one of theText
nodes being replaced is readonly.- Since:
- DOM Level 3
-
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 usingDocument.normalizeDocument()
.- Specified by:
isElementContentWhitespace
in interfaceText
- Since:
- DOM Level 3
-
getWholeText
Returns all text ofText
nodes logically-adjacent text nodes to this node, concatenated in document order.
For instance, in the example belowwholeText
on theText
node that contains "bar" returns "barfoo", while on theText
node that contains "foo" it returns "barfoo".- Specified by:
getWholeText
in interfaceText
- Since:
- DOM Level 3
-