org.w3c.dom
接口 CharacterData

所有超级接口：

Node

所有已知子接口：

CDATASection, Comment, Text

public interface CharacterData
extends Node

CharacterData 接口使用属性集合和用于访问 DOM 中字符数据的方法扩展节点。为了清楚起见，在这里定义此集合，而不是在使用这些属性和方法的每个对象上定义。任何 DOM 对象都不会直接对应于 CharacterData，尽管 Text 和其他的对象是从它继承该接口的。此接口中的所有 offset 都从 0 开始。

如 DOMString 接口中所述，DOM 中的文本字符串以 UTF-16（即 16 位单元序列）表示。在下述情况下，每当需要指示以 16 位单元在 CharacterData 上进行索引时就使用术语 16 位单元。

另请参见 Document Object Model (DOM) Level 3 Core Specification。

字段摘要

从接口 org.w3c.dom.Node 继承的字段

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

方法摘要

void	appendData(String arg) 将字符串追加到节点的字符数据的结尾。
void	deleteData(int offset, int count) 从该节点移除某个范围的 16 位单元。
String	getData() 实现此接口的节点的字符数据。
int	getLength() 通过下面的 data 和 substringData 方法可使用的 16 位单元数。
void	insertData(int offset, String arg) 在指定的 16 位单元偏移量位置插入一个字符串。
void	replaceData(int offset, int count, String arg) 用指定的字符串替换从指定 16 位单元偏移量起始的字符。
void	setData(String data) 实现此接口的节点的字符数据。
String	substringData(int offset, int count) 从该节点提取某个范围的数据。

从接口 org.w3c.dom.Node 继承的方法

appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData

方法详细信息

getData

String getData()
               throws DOMException

实现此接口的节点的字符数据。DOM 实现不可以任意限制可以存储在 CharacterData 节点中的数据量。不过，实现限制可能意味着全部的节点数据不可以适合单个 DOMString。在这种情况下，用户可以调用 substringData 以适当大小的片段来检索数据。

抛出：

DOMException - DOMSTRING_SIZE_ERR:当它返回的字符多于实现平台上的 DOMString 变量中的字符时引发此异常。

setData

void setData(String data)
             throws DOMException

实现此接口的节点的字符数据。DOM 实现不可以任意限制可以存储在 CharacterData 节点中的数据量。不过，实现限制可能意味着全部的节点数据不可以适合单个 DOMString。在这种情况下，用户可以调用 substringData 以适当大小的片段来检索数据。。

抛出：

DOMException - NO_MODIFICATION_ALLOWED_ERR:节点为只读的时引发此异常。

getLength

int getLength()

通过下面的 data 和 substringData 方法可使用的 16 位单元数。此数可能是值 0，即 CharacterData 节点可以为空。

substringData

String substringData(int offset,
                     int count)
                     throws DOMException

从该节点提取某个范围的数据。

参数：

offset - 要提取的子字符串的起始偏移量。

count - 要提取的 16 位单元数。

返回：

指定的子字符串。如果 offset 和 count 的和超过 length，则返回到数据结尾处的所有 16 位单元。

抛出：

DOMException - INDEX_SIZE_ERR:如果指定 offset 为负或大于 data 中的 16 位单元数，或者如果指定 count 为负，则引发此异常。
DOMSTRING_SIZE_ERR:指定范围的文本不适合 DOMString 时引发此异常。

appendData

void appendData(String arg)
                throws DOMException

将字符串追加到节点的字符数据的结尾。如果成功，则 data 可访问 data 和指定 DOMString 的串联形式。

参数：

arg - 要追加的 DOMString。

抛出：

DOMException - NO_MODIFICATION_ALLOWED_ERR:此节点为只读的引发此异常。

insertData

void insertData(int offset,
                String arg)
                throws DOMException

在指定的 16 位单元偏移量位置插入一个字符串。

参数：

offset - 字符串偏移量，在该处插入字符串。

arg - 要插入的 DOMString。

抛出：

DOMException - INDEX_SIZE_ERR:指定 offset 为负或大于 data 中的 16 位单元数时引发此异常。
NO_MODIFICATION_ALLOWED_ERR:此节点为只读的引发此异常。

deleteData

void deleteData(int offset,
                int count)
                throws DOMException

从该节点移除某个范围的 16 位单元。如果成功，则 data 和 length 反映此更改。

参数：

offset - 偏移量，从此位置开始移除。

count - 要删除的 16 位单元数。如果 offset 和 count 的和超过 length，则删除从 offset 开始到数据结尾的所有 16 位单元。

抛出：

DOMException - INDEX_SIZE_ERR:如果指定 offset 为负或大于 data 中的 16 位单元数，或者如果指定 count 为负，则引发此异常。
NO_MODIFICATION_ALLOWED_ERR:如果此节点为只读的引发此异常。

replaceData

void replaceData(int offset,
                 int count,
                 String arg)
                 throws DOMException

用指定的字符串替换从指定 16 位单元偏移量起始的字符。

参数：

offset - 偏移量，从此位置开始替换。

count - 要替换的 16 位单元数。如果 offset 和 count 的和超过 length，则替换到数据结尾的所有 16 位单元；（即其效果与具有同样范围的 remove 方法调用相同，后跟 append 方法调用）。

arg - 必须用来替换该范围的字符的 DOMString。

抛出：

DOMException - INDEX_SIZE_ERR:如果指定 offset 为负或大于 data 中的 16 位单元数，或者如果指定 count 为负，则引发此异常。
NO_MODIFICATION_ALLOWED_ERR:如果此节点为只读的引发此异常。