org.w3c.dom
Interface CharacterData

All Superinterfaces:
Node sample code for org.w3c.dom.Node definition code for org.w3c.dom.Node
All Known Subinterfaces:
CDATASection sample code for org.w3c.dom.CDATASection definition code for org.w3c.dom.CDATASection , Comment sample code for org.w3c.dom.Comment definition code for org.w3c.dom.Comment , Text sample code for org.w3c.dom.Text definition code for org.w3c.dom.Text

public interface CharacterData
extends Node sample code for org.w3c.dom.Node definition code for org.w3c.dom.Node

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.


Field Summary
 
Fields inherited from interface org.w3c.dom.Node sample code for org.w3c.dom.Node definition code for org.w3c.dom.Node
ATTRIBUTE_NODE sample code for org.w3c.dom.Node.ATTRIBUTE_NODE definition code for org.w3c.dom.Node.ATTRIBUTE_NODE , CDATA_SECTION_NODE sample code for org.w3c.dom.Node.CDATA_SECTION_NODE definition code for org.w3c.dom.Node.CDATA_SECTION_NODE , COMMENT_NODE sample code for org.w3c.dom.Node.COMMENT_NODE definition code for org.w3c.dom.Node.COMMENT_NODE , DOCUMENT_FRAGMENT_NODE sample code for org.w3c.dom.Node.DOCUMENT_FRAGMENT_NODE definition code for org.w3c.dom.Node.DOCUMENT_FRAGMENT_NODE , DOCUMENT_NODE sample code for org.w3c.dom.Node.DOCUMENT_NODE definition code for org.w3c.dom.Node.DOCUMENT_NODE , DOCUMENT_POSITION_CONTAINED_BY sample code for org.w3c.dom.Node.DOCUMENT_POSITION_CONTAINED_BY definition code for org.w3c.dom.Node.DOCUMENT_POSITION_CONTAINED_BY , DOCUMENT_POSITION_CONTAINS sample code for org.w3c.dom.Node.DOCUMENT_POSITION_CONTAINS definition code for org.w3c.dom.Node.DOCUMENT_POSITION_CONTAINS , DOCUMENT_POSITION_DISCONNECTED sample code for org.w3c.dom.Node.DOCUMENT_POSITION_DISCONNECTED definition code for org.w3c.dom.Node.DOCUMENT_POSITION_DISCONNECTED , DOCUMENT_POSITION_FOLLOWING sample code for org.w3c.dom.Node.DOCUMENT_POSITION_FOLLOWING definition code for org.w3c.dom.Node.DOCUMENT_POSITION_FOLLOWING , DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC sample code for org.w3c.dom.Node.DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC definition code for org.w3c.dom.Node.DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC , DOCUMENT_POSITION_PRECEDING sample code for org.w3c.dom.Node.DOCUMENT_POSITION_PRECEDING definition code for org.w3c.dom.Node.DOCUMENT_POSITION_PRECEDING , DOCUMENT_TYPE_NODE sample code for org.w3c.dom.Node.DOCUMENT_TYPE_NODE definition code for org.w3c.dom.Node.DOCUMENT_TYPE_NODE , ELEMENT_NODE sample code for org.w3c.dom.Node.ELEMENT_NODE definition code for org.w3c.dom.Node.ELEMENT_NODE , ENTITY_NODE sample code for org.w3c.dom.Node.ENTITY_NODE definition code for org.w3c.dom.Node.ENTITY_NODE , ENTITY_REFERENCE_NODE sample code for org.w3c.dom.Node.ENTITY_REFERENCE_NODE definition code for org.w3c.dom.Node.ENTITY_REFERENCE_NODE , NOTATION_NODE sample code for org.w3c.dom.Node.NOTATION_NODE definition code for org.w3c.dom.Node.NOTATION_NODE , PROCESSING_INSTRUCTION_NODE sample code for org.w3c.dom.Node.PROCESSING_INSTRUCTION_NODE definition code for org.w3c.dom.Node.PROCESSING_INSTRUCTION_NODE , TEXT_NODE sample code for org.w3c.dom.Node.TEXT_NODE definition code for org.w3c.dom.Node.TEXT_NODE
 
