org.w3c.dom.CharacterData Maven / Gradle / Ivy
// Copyright (c) 1998 by W3C
//
// DOM is a trademark of W3C
// The DOM level 1 specification, from which this
// source is derived, is copyright by W3C.
// See: http://www.w3.org/TR/REC-DOM-Level-1/
//
package org.w3c.dom;
/**
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.
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
CharacterData node. However, implementation limits may
mean that the entirety of a node's data may not fit into a single
String. In such cases, the user may call
substringData to retrieve the data in appropriately sized
pieces.
length
getLength
The number of characters that
are available through data and the
substringData method below. This may have the value zero,
i.e., CharacterData nodes may be empty.
*/
public interface CharacterData
extends Node
{
/** Assigns the value of the data property.
* @exception DOMException NO_MODIFICATION_ALLOWED_ERR: Raised when the node is
readonly.
*/
void setData (String data) throws DOMException;
/**
* Returns the value of the data property.
* @exception DOMException
DOMSTRING_SIZE_ERR: Raised when it would return more
characters than fit in a String variable on the
implementation platform.
*/
String getData () throws DOMException;
/**
* Returns the value of the length property.
*/
int getLength ();
/**
Extracts a range of data from the node.
@return The specified substring. If the sum of
offset and count exceeds the
length, then all characters to the end of the data are
returned.
@param offset
Start offset of substring to extract.
@param count
The number of characters to extract.
@exception INDEX_SIZE_ERR: Raised if the specified offset is negative or
greater than the number of characters in data, or if the
specified count is negative.
DOMSTRING_SIZE_ERR: Raised if the specified range of text does
not fit into a String.
*/
String substringData (int offset, int count) 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.
@param arg
The String to append.
@exception NO_MODIFICATION_ALLOWED_ERR: Raised if this node is
readonly.
*/
void appendData (String arg) throws DOMException;
/**
Insert a string at the specified character offset.
@param offset
The character offset at which to insert.
@param arg
The String to insert.
@exception INDEX_SIZE_ERR: Raised if the specified offset is negative or
greater than the number of characters in data.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
*/
void insertData (int offset, String arg) throws DOMException;
/**
Remove a range of characters from the node. Upon success,
data and length reflect the change.
@param offset
The offset from which to remove characters.
@param 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.
@exception INDEX_SIZE_ERR: Raised if the specified offset is negative or
greater than the number of characters in data, or if the
specified count is negative.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
*/
void deleteData (int offset, int count) throws DOMException;
/**
Replace the characters starting at the specified character
offset with the specified string.
@param offset
The offset from which to start replacing.
@param 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).
@param arg
The String with which the range must
be replaced.
@exception INDEX_SIZE_ERR: Raised if the specified offset is negative or
greater than the number of characters in data, or if the
specified count is negative.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
*/
void replaceData (int offset, int count, String arg) throws DOMException;
}