Methods

appendData

deleteData

getData

getLength

insertData

replaceData

setData

substringData

appendData

Appends 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.

Syntax:

public void appendData(java.lang.String arg)
               throws DOMException

Parameters:

arg - The DOMString to append.

DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is Read-only.

deleteData

Removes a range of characters from the node. Upon success, data and length reflect the change.

Syntax:

public void deleteData(int offset, int count)
               throws DOMException

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.

DOMException - 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 Read-only.

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.

Syntax:

public java.lang.String getData()
               throws DOMException

Throws:

DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is Read-only.

DOMException - DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform.

getLength

The number of characters that are available through data and the substringData method below. This may have the value zero, that is, the CharacterData nodes may be empty.

Syntax:

public int getLength()

insertData

Inserts a string at the specified character offset.

Syntax:

public void insertData(int offset, java.lang.String arg)
               throws DOMException

Parameters:

offset - The character offset at which to insert.

arg - The DOMString to insert.

DOMException - 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 Read-only.

replaceData

Replaces the characters starting at the specified character offset with the specified string.

Syntax:

public void replaceData(int offset, int count, java.lang.String arg)
                throws DOMException

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.

DOMException - 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 Read-only.

setData

Syntax:

public void setData(java.lang.String data)
            throws DOMException

substringData

Extracts a range of data from the node.

Syntax:

public java.lang.String substringData(int offset, int count)
                  throws DOMException

Parameters:

offset - Start offset of substring to extract.

count - The number of characters to extract.

The specified substring. If the sum of offset and count exceeds the length, then all characters to the end of the data are returned.

DOMException - 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 DOMString.

Glossary