Package org.eclipse.lemminx.dom

Class DOMElement

    • Constructor Detail

      • DOMElement

        public DOMElement​(int start,
                  int end)

    • Method Detail

      • getNodeType

        public short getNodeType()
        Specified by:
        getNodeType in interface Node

      • hasTagName

        public boolean hasTagName()
        Returns true if the DOM element have a tag name and false otherwise (ex : '<' or '
        Returns:
        true if the DOM element have a tag name and false otherwise (ex : '<' or '

      • getNamespaceURI

        public String getNamespaceURI​(String prefix)
        Returns the namespace URI for the given prefix and null otherwise.
        Parameters:
        prefix - the prefix.
        Returns:
        the namespace URI for the given prefix and null otherwise.

      • getPrefix

        public String getPrefix​(String namespaceURI)
        Returns the xmlns prefix from the given namespace URI and null otherwise.
        Parameters:
        namespaceURI - the namespace
        Returns:
        the xmlns prefix from the given namespace URI and null otherwise.

      • isDocumentElement

        public boolean isDocumentElement()

      • isSelfClosed

        public boolean isSelfClosed()

      • endsWith

        public Integer endsWith​(char c,
                        int startOffset)
        Will traverse backwards from the start offset returning an offset of the given character if it's found before another character. Whitespace is ignored. Returns null if the character is not found. The initial value for the start offset is not included. So have the offset 1 position after the character you want to start at.

      • isSameTag

        public boolean isSameTag​(String tag)
        Returns true if the given tag is the same tag of this element and false otherwise.
        Parameters:
        tag - tag element
        Returns:
        true if the given tag is the same tag of this element and false otherwise.

      • isInStartTag

        public boolean isInStartTag​(int offset)

      • isInEndTag

        public boolean isInEndTag​(int offset)

      • isInEndTag

        public boolean isInEndTag​(int offset,
                          boolean afterBackSlash)

      • isInInsideStartEndTag

        public boolean isInInsideStartEndTag​(int offset)

      • getStartTagOpenOffset

        public int getStartTagOpenOffset()
        Returns the start tag open offset and DOMNode.NULL_VALUE if it doesn't exist.
        Returns:
        the start tag open offset and DOMNode.NULL_VALUE if it doesn't exist.

      • getStartTagCloseOffset

        public int getStartTagCloseOffset()
        Returns the start tag close offset and DOMNode.NULL_VALUE if it doesn't exist.
        Returns:
        the start tag close offset and DOMNode.NULL_VALUE if it doesn't exist.

      • getEndTagOpenOffset

        public int getEndTagOpenOffset()
        Returns the end tag open offset and DOMNode.NULL_VALUE if it doesn't exist.
        Returns:
        the end tag open offset and DOMNode.NULL_VALUE if it doesn't exist.

      • getEndTagCloseOffset

        public int getEndTagCloseOffset()
        Returns the end tag close offset and DOMNode.NULL_VALUE if it doesn't exist.
        Returns:
        the end tag close offset and DOMNode.NULL_VALUE if it doesn't exist.

      • hasStartTag

        public boolean hasStartTag()
        Returns true if has a start tag. In our source-oriented DOM, a lone end tag will cause a node to be created in the tree, unlike well-formed-only DOMs.
        Returns:
        true if has a start tag.

      • hasEndTag

        public boolean hasEndTag()
        Returns true if has an end tag. In our source-oriented DOM, sometimes Elements are "ended", even without an explicit end tag in the source.
        Returns:
        true if has an end tag.

      • isStartTagClosed

        public boolean isStartTagClosed()
        If '>' exists in

      • isEndTagClosed

        public boolean isEndTagClosed()
        If '>' exists in

      • getOffsetAfterStartTag

        public int getOffsetAfterStartTag()
        Returns the offset after the start tag name.
        Returns:
        the offset after the start tag name.

      • getOffsetBeforeCloseOfStartTag

        public int getOffsetBeforeCloseOfStartTag()
        Returns the offset before the close of start tag name.
        Returns:
        the offset before the close of start tag name.

      • isOrphanEndTag

        public boolean isOrphanEndTag()
        Returns true if the given element is an orphan end tag (which has no start tag, eg: ) and false otherwise.
        Returns:
        true if the given element is an orphan end tag (which has no start tag, eg: ) and false otherwise.

      • isOrphanEndTagOf

        public boolean isOrphanEndTagOf​(String tagName)
        Returns true if the given element is an orphan end tag (which has no start tag, eg: ) of the given tag name and false otherwise.
        Parameters:
        tagName - the end tag name.
        Returns:
        true if the given element is an orphan end tag (which has no start tag, eg: ) of the given tag name and false otherwise.

      • getUnclosedStartTagCloseOffset

        public int getUnclosedStartTagCloseOffset()
        Returns the offset at which the given unclosed start tag should be closed with an angle bracket

      • getOrphanEndElement

        public DOMElement getOrphanEndElement​(int offset,
                                      String tagName,
                                      boolean anyOrphan)
        Description copied from class: DOMNode
        Returns the orphan end element after the given offset which matches the given tagName and the first orphan end element otherwise and null otherwise. The following sample sample with tagName=bar will returns the <\foo> orphan end element:

        | <\foo>

        Overrides:
        getOrphanEndElement in class DOMNode
        Parameters:
        offset - the offset.
        tagName - the tag name.
        anyOrphan - true if any orphan should be returned and false otherwise.
        Returns:
        the orphan end element after the given offset which matches the given tagName and the first orphan end element otherwise and null otherwise.

      • isClosed

        public boolean isClosed()
        Returns true if element has a closing end tag (eg: ) and false otherwise (eg: ).
        Overrides:
        isClosed in class DOMNode
        Returns:
        true if element has a closing end tag (eg: ) and false otherwise (eg: ).

      • isEmpty

        public boolean isEmpty()
        Returns true if the element is empty and false otherwise.
        Returns:
        true if the element is empty and false otherwise.

      • findTextAt

        public DOMText findTextAt​(int offset)
        Returns the DOM text node from the given offset and null otherwise.
        Parameters:
        offset - the offset.
        Returns:
        the DOM text node from the given offset and null otherwise.