|
||||||||
PREV CLASS NEXT CLASS | ||||||||
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
offsets
in this interface start from 0
.
As explained in the DOMString
interface, text strings in the
DOM are represented in UTF-16, i.e. as a sequence of 16-bit units. In the
following, the term 16-bit units is used whenever necessary to indicate that
indexing on CharacterData is done in 16-bit units.
See also the Document Object Model (DOM) Level 2 Core Specification.
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 16-bit units from the node. |
java.lang.String |
getData()
The character data of the node that implements this interface. |
int |
getLength()
The number of 16-bit units that are available through data and the
substringData method below. |
void |
insertData(int offset, java.lang.String arg)
Insert a string at the specified 16-bit unit offset. |
void |
replaceData(int offset, int count,
java.lang.String arg) Replace the characters starting at the specified 16-bit unit offset with the specified string. |
void |
setData(java.lang.String data)
|
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, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument,
getParentNode, getPrefix, getPreviousSibling,
hasAttributes, hasChildNodes,
insertBefore,
isSupported, normalize, removeChild,
replaceChild, setNodeValue,
setPrefix |
Method Detail |
public java.lang.String getData() throws DOMException
CharacterData
node. However, implementation limits may
mean that the entirety of a node's data may not fit into a single
DOMString
. In such cases, the user may call
substringData
to retrieve the data in appropriately sized
pieces.DOMString
variable on the implementation platform.public void setData(java.lang.String data) throws DOMException
public int getLength()
data
and
the substringData
method below. This may have the value zero,
i.e., CharacterData
nodes may be empty.public java.lang.String substringData(int offset, int count) throws DOMException
offset
- Start offset of substring to extract.count
- The number of 16-bit units to extract.offset
and
count
exceeds the length
, then all 16-bit units to
the end of the data are returned.offset
is negative or
greater than the number of 16-bit units in data
, or if the
specified count
is negative.DOMString
.public void appendData(java.lang.String arg) throws DOMException
data
provides access to the concatenation of
data
and the DOMString
specified.arg
- The DOMString
to append.public void insertData(int offset, java.lang.String arg) throws DOMException
offset
- The character offset at which to insert.arg
- The DOMString
to insert.offset
is negative or
greater than the number of 16-bit units in data
.public void deleteData(int offset, int count) throws DOMException
data
and length
reflect the change.offset
- The offset from which to start removing.count
- The number of 16-bit units to delete. If the sum of
offset
and count
exceeds length
then all
16-bit units from offset
to the end of the data are deleted.offset
is negative or
greater than the number of 16-bit units in data
, or if the
specified count
is negative.public void replaceData(int offset, int count, java.lang.String arg) throws DOMException
offset
- The offset from which to start replacing.count
- The number of 16-bit units to replace. If the sum of
offset
and count
exceeds length
, then
all 16-bit units 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 DOMString
with which the range must be
replaced.offset
is negative or
greater than the number of 16-bit units in data
, or if the
specified count
is negative.
|
||||||||
PREV CLASS NEXT CLASS | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 2000 W3C® (MIT, INRIA, Keio), All Rights Reserved. W3C liability, trademark, document useand software licensing rules apply. Your interactions with this site are in accordance with our public and Member privacy statements.