Package net.sf.saxon.dom

Class TextOverNodeInfo

    • Constructor Detail

      • TextOverNodeInfo

        public TextOverNodeInfo()

    • Method Detail

      • getData

        public String getData()
        Get the character data of a Text or Comment node. DOM method.
        Specified by:
        getData in interface CharacterData

      • getLength

        public int getLength()
        Get the length of a Text or Comment node. DOM method.
        Specified by:
        getLength in interface CharacterData

      • substringData

        public String substringData​(int offset,
                            int count)
                     throws DOMException
        Extract a range of data from a Text or Comment node. DOM method.
        Specified by:
        substringData in interface CharacterData
        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 - 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.

      • appendData

        public void appendData​(String arg)
                throws DOMException
        Append the string to the end of the character data of the node. DOM method: always fails.
        Specified by:
        appendData in interface CharacterData
        Parameters:
        arg - The DOMString to append.
        Throws:
        DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

      • replaceData

        public void replaceData​(int offset,
                        int count,
                        String arg)
                 throws DOMException
        Replace the characters starting at the specified 16-bit unit offset with the specified string. DOM method: always fails.
        Specified by:
        replaceData in interface CharacterData
        Parameters:
        offset - The offset from which to start replacing.
        count - The number of 16-bit units to replace.
        arg - The DOMString with which the range must be replaced.
        Throws:
        DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.

      • splitText

        public Text splitText​(int offset)
               throws DOMException
        Break this node into two nodes at the specified offset, keeping both in the tree as siblings. DOM method, always fails.
        Specified by:
        splitText in interface Text
        Parameters:
        offset - The 16-bit unit offset at which to split, starting from 0.
        Returns:
        The new node, of the same type as this node.
        Throws:
        DOMException - always (the DOM is read-only)

      • replaceWholeText

        public Text replaceWholeText​(String content)
                      throws DOMException
        Replaces the text of the current node and all logically-adjacent text nodes with the specified text. All logically-adjacent text nodes are removed including the current node unless it was the recipient of the replacement text.
        This method returns the node which received the replacement text. The returned node is:
        • null, when the replacement text is the empty string;
        • the current node, except when the current node is read-only;
        • a new Text node of the same type ( Text or CDATASection) as the current node inserted at the location of the replacement.

        For instance, in the above example calling replaceWholeText on the Text node that contains "bar" with "yo" in argument results in the following:
        Where the nodes to be removed are read-only descendants of an EntityReference, the EntityReference must be removed instead of the read-only nodes. If any EntityReference to be removed has descendants that are not EntityReference, Text, or CDATASection nodes, the replaceWholeText method must fail before performing any modification of the document, raising a DOMException with the code NO_MODIFICATION_ALLOWED_ERR.
        For instance, in the example below calling replaceWholeText on the Text node that contains "bar" fails, because the EntityReference node "ent" contains an Element node which cannot be removed.
        Specified by:
        replaceWholeText in interface Text
        Parameters:
        content - The content of the replacing Text node.
        Returns:
        The Text node created with the specified content.
        Throws:
        DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if one of the Text nodes being replaced is readonly.
        Since:
        DOM Level 3

      • isElementContentWhitespace

        public boolean isElementContentWhitespace()
        Returns whether this text node contains element content whitespace, often abusively called "ignorable whitespace". The text node is determined to contain whitespace in element content during the load of the document or if validation occurs while using Document.normalizeDocument().
        Specified by:
        isElementContentWhitespace in interface Text
        Since:
        DOM Level 3

      • getWholeText

        public String getWholeText()
        Returns all text of Text nodes logically-adjacent text nodes to this node, concatenated in document order.
        For instance, in the example below wholeText on the Text node that contains "bar" returns "barfoo", while on the Text node that contains "foo" it returns "barfoo".
        Specified by:
        getWholeText in interface Text
        Since:
        DOM Level 3