org.kde.koala
public class CharacterData extends Node
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.UNKNOWN: The CharacterData
interface extends Node with a set of attributes and methods for accessing character data in the DOM.
Constructor Summary | |
---|---|
protected | CharacterData(Class dummy) |
CharacterData() | |
CharacterData(CharacterData other) | |
CharacterData(Node other) |
Method Summary | |
---|---|
void | appendData(String arg)
Append the string to the end of the character data of the node.
|
String | data()
The character data of the node that implements this interface.
|
void | deleteData(long offset, long count)
Remove a range of characters from the node. |
void | insertData(long offset, String arg)
Insert a string at the specified character offset. |
long | length()
The number of characters that are available through data
and the substringData method below. |
void | replaceData(long offset, long count, String arg)
Replace the characters starting at the specified character
offset with the specified string. |
void | setData(String arg1)
see data |
String | substringData(long offset, long count)
Extracts a range of data from the node. |
data
provides access to the
concatenation of data
and the DOMString
specified.Parameters: arg The DOMString
to append.
UNKNOWN: Append the string to the end of the character data of the node.
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.UNKNOWN: The character data of the node that implements this interface.
data
and length
reflect the
change.Parameters: 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.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
UNKNOWN: Remove a range of characters from the node.
Parameters: offset The character offset at which to insert. arg The DOMString
to insert.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
UNKNOWN: Insert a string at the specified character offset.
data
and the substringData
method below. This
may have the value zero, i.e., CharacterData
nodes may be empty.UNKNOWN: The number of characters that are available through data
and the substringData
method below.
Parameters: 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 DOMString
with which the range
must be replaced.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
UNKNOWN: Replace the characters starting at the specified character offset with the specified string.
UNKNOWN: see data
Parameters: offset Start offset of substring to extract. count The number of characters to extract.
DOMSTRING_SIZE_ERR: Raised if the specified range of text does
not fit into a DOMString
.
Returns: The specified substring. If the sum of offset
and count
exceeds the length
, then all characters to the end of the data are
returned.
UNKNOWN: Extracts a range of data from the node.