模块 java.xml
包 org.w3c.dom

接口 CharacterData

所有父级接口：
Node
所有已知的子接口：
CDATASection , Comment , Text
public interface CharacterData extends Node
CharacterData 接口使用一组属性和方法扩展 Node，用于访问 DOM 中的字符数据。为清楚起见，此集合是在此处定义的，而不是在使用这些属性和方法的每个对象上定义的。没有 DOM 对象直接对应于 CharacterData ，尽管 Text 和其他对象确实继承了它的接口。该接口中的所有offsets都从0开始。

如DOMString 接口中所述，DOM 中的文本字符串以UTF-16 表示，即作为16 位单元的序列。在下文中，只要有必要，就会使用术语 16 位单元来指示对 CharacterData 的索引是以 16 位单元完成的。

另见 文档对象模型 (DOM) 级别 3 核心规范 。

  • 方法详情

    • 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 位单元的数量。这可能具有零值，即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：如果此节点是只读的则引发。