| org.w3c.dom.CharacterData
| CharacterData | | public interface CharacterData extends Node(Code) | | 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 3 Core Specification.
|
| Method Summary | |
| public void | appendData(String arg)
Append the string to the end of the character data of the node. | | public void | deleteData(int offset, int count)
Remove a range of 16-bit units from the node. | | public String | getData()
The character data of the node that implements this interface. | | public int | getLength()
The number of 16-bit units that are available through data
and the substringData method below. | | public void | insertData(int offset, String arg)
Insert a string at the specified 16-bit unit offset. | | public void | replaceData(int offset, int count, String arg)
Replace the characters starting at the specified 16-bit unit offset
with the specified string.
Parameters:
offset - The offset from which to start replacing.
Parameters:
count - The number of 16-bit units to replace. | | public void | setData(String data)
The character data of the node that implements this interface. | | public String | substringData(int offset, int count)
Extracts a range of data from the node.
Parameters:
offset - Start offset of substring to extract.
Parameters:
count - The number of 16-bit units to extract. |
| appendData | | public void appendData(String arg) throws DOMException(Code) | | 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:
arg - The DOMString to append.
exception:
DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. |
| deleteData | | public void deleteData(int offset, int count) throws DOMException(Code) | | Remove a range of 16-bit units from the node. Upon success,
data and length reflect the change.
Parameters:
offset - The offset from which to start removing.
Parameters:
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.
exception:
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.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. |
| getData | | public String getData() throws DOMException(Code) | | 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.
exception:
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()(Code) | | 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, String arg) throws DOMException(Code) | | Insert a string at the specified 16-bit unit offset.
Parameters:
offset - The character offset at which to insert.
Parameters:
arg - The DOMString to insert.
exception:
DOMException - INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than the number of 16-bit units in data.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. |
| replaceData | | public void replaceData(int offset, int count, String arg) throws DOMException(Code) | | Replace the characters starting at the specified 16-bit unit offset
with the specified string.
Parameters:
offset - The offset from which to start replacing.
Parameters:
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 removemethod call with the same range, followed by an appendmethod invocation).
Parameters:
arg - The DOMString with which the range must be replaced.
exception:
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.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. |
| setData | | public void setData(String data) throws DOMException(Code) | | 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.
exception:
DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly. |
| substringData | | public String substringData(int offset, int count) throws DOMException(Code) | | Extracts a range of data from the node.
Parameters:
offset - Start offset of substring to extract.
Parameters:
count - The number of 16-bit units to extract. 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.
exception:
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.
DOMSTRING_SIZE_ERR: Raised if the specified range of text does not fit into a DOMString. |
|
|