Method Summary
 void appendData sample code for org.w3c.dom.CharacterData.appendData(java.lang.String) definition code for org.w3c.dom.CharacterData.appendData(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  arg)
          Append the string to the end of the character data of the node.
 void deleteData sample code for org.w3c.dom.CharacterData.deleteData(int, int) definition code for org.w3c.dom.CharacterData.deleteData(int, int) (int offset, int count)
          Remove a range of 16-bit units from the node.
 String sample code for java.lang.String definition code for java.lang.String getData sample code for org.w3c.dom.CharacterData.getData() definition code for org.w3c.dom.CharacterData.getData() ()
          The character data of the node that implements this interface.
 int getLength sample code for org.w3c.dom.CharacterData.getLength() definition code for org.w3c.dom.CharacterData.getLength() ()
          The number of 16-bit units that are available through data and the substringData method below.
 void insertData sample code for org.w3c.dom.CharacterData.insertData(int, java.lang.String) definition code for org.w3c.dom.CharacterData.insertData(int, java.lang.String) (int offset, String sample code for java.lang.String definition code for java.lang.String  arg)
          Insert a string at the specified 16-bit unit offset.
 void replaceData sample code for org.w3c.dom.CharacterData.replaceData(int, int, java.lang.String) definition code for org.w3c.dom.CharacterData.replaceData(int, int, java.lang.String) (int offset, int count, String sample code for java.lang.String definition code for java.lang.String  arg)
          Replace the characters starting at the specified 16-bit unit offset with the specified string.
 void setData sample code for org.w3c.dom.CharacterData.setData(java.lang.String) definition code for org.w3c.dom.CharacterData.setData(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  data)
          The character data of the node that implements this interface.
 String sample code for java.lang.String definition code for java.lang.String substringData sample code for org.w3c.dom.CharacterData.substringData(int, int) definition code for org.w3c.dom.CharacterData.substringData(int, int) (int offset, int count)
          Extracts a range of data from the node.
 
Methods inherited from interface org.w3c.dom.Node sample code for org.w3c.dom.Node definition code for org.w3c.dom.Node
appendChild sample code for org.w3c.dom.Node.appendChild(org.w3c.dom.Node) definition code for org.w3c.dom.Node.appendChild(org.w3c.dom.Node) , cloneNode sample code for org.w3c.dom.Node.cloneNode(boolean) definition code for org.w3c.dom.Node.cloneNode(boolean) , compareDocumentPosition sample code for org.w3c.dom.Node.compareDocumentPosition(org.w3c.dom.Node) definition code for org.w3c.dom.Node.compareDocumentPosition(org.w3c.dom.Node) , getAttributes sample code for org.w3c.dom.Node.getAttributes() definition code for org.w3c.dom.Node.getAttributes() , getBaseURI sample code for org.w3c.dom.Node.getBaseURI() definition code for org.w3c.dom.Node.getBaseURI() , getChildNodes sample code for org.w3c.dom.Node.getChildNodes() definition code for org.w3c.dom.Node.getChildNodes() , getFeature sample code for org.w3c.dom.Node.getFeature(java.lang.String, java.lang.String) definition code for org.w3c.dom.Node.getFeature(java.lang.String, java.lang.String) , getFirstChild sample code for org.w3c.dom.Node.getFirstChild() definition code for org.w3c.dom.Node.getFirstChild() , getLastChild sample code for org.w3c.dom.Node.getLastChild() definition code for org.w3c.dom.Node.getLastChild() , getLocalName sample code for org.w3c.dom.Node.getLocalName() definition code for org.w3c.dom.Node.getLocalName() , getNamespaceURI sample code for org.w3c.dom.Node.getNamespaceURI() definition code for org.w3c.dom.Node.getNamespaceURI() , getNextSibling sample code for org.w3c.dom.Node.getNextSibling() definition code for org.w3c.dom.Node.getNextSibling() , getNodeName sample code for org.w3c.dom.Node.getNodeName() definition code for org.w3c.dom.Node.getNodeName() , getNodeType sample code for org.w3c.dom.Node.getNodeType() definition code for org.w3c.dom.Node.getNodeType() , getNodeValue sample code for org.w3c.dom.Node.getNodeValue() definition code for org.w3c.dom.Node.getNodeValue() , getOwnerDocument sample code for org.w3c.dom.Node.getOwnerDocument() definition code for org.w3c.dom.Node.getOwnerDocument() , getParentNode sample code for org.w3c.dom.Node.getParentNode() definition code for org.w3c.dom.Node.getParentNode() , getPrefix sample code for org.w3c.dom.Node.getPrefix() definition code for org.w3c.dom.Node.getPrefix() , getPreviousSibling sample code for org.w3c.dom.Node.getPreviousSibling() definition code for org.w3c.dom.Node.getPreviousSibling() , getTextContent sample code for org.w3c.dom.Node.getTextContent() definition code for org.w3c.dom.Node.getTextContent() , getUserData sample code for org.w3c.dom.Node.getUserData(java.lang.String) definition code for org.w3c.dom.Node.getUserData(java.lang.String) , hasAttributes sample code for org.w3c.dom.Node.hasAttributes() definition code for org.w3c.dom.Node.hasAttributes() , hasChildNodes sample code for org.w3c.dom.Node.hasChildNodes() definition code for org.w3c.dom.Node.hasChildNodes() , insertBefore sample code for org.w3c.dom.Node.insertBefore(org.w3c.dom.Node, org.w3c.dom.Node) definition code for org.w3c.dom.Node.insertBefore(org.w3c.dom.Node, org.w3c.dom.Node) , isDefaultNamespace sample code for org.w3c.dom.Node.isDefaultNamespace(java.lang.String) definition code for org.w3c.dom.Node.isDefaultNamespace(java.lang.String) , isEqualNode sample code for org.w3c.dom.Node.isEqualNode(org.w3c.dom.Node) definition code for org.w3c.dom.Node.isEqualNode(org.w3c.dom.Node) , isSameNode sample code for org.w3c.dom.Node.isSameNode(org.w3c.dom.Node) definition code for org.w3c.dom.Node.isSameNode(org.w3c.dom.Node) , isSupported sample code for org.w3c.dom.Node.isSupported(java.lang.String, java.lang.String) definition code for org.w3c.dom.Node.isSupported(java.lang.String, java.lang.String) , lookupNamespaceURI sample code for org.w3c.dom.Node.lookupNamespaceURI(java.lang.String) definition code for org.w3c.dom.Node.lookupNamespaceURI(java.lang.String) , lookupPrefix sample code for org.w3c.dom.Node.lookupPrefix(java.lang.String) definition code for org.w3c.dom.Node.lookupPrefix(java.lang.String) , normalize sample code for org.w3c.dom.Node.normalize() definition code for org.w3c.dom.Node.normalize() , removeChild sample code for org.w3c.dom.Node.removeChild(org.w3c.dom.Node) definition code for org.w3c.dom.Node.removeChild(org.w3c.dom.Node) , replaceChild sample code for org.w3c.dom.Node.replaceChild(org.w3c.dom.Node, org.w3c.dom.Node) definition code for org.w3c.dom.Node.replaceChild(org.w3c.dom.Node, org.w3c.dom.Node) , setNodeValue sample code for org.w3c.dom.Node.setNodeValue(java.lang.String) definition code for org.w3c.dom.Node.setNodeValue(java.lang.String) , setPrefix sample code for org.w3c.dom.Node.setPrefix(java.lang.String) definition code for org.w3c.dom.Node.setPrefix(java.lang.String) , setTextContent sample code for org.w3c.dom.Node.setTextContent(java.lang.String) definition code for org.w3c.dom.Node.setTextContent(java.lang.String) , setUserData sample code for org.w3c.dom.Node.setUserData(java.lang.String, java.lang.Object, org.w3c.dom.UserDataHandler) definition code for org.w3c.dom.Node.setUserData(java.lang.String, java.lang.Object, org.w3c.dom.UserDataHandler)
 

Method Detail

getData sample code for org.w3c.dom.CharacterData.getData() definition code for org.w3c.dom.CharacterData.getData()

String sample code for java.lang.String definition code for java.lang.String  getData()
               throws DOMException sample code for org.w3c.dom.DOMException definition code for org.w3c.dom.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.

Throws:
DOMException sample code for org.w3c.dom.DOMException definition code for org.w3c.dom.DOMException - DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform.

setData sample code for org.w3c.dom.CharacterData.setData(java.lang.String) definition code for org.w3c.dom.CharacterData.setData(java.lang.String)

void setData(String sample code for java.lang.String definition code for java.lang.String  data)
             throws DOMException sample code for org.w3c.dom.DOMException definition code for org.w3c.dom.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.

Throws:
DOMException sample code for org.w3c.dom.DOMException definition code for org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.

getLength sample code for org.w3c.dom.CharacterData.getLength() definition code for org.w3c.dom.CharacterData.getLength()

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.


substringData sample code for org.w3c.dom.CharacterData.substringData(int, int) definition code for org.w3c.dom.CharacterData.substringData(int, int)

String sample code for java.lang.String definition code for java.lang.String  substringData(int offset,
                     int count)
                     throws DOMException sample code for org.w3c.dom.DOMException definition code for org.w3c.dom.DOMException 
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 of offset and count exceeds the length, then all 16-bit units to the end of the data are returned.
Throws:
DOMException sample code for org.w3c.dom.DOMException definition code for org.w3c.dom.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.

appendData sample code for org.w3c.dom.CharacterData.appendData(java.lang.String) definition code for org.w3c.dom.CharacterData.appendData(java.lang.String)

void appendData(String sample code for java.lang.String definition code for java.lang.String  arg)
                throws DOMException sample code for org.w3c.dom.DOMException definition code for org.w3c.dom.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 - The DOMString to append.
Throws:
DOMException sample code for org.w3c.dom.DOMException definition code for org.w3c.dom.DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

insertData sample code for org.w3c.dom.CharacterData.insertData(int, java.lang.String) definition code for org.w3c.dom.CharacterData.insertData(int, java.lang.String)

void insertData(int offset,
                String sample code for java.lang.String definition code for java.lang.String  arg)
                throws DOMException sample code for org.w3c.dom.DOMException definition code for org.w3c.dom.DOMException 
Insert a string at the specified 16-bit unit offset.

Parameters:
offset - The character offset at which to insert.
arg - The DOMString to insert.
Throws:
DOMException sample code for org.w3c.dom.DOMException definition code for org.w3c.dom.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.

deleteData sample code for org.w3c.dom.CharacterData.deleteData(int, int) definition code for org.w3c.dom.CharacterData.deleteData(int, int)

void deleteData(int offset,
                int count)
                throws DOMException sample code for org.w3c.dom.DOMException definition code for org.w3c.dom.DOMException 
Remove a range of 16-bit units from the node. Upon success, data and length reflect the change.

Parameters:
offset - The offset from which to start removing.
count - 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.
Throws:
DOMException sample code for org.w3c.dom.DOMException definition code for org.w3c.dom.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.

replaceData sample code for org.w3c.dom.CharacterData.replaceData(int, int, java.lang.String) definition code for org.w3c.dom.CharacterData.replaceData(int, int, java.lang.String)

void replaceData(int offset,
                 int count,
                 String sample code for java.lang.String definition code for java.lang.String  arg)
                 throws DOMException sample code for org.w3c.dom.DOMException definition code for org.w3c.dom.DOMException 
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 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 - The DOMString with which the range must be replaced.
Throws:
DOMException sample code for org.w3c.dom.DOMException definition code for org.w3c.dom.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.