Top Description Fields Methods
org.w3c.dom

public Interface CharacterData

extends Node
Known Direct Subinterfaces
org.w3c.dom.Comment, org.w3c.dom.Text
Known Direct Implementers
com.sun.org.apache.xerces.internal.dom.CommentImpl, com.sun.org.apache.xerces.internal.dom.TextImpl
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.

Since
1.4, DOM Level 2

Field Summary

Inherited from org.w3c.dom.Node:
ATTRIBUTE_NODECDATA_SECTION_NODECOMMENT_NODEDOCUMENT_FRAGMENT_NODEDOCUMENT_NODEDOCUMENT_POSITION_CONTAINED_BYDOCUMENT_POSITION_CONTAINSDOCUMENT_POSITION_DISCONNECTEDDOCUMENT_POSITION_FOLLOWINGDOCUMENT_POSITION_IMPLEMENTATION_SPECIFICDOCUMENT_POSITION_PRECEDINGDOCUMENT_TYPE_NODEELEMENT_NODEENTITY_NODEENTITY_REFERENCE_NODENOTATION_NODEPROCESSING_INSTRUCTION_NODETEXT_NODE

Method Summary

Modifier and TypeMethod and Description
public void
appendData(String
The DOMString to append.
arg)

Append the string to the end of the character data of the node.

public void
deleteData(int
The offset from which to start removing.
offset, int
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.
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
The character offset at which to insert.
offset, String
The DOMString to insert.
arg)

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

public void
replaceData(int
The offset from which to start replacing.
offset, int
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 remove method call with the same range, followed by an append method invocation).
count, String
The DOMString with which the range must be replaced.
arg)

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

public void
setData(String data)

The character data of the node that implements this interface.

public String

Returns:

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.
substringData(int
Start offset of substring to extract.
offset, int
The number of 16-bit units to extract.
count)

Extracts a range of data from the node.

Inherited from org.w3c.dom.Node:
appendChildcloneNodecompareDocumentPositiongetAttributesgetBaseURIgetChildNodesgetFeaturegetFirstChildgetLastChildgetLocalNamegetNamespaceURIgetNextSiblinggetNodeNamegetNodeTypegetNodeValuegetOwnerDocumentgetParentNodegetPrefixgetPreviousSiblinggetTextContentgetUserDatahasAttributeshasChildNodesinsertBeforeisDefaultNamespaceisEqualNodeisSameNodeisSupportedlookupNamespaceURIlookupPrefixnormalizeremoveChildreplaceChildsetNodeValuesetPrefixsetTextContentsetUserData

Method Detail

appendDataback to summary
public void appendData(String arg) 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 DOMString specified.

Parameters
arg:String

The DOMString to append.

Exceptions
DOMException:
NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
deleteDataback to summary
public void deleteData(int offset, int count) throws DOMException

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

Parameters
offset:int

The offset from which to start removing.

count:int

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.

Exceptions
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.
getDataback to summary
public String getData() throws DOMException

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.

Exceptions
DOMException:
DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform.
getLengthback to summary
public int getLength()

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.

insertDataback to summary
public void insertData(int offset, String arg) throws DOMException

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

Parameters
offset:int

The character offset at which to insert.

arg:String

The DOMString to insert.

Exceptions
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.
replaceDataback to summary
public void replaceData(int offset, int count, String arg) throws DOMException

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

Parameters
offset:int

The offset from which to start replacing.

count:int

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 remove method call with the same range, followed by an append method invocation).

arg:String

The DOMString with which the range must be replaced.

Exceptions
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.
setDataback to summary
public void setData(String data) throws DOMException

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.

Exceptions
DOMException:
NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
substringDataback to summary
public String substringData(int offset, int count) throws DOMException

Extracts a range of data from the node.

Parameters
offset:int

Start offset of substring to extract.

count:int

The number of 16-bit units to extract.

Returns:String

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.

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