|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.xerces.dom.NodeImpl | +--org.apache.xerces.dom.ChildNode | +--org.apache.xerces.dom.CharacterDataImpl
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.
Field Summary | |
---|---|
protected java.lang.String |
data
|
Fields inherited from class org.apache.xerces.dom.ChildNode |
---|
nextSibling, previousSibling |
Fields inherited from class org.apache.xerces.dom.NodeImpl |
---|
ELEMENT_DEFINITION_NODE, FIRSTCHILD, flags, HASSTRING, IGNORABLEWS, OWNED, ownerNode, READONLY, SPECIFIED, SYNCCHILDREN, SYNCDATA, UNNORMALIZED |
Fields inherited from interface org.w3c.dom.Node |
---|
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE |
Constructor Summary | |
---|---|
protected |
CharacterDataImpl(CoreDocumentImpl ownerDocument,
java.lang.String data)
Factory constructor. |
Method Summary | |
---|---|
void |
appendData(java.lang.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. |
java.lang.String |
getData()
Retrieve character data currently stored in this node. |
int |
getLength()
Report number of characters currently stored in this node's data. |
java.lang.String |
getNodeValue()
Returns the node value. |
void |
insertData(int offset,
java.lang.String data)
Insert additional characters into the data stored in this node, at the offset specified. |
void |
replaceData(int offset,
int count,
java.lang.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(java.lang.String value)
Store character data into this node. |
void |
setNodeValue(java.lang.String value)
Sets the content, possibly firing related events, and updating ranges (via notification to the document) |
protected void |
setNodeValueInternal(java.lang.String value)
This function added so that we can distinguish whether setNodeValue has been called from some other DOM functions. |
java.lang.String |
substringData(int offset,
int count)
Substring is more than a convenience function. |
Methods inherited from class org.apache.xerces.dom.ChildNode |
---|
cloneNode, getNextSibling, getParentNode, getPreviousSibling |
Methods inherited from class org.apache.xerces.dom.NodeImpl |
---|
addEventListener, appendChild, changed, changes, dispatchEvent, getAttributes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNodeName, getNodeType, getOwnerDocument, getPrefix, getReadOnly, getUserData, hasAttributes, hasChildNodes, insertBefore, isSupported, item, normalize, removeChild, removeEventListener, replaceChild, setPrefix, setReadOnly, setUserData, synchronizeData, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
protected java.lang.String data
Constructor Detail |
protected CharacterDataImpl(CoreDocumentImpl ownerDocument, java.lang.String data)
Method Detail |
public NodeList getChildNodes()
getChildNodes
in class NodeImpl
public java.lang.String getNodeValue()
NodeImpl
getNodeValue
in class NodeImpl
org.w3c.dom.Node
DOMException
- NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.DOMException
- DOMSTRING_SIZE_ERR: Raised when it would return more characters than
fit in a DOMString
variable on the implementation
platform.protected void setNodeValueInternal(java.lang.String value)
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).
public void setNodeValue(java.lang.String value)
setNodeValue
in class NodeImpl
org.apache.xerces.dom.NodeImpl
DOMException(NO_MODIFICATION_ALLOWED_ERR)
- public java.lang.String getData()
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.public int getLength()
getLength
in class NodeImpl
org.apache.xerces.dom.NodeImpl
ParentNode
public void appendData(java.lang.String data)
DOMException(NO_MODIFICATION_ALLOWED_ERR)
- if node is readonly.public void deleteData(int offset, int count) throws DOMException
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.public void insertData(int offset, java.lang.String data) throws DOMException
DOMException(INDEX_SIZE_ERR)
- if offset is negative or
greater than length.DOMException(NO_MODIFICATION_ALLOWED_ERR)
- if node is readonly.public void replaceData(int offset, int count, java.lang.String data) throws DOMException
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.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.public void setData(java.lang.String value) throws DOMException
DOMException(NO_MODIFICATION_ALLOWED_ERR)
- if node is readonly.public java.lang.String substringData(int offset, int count) throws DOMException
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.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.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |