Module java.xml
Package org.w3c.dom

Interface CharacterData

所有超级接口:
Node
所有已知子接口:
CDATASection, Comment, Text
public interface CharacterData extends Node
CharacterData接口扩展了Node，具有一组用于访问DOM中字符数据的属性和方法。为了清晰起见，此集合在此处定义，而不是在每个使用这些属性和方法的对象上定义。在这个接口中，所有的offsets都从0开始。

如在DOMString接口中所解释的，DOM中的文本字符串以UTF-16表示，即作为一系列16位单元。在下文中，每当需要时使用术语16位单元来指示在CharacterData上进行索引。

另请参阅文档对象模型（DOM）Level 3 Core规范。

  • Method Details

    • 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: 当此节点是只读时引发。