|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The CharacterData
interface extends Node with a set
of attributes
and methods for accessing character data in the DOM.
For clarity this set is defined
here rather than on each object that uses these attributes and methods. No DOM objects correspond directly to CharacterData
,
though Text
and
others do inherit the interface from it. All offset
s in
this interface start from 0.
Property Summary | ||
data |
getData setData | The character data of the node
that implements this interface. The DOM implementation may not
put arbitrary limits on the amount of data that may be stored in a
|
length |
getLength | The number of characters that
are available through |
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 |
Method Summary | |
void |
appendData(java.lang.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 characters from the node. |
java.lang.String |
getData()
Returns the value of the data property. |
int |
getLength()
Returns the value of the length property. |
void |
insertData(int offset,
java.lang.String arg)
Insert a string at the specified character offset. |
void |
replaceData(int offset,
int count,
java.lang.String arg)
Replace the characters starting at the specified character offset with the specified string. |
void |
setData(java.lang.String data)
Assigns the value of the data property. |
java.lang.String |
substringData(int offset,
int count)
Extracts a range of data from the node. |
Methods inherited from interface org.w3c.dom.Node |
appendChild,
cloneNode,
getAttributes,
getChildNodes,
getFirstChild,
getLastChild,
getNextSibling,
getNodeName,
getNodeType,
getNodeValue,
getOwnerDocument,
getParentNode,
getPreviousSibling,
hasChildNodes,
insertBefore,
removeChild,
replaceChild,
setNodeValue |
Method Detail |
public void setData(java.lang.String data) throws DOMException
data
property.NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
public java.lang.String getData() throws DOMException
data
property.DOMSTRING_SIZE_ERR: Raised when it would return more
characters than fit in a String
variable on the
implementation platform.
public int getLength()
length
property.public java.lang.String substringData(int offset, int count) throws DOMException
Extracts a range of data from the node.
offset
- Start offset of substring to extract.count
- The number of characters to extract.offset
and count
exceeds the
length
, then all characters to the end of the data are
returned.data
, or if the
specified count
is negative.DOMSTRING_SIZE_ERR: Raised if the specified range of text does
not fit into a String
.
public void appendData(java.lang.String arg) throws DOMException
Append the string to the end of the character data of the node.
Upon success, data
provides access to the concatenation of
data
and the String
specified.
arg
- The String
to append.public void insertData(int offset, java.lang.String arg) throws DOMException
Insert a string at the specified character offset.
offset
- The character offset at which to insert.arg
- The String
to insert.data
.NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
public void deleteData(int offset, int count) throws DOMException
Remove a range of characters from the node. Upon success,
data
and length
reflect the change.
offset
- The offset from which to remove characters.count
- The number of characters to delete. If the sum of
offset
and count
exceeds
length
then all characters from offset
to the end of the data are deleted.data
, or if the
specified count
is negative.NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
public void replaceData(int offset, int count, java.lang.String arg) throws DOMException
Replace the characters starting at the specified character offset with the specified string.
offset
- The offset from which to start replacing.count
- The number of characters to replace. If the sum of
offset
and count
exceeds
length
, then all characters to the end of the data
are replaced (i.e., the effect is the same as a
remove
method call with the same range, followed
by an append
method invocation).arg
- The String
with which the range must
be replaced.data
, or if the
specified count
is negative.NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |