模块  java.xml
软件包  org.w3c.dom

Interface CharacterData

  • All Superinterfaces:
    Node
    All Known Subinterfaces:
    CDATASection ， Comment ， Text 
    public interface CharacterDataextends Node
    CharacterData接口使用一组用于访问DOM中的字符数据的属性和方法来扩展Node。 为清楚起见，此集在此处定义，而不是在使用这些属性和方法的每个对象上定义。 没有DOM对象直接对应CharacterData ，尽管Text和其他人继承了它的接口。 此界面中的所有offsets从0开始。

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

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

    • 方法详细信息

      • getData

        String getData()        throws DOMException
        实现此接口的节点的字符数据。 DOM实现可能不会对可能存储在CharacterData节点中的数据量设置任意限制。 但是，实现限制可能意味着整个节点的数据可能不适合单个DOMString 。 在这种情况下，用户可以调用substringData以适当大小的片段检索数据。
        异常
        DOMException - DOMSTRING_SIZE_ERR：在实现平台上返回的字符多于适合 DOMString变量的字符时 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为负或大于offset中的16位单元data ，或者指定的count为负数，则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为负或大于offset中的16位单元数，则data 。
        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为负或大于offset中的16位单元data ，或者指定的count为负，则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: 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.