java.lang.Object | |||
↳ | org.apache.xerces.dom.NodeImpl | ||
↳ | org.apache.xerces.dom.ChildNode | ||
↳ | org.apache.xerces.dom.CharacterDataImpl |
Known Direct Subclasses |
Known Indirect Subclasses |
CharacterData is an abstract Node that can carry character data as its Value. It provides shared behavior for Text, CData, and possibly other node types. All offsets are 0-based.
Since ProcessingInstructionImpl inherits from this class to reuse the setNodeValue method, this class isn't declared as implementing the interface CharacterData. This is done by relevant subclasses (TexImpl, CommentImpl).
This class doesn't directly support mutation events, however, it notifies the document when mutations are performed so that the document class do so.
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
org.apache.xerces.dom.NodeImpl
| |||||||||||
From interface
org.w3c.dom.Node
|
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
data |
[Expand]
Inherited Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
org.apache.xerces.dom.ChildNode
| |||||||||||
From class
org.apache.xerces.dom.NodeImpl
|
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Protected Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Factory constructor.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Concatenate additional characters onto the end of the data
stored in this node.
| |||||||||||
Remove a range of characters from the node's value.
| |||||||||||
Returns an empty node list.
| |||||||||||
Retrieve character data currently stored in this node.
| |||||||||||
Report number of characters currently stored in this node's
data.
| |||||||||||
Returns the node value.
| |||||||||||
Insert additional characters into the data stored in this node,
at the offset specified.
| |||||||||||
Replace a series of characters at the specified (zero-based)
offset with a new string, NOT necessarily of the same
length.
| |||||||||||
Store character data into this node.
| |||||||||||
Sets the content, possibly firing related events,
and updating ranges (via notification to the document)
| |||||||||||
Substring is more than a convenience function.
|
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Convenience wrapper for calling setNodeValueInternal when
we are not performing a replacement operation
| |||||||||||
This function added so that we can distinguish whether
setNodeValue has been called from some other DOM functions.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
org.apache.xerces.dom.ChildNode
| |||||||||||
From class
org.apache.xerces.dom.NodeImpl
| |||||||||||
From class
java.lang.Object
| |||||||||||
From interface
org.w3c.dom.Node
| |||||||||||
From interface
org.w3c.dom.NodeList
| |||||||||||
From interface
org.w3c.dom.events.EventTarget
|
Concatenate additional characters onto the end of the data stored in this node. Note that this, and insert(), are the paths by which a DOM could wind up accumulating more data than the language's strings can easily handle. (See above discussion.)
if node is readonly. |
Remove a range of characters from the node's value. Throws a DOMException if the offset is beyond the end of the string. However, a deletion _count_ that exceeds the available data is accepted as a delete-to-end request.
if offset is negative or greater than length, or if count is negative. | |
if node is readonly. | |
DOMException |
Returns an empty node list.
Retrieve character data currently stored in this node.
In some implementations, the stored data may exceed the permitted length of strings. If so, getData() will throw this DOMException advising the user to instead retrieve the data in chunks via the substring() operation. |
Report number of characters currently stored in this node's data. It may be 0, meaning that the value is an empty string.
Insert additional characters into the data stored in this node, at the offset specified.
if offset is negative or greater than length. | |
if node is readonly. | |
DOMException |
Replace a series of characters at the specified (zero-based) offset with a new string, NOT necessarily of the same length. Convenience method, equivalent to a delete followed by an insert. Throws a DOMException if the specified offset is beyond the end of the existing data.
offset | The offset at which to begin replacing. |
---|---|
count | The number of characters to remove, interpreted as in the delete() method. |
data | The new string to be inserted at offset in place of the removed data. Note that the entire string will be inserted -- the count parameter does not affect insertion, and the new data may be longer or shorter than the substring it replaces. |
if offset is negative or greater than length, or if count is negative. | |
if node is readonly. | |
DOMException |
Store character data into this node.
if node is readonly. | |
DOMException |
Sets the content, possibly firing related events, and updating ranges (via notification to the document)
Substring is more than a convenience function. In some implementations of the DOM, where the stored data may exceed the length that can be returned in a single string, the only way to read it all is to extract it in chunks via this method.
offset | Zero-based offset of first character to retrieve. |
---|---|
count | Number of characters to retrieve. If the sum of offset and count exceeds the length, all characters to end of data are returned. |
if offset is negative or greater than length, or if count is negative. | |
In some implementations, count may exceed the permitted length of strings. If so, substring() will throw this DOMException advising the user to instead retrieve the data in smaller chunks. | |
DOMException |
Convenience wrapper for calling setNodeValueInternal when we are not performing a replacement operation
This function added so that we can distinguish whether setNodeValue has been called from some other DOM functions. or by the client.
This is important, because we do one type of Range fix-up, from the high-level functions in CharacterData, and another type if the client simply calls setNodeValue(value).