| java.lang.Object org.apache.xerces.dom.NodeImpl org.apache.xerces.dom.ChildNode org.apache.xerces.dom.CharacterDataImpl
All known Subclasses: org.apache.xerces.dom.ProcessingInstructionImpl, org.apache.xerces.dom.TextImpl, org.apache.xerces.dom.CommentImpl,
CharacterDataImpl | abstract public class CharacterDataImpl extends ChildNode (Code) | | 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.
since: PR-DOM-Level-1-19980818. |
Method Summary | |
public void | appendData(String data) Concatenate additional characters onto the end of the data
stored in this node. | public void | deleteData(int offset, int count) Remove a range of characters from the node's value. | public NodeList | getChildNodes() Returns an empty node list. | public String | getData() Retrieve character data currently stored in this node.
throws: DOMExcpetion - (DOMSTRING_SIZE_ERR) In some implementations,the stored data may exceed the permitted length of strings. | public int | getLength() Report number of characters currently stored in this node's
data. | public String | getNodeValue() | public void | insertData(int offset, String data) Insert additional characters into the data stored in this node,
at the offset specified.
throws: DOMException - (INDEX_SIZE_ERR) if offset is negative orgreater than length. throws: DOMException - (NO_MODIFICATION_ALLOWED_ERR) if node is readonly. | public 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. | public void | setData(String value) Store character data into this node. | public void | setNodeValue(String value) | protected void | setNodeValueInternal(String value) This function added so that we can distinguish whether
setNodeValue has been called from some other DOM functions. | public String | substringData(int offset, int count) Substring is more than a convenience function. |
serialVersionUID | final static long serialVersionUID(Code) | | Serialization version.
|
appendData | public void appendData(String data)(Code) | | 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.)
throws: DOMException - (NO_MODIFICATION_ALLOWED_ERR) if node is readonly. |
deleteData | public void deleteData(int offset, int count) throws DOMException(Code) | | 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.
throws: DOMException - (INDEX_SIZE_ERR) if offset is negative orgreater than length, or if count is negative. throws: DOMException - (NO_MODIFICATION_ALLOWED_ERR) if node isreadonly. |
getChildNodes | public NodeList getChildNodes()(Code) | | Returns an empty node list.
|
getData | public String getData()(Code) | | Retrieve character data currently stored in this node.
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 toinstead retrieve the data in chunks via the substring() operation. |
getLength | public int getLength()(Code) | | Report number of characters currently stored in this node's
data. It may be 0, meaning that the value is an empty string.
|
insertData | public void insertData(int offset, String data) throws DOMException(Code) | | Insert additional characters into the data stored in this node,
at the offset specified.
throws: DOMException - (INDEX_SIZE_ERR) if offset is negative orgreater than length. throws: DOMException - (NO_MODIFICATION_ALLOWED_ERR) if node is readonly. |
replaceData | public void replaceData(int offset, int count, String data) throws DOMException(Code) | | 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.
Parameters: offset - The offset at which to begin replacing. Parameters: count - The number of characters to remove, interpreted as in the delete() method. Parameters: data - The new string to be inserted at offset in place ofthe removed data. Note that the entire string willbe inserted -- the count parameter does not affectinsertion, and the new data may be longer or shorterthan the substring it replaces. throws: DOMException - (INDEX_SIZE_ERR) if offset is negative orgreater than length, or if count is negative. throws: DOMException - (NO_MODIFICATION_ALLOWED_ERR) if node isreadonly. |
setNodeValue | public void setNodeValue(String value)(Code) | | Sets the content, possibly firing related events,
and updating ranges (via notification to the document)
|
setNodeValueInternal | protected void setNodeValueInternal(String value)(Code) | | 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).
|
substringData | public String substringData(int offset, int count) throws DOMException(Code) | | 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.
Parameters: offset - Zero-based offset of first character to retrieve. Parameters: count - Number of characters to retrieve. If the sum of offset and count exceeds the length, all charactersto end of data are returned. throws: DOMException - (INDEX_SIZE_ERR) if offset is negative orgreater than length, or if count is negative. throws: 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 toinstead retrieve the data in smaller chunks. |
|
|