org.w3c.dom
Interface CharacterData
java.lang.Object
|
+--org.w3c.dom.Node
|
+--org.w3c.dom.CharacterData
All Implemented Interfaces:
Node
public interface
CharacterDataimplements
Node 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.
appendData
public void appendData(java.lang.String arg) 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 DOMString specified.
Parameters:
Throws:
DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
deleteData
public void deleteData(int offset, int count) Remove a range of 16-bit units from the node. Upon success,
data and length reflect the change.
Parameters:
Throws:
DOMException - INDEX_SIZE_ERR: Raised if the specified offset is
negative or greater than the number of 16-bit units in
data, or if the specified count is
negative.
getData
public String getData() 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 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.
Throws:
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.
getLength
public int getLength() The number of 16-bit units that are available through data
and the substringData method below. This may have the
value zero, i.e., CharacterData nodes may be empty.
insertData
public void insertData(int offset, java.lang.String arg) Insert a string at the specified 16-bit unit offset.
Parameters:
Throws:
DOMException - INDEX_SIZE_ERR: Raised if the specified offset is
negative or greater than the number of 16-bit units in
data.
replaceData
public 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.
Parameters:
Throws:
DOMException - INDEX_SIZE_ERR: Raised if the specified offset is
negative or greater than the number of 16-bit units in
data, or if the specified count is
negative.
setData
public void setData(java.lang.String data) 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 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.
Parameters:
Throws:
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.
substringData
public String substringData(int offset, int count) Extracts a range of data from the node.
Parameters:
Returns:
- The specified substring. If the sum of
offset and
count exceeds the length, then all 16-bit
units to the end of the data are returned.
Throws:
DOMException - INDEX_SIZE_ERR: Raised if the specified offset is
negative or greater than the number of 16-bit units in
data, or if the specified count is
negative.
CharacterDatainterface 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 toCharacterData, thoughTextand others do inherit the interface from it. Alloffsetsin this interface start from0.As explained in the
DOMStringinterface, 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.