Movatterモバイル変換

Interface CharacterData

All Superinterfaces:

Node

All Known Subinterfaces:

CDATASection,Comment,Text

public interfaceCharacterData

extendsNode

TheCharacterData 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 toCharacterData, thoughText and others do inherit the interface from it. Alloffsets in this interface start from0.

As explained in theDOMString 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 theDocument Object Model (DOM) Level 2 Core Specification.

getData

public java.lang.StringgetData()                         throwsDOMException

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 aCharacterData node. However, implementation limits may mean that the entirety of a node's data may not fit into a singleDOMString. In such cases, the user may callsubstringData 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 aDOMString variable on the implementation platform.

setData

public voidsetData(java.lang.String data)             throwsDOMException

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 aCharacterData node. However, implementation limits may mean that the entirety of a node's data may not fit into a singleDOMString. In such cases, the user may callsubstringData 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 aDOMString variable on the implementation platform.

getLength

public intgetLength()

The number of 16-bit units that are available throughdata and thesubstringData method below. This may have the value zero, i.e.,CharacterData nodes may be empty.

substringData

public java.lang.StringsubstringData(int offset,                                      int count)                               throwsDOMException

Extracts a range of data from the node.

Parameters:

offset - Start offset of substring to extract.

count - The number of 16-bit units to extract.

Returns:

The specified substring. If the sum ofoffset andcount exceeds thelength, then all 16-bit units to the end of the data are returned.

Throws:

DOMException - INDEX_SIZE_ERR: Raised if the specifiedoffset is negative or greater than the number of 16-bit units indata, or if the specifiedcount is negative.
DOMSTRING_SIZE_ERR: Raised if the specified range of text does not fit into aDOMString.

appendData

public voidappendData(java.lang.String arg)                throwsDOMException

Append the string to the end of the character data of the node. Upon success,data provides access to the concatenation ofdata and theDOMString specified.

Parameters:

arg - TheDOMString to append.

Throws:

DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

insertData

public voidinsertData(int offset,                       java.lang.String arg)                throwsDOMException

Insert a string at the specified 16-bit unit offset.

Parameters:

offset - The character offset at which to insert.

arg - TheDOMString to insert.

Throws:

DOMException - INDEX_SIZE_ERR: Raised if the specifiedoffset is negative or greater than the number of 16-bit units indata.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

deleteData

public voiddeleteData(int offset,                       int count)                throwsDOMException

Remove a range of 16-bit units from the node. Upon success,data andlength reflect the change.

Parameters:

offset - The offset from which to start removing.

count - The number of 16-bit units to delete. If the sum ofoffset andcount exceedslength then all 16-bit units fromoffset to the end of the data are deleted.

Throws:

DOMException - INDEX_SIZE_ERR: Raised if the specifiedoffset is negative or greater than the number of 16-bit units indata, or if the specifiedcount is negative.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

replaceData

public voidreplaceData(int offset,                        int count,                        java.lang.String arg)                 throwsDOMException

Replace the characters starting at the specified 16-bit unit offset with the specified string.

Parameters:

offset - The offset from which to start replacing.

count - The number of 16-bit units to replace. If the sum ofoffset andcount exceedslength, then all 16-bit units to the end of the data are replaced; (i.e., the effect is the same as aremove method call with the same range, followed by anappend method invocation).

arg - TheDOMString with which the range must be replaced.

Throws:

DOMException - INDEX_SIZE_ERR: Raised if the specifiedoffset is negative or greater than the number of 16-bit units indata, or if the specifiedcount is negative.
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.