org.apache.xerces.dom
public abstract class CharacterDataImpl extends ChildNode
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.
Since: PR-DOM-Level-1-19980818.
Version: $Id: CharacterDataImpl.java,v 1.24 2004/11/04 20:42:20 mrglavas Exp $
UNKNOWN:
Field Summary | |
---|---|
protected String | data |
Constructor Summary | |
---|---|
CharacterDataImpl() | |
protected | CharacterDataImpl(CoreDocumentImpl ownerDocument, String data) Factory constructor. |
Method Summary | |
---|---|
void | appendData(String data)
Concatenate additional characters onto the end of the data
stored in this node. |
void | deleteData(int offset, int count)
Remove a range of characters from the node's value. |
NodeList | getChildNodes() Returns an empty node list. |
String | getData()
Retrieve character data currently stored in this node.
|
int | getLength()
Report number of characters currently stored in this node's
data. |
String | getNodeValue() |
void | insertData(int offset, String data)
Insert additional characters into the data stored in this node,
at the offset specified.
|
void | replaceData(int offset, int count, String data)
Replace a series of characters at the specified (zero-based)
offset with a new string, NOT necessarily of the same
length. |
void | setData(String value)
Store character data into this node.
|
void | setNodeValue(String value)
Sets the content, possibly firing related events,
and updating ranges (via notification to the document) |
protected void | setNodeValueInternal(String value) Convenience wrapper for calling setNodeValueInternal when
we are not performing a replacement operation |
protected void | setNodeValueInternal(String value, boolean replace) 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). |
String | substringData(int offset, int count)
Substring is more than a convenience function. |
Throws: DOMException(NO_MODIFICATION_ALLOWED_ERR) if node is readonly.
Throws: DOMException(INDEX_SIZE_ERR) if offset is negative or greater than length, or if count is negative. DOMException(NO_MODIFICATION_ALLOWED_ERR) if node is readonly.
Throws: DOMExcpetion(DOMSTRING_SIZE_ERR) 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.
Throws: DOMException(INDEX_SIZE_ERR) if offset is negative or greater than length. DOMException(NO_MODIFICATION_ALLOWED_ERR) if node is readonly.
Parameters: 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.
Throws: DOMException(INDEX_SIZE_ERR) if offset is negative or greater than length, or if count is negative. DOMException(NO_MODIFICATION_ALLOWED_ERR) if node is readonly.
Throws: DOMException(NO_MODIFICATION_ALLOWED_ERR) if node is readonly.
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).
Parameters: 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.
Throws: DOMException(INDEX_SIZE_ERR) if offset is negative or greater than length, or if count is negative. DOMException(WSTRING_SIZE_ERR) 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.