Package com.itextpdf.styledxmlparser.jsoup.nodes

Class Element

  • All Implemented Interfaces:
    java.lang.Cloneable
    Direct Known Subclasses:
    Document, FormElement, PseudoTextElement
    public class Element
extends Node
    A HTML element consists of a tag name, attributes, and child nodes (including text nodes and other elements). From an Element, you can extract data, traverse the node graph, and manipulate the HTML.

    • Field Detail

      • EmptyChildren

        private static final java.util.List<Element> EmptyChildren

      • ClassSplit

        private static final java.util.regex.Pattern ClassSplit

      • BaseUriKey

        private static final java.lang.String BaseUriKey

      • tag

        private Tag tag

      • shadowChildrenRef

        private java.lang.ref.WeakReference<java.util.List<Element>> shadowChildrenRef

      • childNodes

        java.util.List<Node> childNodes

    • Constructor Detail

      • Element

        public Element​(java.lang.String tag)
        Create a new, standalone element.
        Parameters:
        tag - tag name

      • Element

        public Element​(Tag tag,
               java.lang.String baseUri,
               Attributes attributes)
        Create a new, standalone Element. (Standalone in that is has no parent.)
        Parameters:
        tag - tag of this element
        baseUri - the base URI (optional, may be null to inherit from parent, or "" to clear parent's)
        attributes - initial attributes (optional, may be null)
        See Also:
        appendChild(Node), appendElement(String)

      • Element

        public Element​(Tag tag,
               java.lang.String baseUri)
        Create a new Element from a Tag and a base URI.
        Parameters:
        tag - element tag
        baseUri - the base URI of this element. Optional, and will inherit from its parent, if any.
        See Also:
        Tag.valueOf(String, ParseSettings)

    • Method Detail

      • hasChildNodes

        protected boolean hasChildNodes()
        Internal test to check if a nodelist object has been created.

      • hasAttributes

        protected boolean hasAttributes()
        Description copied from class: Node
        Check if this Node has an actual Attributes object.
        Specified by:
        hasAttributes in class Node

      • attributes

        public Attributes attributes()
        Description copied from class: Node
        Get all of the element's attributes.
        Specified by:
        attributes in class Node
        Returns:
        attributes (which implements iterable, in same order as presented in original HTML).

      • baseUri

        public java.lang.String baseUri()
        Description copied from class: Node
        Get the base URI that applies to this node. Will return an empty string if not defined. Used to make relative links absolute.
        Specified by:
        baseUri in class Node
        Returns:
        base URI
        See Also:
        Node.absUrl(java.lang.String)

      • searchUpForAttribute

        private static java.lang.String searchUpForAttribute​(Element start,
                                                     java.lang.String key)

      • doSetBaseUri

        protected void doSetBaseUri​(java.lang.String baseUri)
        Description copied from class: Node
        Set the baseUri for just this node (not its descendants), if this Node tracks base URIs.
        Specified by:
        doSetBaseUri in class Node
        Parameters:
        baseUri - new URI

      • childNodeSize

        public int childNodeSize()
        Description copied from class: Node
        Get the number of child nodes that this node holds.
        Specified by:
        childNodeSize in class Node
        Returns:
        the number of child nodes that this node holds.

      • nodeName

        public java.lang.String nodeName()
        Description copied from class: Node
        Get the node name of this node. Use for debugging purposes and not logic switching (for that, use instanceof).
        Specified by:
        nodeName in class Node
        Returns:
        node name

      • tagName

        public java.lang.String tagName()
        Get the name of the tag for this element. E.g. div. If you are using case preserving parsing, this will return the source's original case.
        Returns:
        the tag name

      • normalName

        public java.lang.String normalName()
        Get the normalized name of this Element's tag. This will always be the lowercased version of the tag, regardless of the tag case preserving setting of the parser. For e.g., <DIV> and <div> both have a normal name of div.
        Returns:
        normal name

      • tagName

        public Element tagName​(java.lang.String tagName)
        Change (rename) the tag of this element. For example, convert a <span> to a <div> with el.tagName("div");.
        Parameters:
        tagName - new tag name for this element
        Returns:
        this element, for chaining
        See Also:
        Elements.tagName(String)

      • tag

        public Tag tag()
        Get the Tag for this element.
        Returns:
        the tag object

      • isBlock

        public boolean isBlock()
        Test if this element is a block-level element. (E.g. <div> == true or an inline element <span> == false).
        Returns:
        true if block, false if not (and thus inline)

      • id

        public java.lang.String id()
        Get the id attribute of this element.
        Returns:
        The id attribute, if present, or an empty string if not.

      • id

        public Element id​(java.lang.String id)
        Set the id attribute of this element.
        Parameters:
        id - the ID value to use
        Returns:
        this Element, for chaining

      • attr

        public Node attr​(java.lang.String attributeKey,
                 java.lang.String attributeValue)
        Set an attribute value on this element. If this element already has an attribute with the key, its value is updated; otherwise, a new attribute is added.
        Overrides:
        attr in class Node
        Parameters:
        attributeKey - The attribute key.
        attributeValue - The attribute value.
        Returns:
        this element

      • attr

        public Element attr​(java.lang.String attributeKey,
                    boolean attributeValue)
        Set a boolean attribute value on this element. Setting to true sets the attribute value to "" and marks the attribute as boolean so no value is written out. Setting to false removes the attribute with the same key if it exists.
        Parameters:
        attributeKey - the attribute key
        attributeValue - the attribute value
        Returns:
        this element

      • dataset

        public java.util.Map<java.lang.String,​java.lang.String> dataset()
        Get this element's HTML5 custom data attributes. Each attribute in the element that has a key starting with "data-" is included the dataset.

        E.g., the element <div data-package="jsoup" data-language="Java" class="group">... has the dataset package=jsoup, language=java.

        This map is a filtered view of the element's attribute map. Changes to one map (add, remove, update) are reflected in the other map.

        You can find elements that have data attributes using the [^data-] attribute key prefix selector.

        Returns:
        a map of key=value custom data attributes.

      • parent

        public final Node parent()
        Description copied from class: Node
        Gets this node's parent node.
        Overrides:
        parent in class Node
        Returns:
        parent node; or null if no parent.
        See Also:
        Node.hasParent()

      • parents

        public Elements parents()
        Get this element's parent and ancestors, up to the document root.
        Returns:
        this element's stack of parents, closest first.

      • accumulateParents

        private static void accumulateParents​(Element el,
                                      Elements parents)

      • child

        public Element child​(int index)
        Get a child element of this element, by its 0-based index number.

        Note that an element can have both mixed Nodes and Elements as children. This method inspects a filtered list of children that are elements, and the index is based on that filtered list.

        Parameters:
        index - the index number of the element to retrieve
        Returns:
        the child element, if it exists, otherwise throws an IndexOutOfBoundsException
        See Also:
        Node.childNode(int)

      • childrenSize

        public int childrenSize()
        Get the number of child nodes of this element that are elements.

        This method works on the same filtered list like child(int). Use Node.childNodes() and childNodeSize() to get the unfiltered Nodes (e.g. includes TextNodes etc.)

        Returns:
        the number of child nodes that are elements
        See Also:
        children(), child(int)

      • children

        public Elements children()
        Get this element's child elements.

        This is effectively a filter on Node.childNodes() to get Element nodes.

        Returns:
        child elements. If this element has no children, returns an empty list.
        See Also:
        Node.childNodes()

      • childElementsList

        java.util.List<Element> childElementsList()
        Maintains a shadow copy of this element's child elements. If the nodelist is changed, this cache is invalidated.
        Returns:
        a list of child elements

      • nodelistChanged

        void nodelistChanged()
        Clears the cached shadow child elements.
        Overrides:
        nodelistChanged in class Node

      • textNodes

        public java.util.List<TextNode> textNodes()
        Get this element's child text nodes. The list is unmodifiable but the text nodes may be manipulated.

        This is effectively a filter on Node.childNodes() to get Text nodes.

        Returns:
        child text nodes. If this element has no text nodes, returns an empty list.

        For example, with the input HTML: <p>One <span>Two</span> Three <br> Four</p> with the p element selected:

        • p.text() = "One Two Three Four"
        • p.ownText() = "One Three Four"
        • p.children() = Elements[<span>, <br>]
        • p.childNodes() = List<Node>["One ", <span>, " Three ", <br>, " Four"]
        • p.textNodes() = List<TextNode>["One ", " Three ", " Four"]

      • dataNodes

        public java.util.List<DataNode> dataNodes()
        Get this element's child data nodes. The list is unmodifiable but the data nodes may be manipulated.

        This is effectively a filter on Node.childNodes() to get Data nodes.

        Returns:
        child data nodes. If this element has no data nodes, returns an empty list.
        See Also:
        data()

      • select

        public Elements select​(java.lang.String cssQuery)
        Find elements that match the Selector CSS query, with this element as the starting context. Matched elements may include this element, or any of its children.

        This method is generally more powerful to use than the DOM-type getElementBy* methods, because multiple filters can be combined, e.g.:

        • el.select("a[href]") - finds links (a tags with href attributes)
        • el.select("a[href*=example.com]") - finds links pointing to example.com (loosely)

        See the query syntax documentation in Selector.

        Also known as querySelectorAll() in the Web DOM.

        Parameters:
        cssQuery - a Selector CSS-like query
        Returns:
        an Elements list containing elements that match the query (empty if none match)
        Throws:
        Selector.SelectorParseException - (unchecked) on an invalid CSS query.
        See Also:
        selector query syntax, QueryParser.parse(String)

      • select

        public Elements select​(Evaluator evaluator)
        Find elements that match the supplied Evaluator. This has the same functionality as select(String), but may be useful if you are running the same query many times (on many documents) and want to save the overhead of repeatedly parsing the CSS query.
        Parameters:
        evaluator - an element evaluator
        Returns:
        an Elements list containing elements that match the query (empty if none match)

      • selectFirst

        public Element selectFirst​(java.lang.String cssQuery)
        Find the first Element that matches the Selector CSS query, with this element as the starting context.

        This is effectively the same as calling element.select(query).first(), but is more efficient as query execution stops on the first hit.

        Also known as querySelector() in the Web DOM.

        Parameters:
        cssQuery - cssQuery a Selector CSS-like query
        Returns:
        the first matching element, or null if there is no match.

      • selectFirst

        public Element selectFirst​(Evaluator evaluator)
        Finds the first Element that matches the supplied Evaluator, with this element as the starting context, or null if none match.
        Parameters:
        evaluator - an element evaluator
        Returns:
        the first matching element (walking down the tree, starting from this element), or null if none matchn.

      • is

        public boolean is​(java.lang.String cssQuery)
        Checks if this element matches the given Selector CSS query. Also knows as matches() in the Web DOM.
        Parameters:
        cssQuery - a Selector CSS query
        Returns:
        if this element matches the query

      • is

        public boolean is​(Evaluator evaluator)
        Check if this element matches the given evaluator.
        Parameters:
        evaluator - an element evaluator
        Returns:
        if this element matches

      • closest

        public Element closest​(java.lang.String cssQuery)
        Find the closest element up the tree of parents that matches the specified CSS query. Will return itself, an ancestor, or null if there is no such matching element.
        Parameters:
        cssQuery - a Selector CSS query
        Returns:
        the closest ancestor element (possibly itself) that matches the provided evaluator. null if not found.

      • closest

        public Element closest​(Evaluator evaluator)
        Find the closest element up the tree of parents that matches the specified evaluator. Will return itself, an ancestor, or null if there is no such matching element.
        Parameters:
        evaluator - a query evaluator
        Returns:
        the closest ancestor element (possibly itself) that matches the provided evaluator. null if not found.

      • appendChildren

        public Element appendChildren​(java.util.Collection<? extends Node> children)
        Insert the given nodes to the end of this Element's children.
        Parameters:
        children - nodes to add
        Returns:
        this Element, for chaining
        See Also:
        insertChildren(int, Collection)

      • appendTo

        public Element appendTo​(Element parent)
        Add this element to the supplied parent element, as its next child.
        Parameters:
        parent - element to which this element will be appended
        Returns:
        this element, so that you can continue modifying the element

      • prependChild

        public Element prependChild​(Node child)
        Add a node to the start of this element's children.
        Parameters:
        child - node to add.
        Returns:
        this element, so that you can add more child nodes or elements.

      • prependChildren

        public Element prependChildren​(java.util.Collection<? extends Node> children)
        Insert the given nodes to the start of this Element's children.
        Parameters:
        children - nodes to add
        Returns:
        this Element, for chaining
        See Also:
        insertChildren(int, Collection)

      • insertChildren

        public Element insertChildren​(int index,
                              java.util.Collection<? extends Node> children)
        Inserts the given child nodes into this element at the specified index. Current nodes will be shifted to the right. The inserted nodes will be moved from their current parent. To prevent moving, copy the nodes first.
        Parameters:
        index - 0-based index to insert children at. Specify 0 to insert at the start, -1 at the end
        children - child nodes to insert
        Returns:
        this element, for chaining.

      • insertChildren

        public Element insertChildren​(int index,
                              Node... children)
        Inserts the given child nodes into this element at the specified index. Current nodes will be shifted to the right. The inserted nodes will be moved from their current parent. To prevent moving, copy the nodes first.
        Parameters:
        index - 0-based index to insert children at. Specify 0 to insert at the start, -1 at the end
        children - child nodes to insert
        Returns:
        this element, for chaining.

      • insertChild

        public Element insertChild​(int index,
                           Node child)
        Inserts the given child node into this element at the specified index. Current node will be shifted to the right. The inserted nodes will be moved from their current parent. To prevent moving, copy the node first.
        Parameters:
        index - 0-based index to insert children at. Specify 0 to insert at the start, -1 at the end
        child - child node to insert
        Returns:
        this element, for chaining.

      • appendElement

        public Element appendElement​(java.lang.String tagName)
        Create a new element by tag name, and add it as the last child.
        Parameters:
        tagName - the name of the tag (e.g. div).
        Returns:
        the new element, to allow you to add content to it, e.g.: parent.appendElement("h1").attr("id", "header").text("Welcome");

      • prependElement

        public Element prependElement​(java.lang.String tagName)
        Create a new element by tag name, and add it as the first child.
        Parameters:
        tagName - the name of the tag (e.g. div).
        Returns:
        the new element, to allow you to add content to it, e.g.: parent.prependElement("h1").attr("id", "header").text("Welcome");

      • appendText

        public Element appendText​(java.lang.String text)
        Create and append a new TextNode to this element.
        Parameters:
        text - the unencoded text to add
        Returns:
        this element

      • prependText

        public Element prependText​(java.lang.String text)
        Create and prepend a new TextNode to this element.
        Parameters:
        text - the unencoded text to add
        Returns:
        this element

      • append

        public Element append​(java.lang.String html)
        Add inner HTML to this element. The supplied HTML will be parsed, and each node appended to the end of the children.
        Parameters:
        html - HTML to add inside this element, after the existing HTML
        Returns:
        this element
        See Also:
        html(String)

      • prepend

        public Element prepend​(java.lang.String html)
        Add inner HTML into this element. The supplied HTML will be parsed, and each node prepended to the start of the element's children.
        Parameters:
        html - HTML to add inside this element, before the existing HTML
        Returns:
        this element
        See Also:
        html(String)

      • before

        public Node before​(java.lang.String html)
        Insert the specified HTML into the DOM before this element (as a preceding sibling).
        Overrides:
        before in class Node
        Parameters:
        html - HTML to add before this element
        Returns:
        this element, for chaining
        See Also:
        after(String)

      • before

        public Node before​(Node node)
        Insert the specified node into the DOM before this node (as a preceding sibling).
        Overrides:
        before in class Node
        Parameters:
        node - to add before this element
        Returns:
        this Element, for chaining
        See Also:
        after(Node)

      • after

        public Node after​(java.lang.String html)
        Insert the specified HTML into the DOM after this element (as a following sibling).
        Overrides:
        after in class Node
        Parameters:
        html - HTML to add after this element
        Returns:
        this element, for chaining
        See Also:
        before(String)

      • after

        public Node after​(Node node)
        Insert the specified node into the DOM after this node (as a following sibling).
        Overrides:
        after in class Node
        Parameters:
        node - to add after this element
        Returns:
        this element, for chaining
        See Also:
        before(Node)

      • empty

        public Node empty()
        Remove all of the element's child nodes. Any attributes are left as-is.
        Specified by:
        empty in class Node
        Returns:
        this element

      • wrap

        public Node wrap​(java.lang.String html)
        Wrap the supplied HTML around this element.
        Overrides:
        wrap in class Node
        Parameters:
        html - HTML to wrap around this element, e.g. <div class="head"></div>. Can be arbitrarily deep.
        Returns:
        this element, for chaining.

      • cssSelector

        public java.lang.String cssSelector()
        Get a CSS selector that will uniquely select this element.

        If the element has an ID, returns #id; otherwise returns the parent (if any) CSS selector, followed by '>', followed by a unique selector for the element (tag.class.class:nth-child(n)).

        Returns:
        the CSS Path that can be used to retrieve the element in a selector.

      • siblingElements

        public Elements siblingElements()
        Get sibling elements. If the element has no sibling elements, returns an empty list. An element is not a sibling of itself, so will not be included in the returned list.
        Returns:
        sibling elements

      • nextElementSibling

        public Element nextElementSibling()
        Gets the next sibling element of this element. E.g., if a div contains two ps, the nextElementSibling of the first p is the second p.

        This is similar to Node.nextSibling(), but specifically finds only Elements

        Returns:
        the next element, or null if there is no next element
        See Also:
        previousElementSibling()

      • nextElementSiblings

        public Elements nextElementSiblings()
        Get each of the sibling elements that come after this element.
        Returns:
        each of the element siblings after this element, or an empty list if there are no next sibling elements

      • previousElementSibling

        public Element previousElementSibling()
        Gets the previous element sibling of this element.
        Returns:
        the previous element, or null if there is no previous element
        See Also:
        nextElementSibling()

      • previousElementSiblings

        public Elements previousElementSiblings()
        Get each of the element siblings before this element.
        Returns:
        the previous element siblings, or an empty list if there are none.

      • nextElementSiblings

        private Elements nextElementSiblings​(boolean next)

      • firstElementSibling

        public Element firstElementSibling()
        Gets the first Element sibling of this element. That may be this element.
        Returns:
        the first sibling that is an element (aka the parent's first element child)

      • elementSiblingIndex

        public int elementSiblingIndex()
        Get the list index of this element in its element sibling list. I.e. if this is the first element sibling, returns 0.
        Returns:
        position in element sibling list

      • lastElementSibling

        public Element lastElementSibling()
        Gets the last element sibling of this element. That may be this element.
        Returns:
        the last sibling that is an element (aka the parent's last element child)

      • indexInList

        private static <E extends Element> int indexInList​(Element search,
                                                   java.util.List<E> elements)

      • getElementsByTag

        public Elements getElementsByTag​(java.lang.String tagName)
        Finds elements, including and recursively under this element, with the specified tag name.
        Parameters:
        tagName - The tag name to search for (case insensitively).
        Returns:
        a matching unmodifiable list of elements. Will be empty if this element and none of its children match.

      • getElementById

        public Element getElementById​(java.lang.String id)
        Find an element by ID, including or under this element.

        Note that this finds the first matching ID, starting with this element. If you search down from a different starting point, it is possible to find a different element by ID. For unique element by ID within a Document, use getElementById(String)

        Parameters:
        id - The ID to search for.
        Returns:
        The first matching element by ID, starting with this element, or null if none found.

      • getElementsByClass

        public Elements getElementsByClass​(java.lang.String className)
        Find elements that have this class, including or under this element. Case insensitive.

        Elements can have multiple classes (e.g. <div class="header round first">. This method checks each class, so you can find the above with el.getElementsByClass("header");.

        Parameters:
        className - the name of the class to search for.
        Returns:
        elements with the supplied class name, empty if none
        See Also:
        hasClass(String), classNames()

      • getElementsByAttribute

        public Elements getElementsByAttribute​(java.lang.String key)
        Find elements that have a named attribute set. Case insensitive.
        Parameters:
        key - name of the attribute, e.g. href
        Returns:
        elements that have this attribute, empty if none

      • getElementsByAttributeStarting

        public Elements getElementsByAttributeStarting​(java.lang.String keyPrefix)
        Find elements that have an attribute name starting with the supplied prefix. Use data- to find elements that have HTML5 datasets.
        Parameters:
        keyPrefix - name prefix of the attribute e.g. data-
        Returns:
        elements that have attribute names that start with with the prefix, empty if none.

      • getElementsByAttributeValue

        public Elements getElementsByAttributeValue​(java.lang.String key,
                                            java.lang.String value)
        Find elements that have an attribute with the specific value. Case insensitive.
        Parameters:
        key - name of the attribute
        value - value of the attribute
        Returns:
        elements that have this attribute with this value, empty if none

      • getElementsByAttributeValueNot

        public Elements getElementsByAttributeValueNot​(java.lang.String key,
                                               java.lang.String value)
        Find elements that either do not have this attribute, or have it with a different value. Case insensitive.
        Parameters:
        key - name of the attribute
        value - value of the attribute
        Returns:
        elements that do not have a matching attribute

      • getElementsByAttributeValueStarting

        public Elements getElementsByAttributeValueStarting​(java.lang.String key,
                                                    java.lang.String valuePrefix)
        Find elements that have attributes that start with the value prefix. Case insensitive.
        Parameters:
        key - name of the attribute
        valuePrefix - start of attribute value
        Returns:
        elements that have attributes that start with the value prefix

      • getElementsByAttributeValueEnding

        public Elements getElementsByAttributeValueEnding​(java.lang.String key,
                                                  java.lang.String valueSuffix)
        Find elements that have attributes that end with the value suffix. Case insensitive.
        Parameters:
        key - name of the attribute
        valueSuffix - end of the attribute value
        Returns:
        elements that have attributes that end with the value suffix

      • getElementsByAttributeValueContaining

        public Elements getElementsByAttributeValueContaining​(java.lang.String key,
                                                      java.lang.String match)
        Find elements that have attributes whose value contains the match string. Case insensitive.
        Parameters:
        key - name of the attribute
        match - substring of value to search for
        Returns:
        elements that have attributes containing this text

      • getElementsByAttributeValueMatching

        public Elements getElementsByAttributeValueMatching​(java.lang.String key,
                                                    java.util.regex.Pattern pattern)
        Find elements that have attributes whose values match the supplied regular expression.
        Parameters:
        key - name of the attribute
        pattern - compiled regular expression to match against attribute values
        Returns:
        elements that have attributes matching this regular expression

      • getElementsByAttributeValueMatching

        public Elements getElementsByAttributeValueMatching​(java.lang.String key,
                                                    java.lang.String regex)
        Find elements that have attributes whose values match the supplied regular expression.
        Parameters:
        key - name of the attribute
        regex - regular expression to match against attribute values. You can use embedded flags (such as (?i) and (?m) to control regex options.
        Returns:
        elements that have attributes matching this regular expression

      • getElementsByIndexLessThan

        public Elements getElementsByIndexLessThan​(int index)
        Find elements whose sibling index is less than the supplied index.
        Parameters:
        index - 0-based index
        Returns:
        elements less than index

      • getElementsByIndexGreaterThan

        public Elements getElementsByIndexGreaterThan​(int index)
        Find elements whose sibling index is greater than the supplied index.
        Parameters:
        index - 0-based index
        Returns:
        elements greater than index

      • getElementsByIndexEquals

        public Elements getElementsByIndexEquals​(int index)
        Find elements whose sibling index is equal to the supplied index.
        Parameters:
        index - 0-based index
        Returns:
        elements equal to index

      • getElementsContainingText

        public Elements getElementsContainingText​(java.lang.String searchText)
        Find elements that contain the specified string. The search is case insensitive. The text may appear directly in the element, or in any of its descendants.
        Parameters:
        searchText - to look for in the element's text
        Returns:
        elements that contain the string, case insensitive.
        See Also:
        text()

      • getElementsContainingOwnText

        public Elements getElementsContainingOwnText​(java.lang.String searchText)
        Find elements that directly contain the specified string. The search is case insensitive. The text must appear directly in the element, not in any of its descendants.
        Parameters:
        searchText - to look for in the element's own text
        Returns:
        elements that contain the string, case insensitive.
        See Also:
        ownText()

      • getElementsMatchingText

        public Elements getElementsMatchingText​(java.util.regex.Pattern pattern)
        Find elements whose text matches the supplied regular expression.
        Parameters:
        pattern - regular expression to match text against
        Returns:
        elements matching the supplied regular expression.
        See Also:
        text()

      • getElementsMatchingText

        public Elements getElementsMatchingText​(java.lang.String regex)
        Find elements whose text matches the supplied regular expression.
        Parameters:
        regex - regular expression to match text against. You can use embedded flags (such as (?i) and (?m) to control regex options.
        Returns:
        elements matching the supplied regular expression.
        See Also:
        text()

      • getElementsMatchingOwnText

        public Elements getElementsMatchingOwnText​(java.util.regex.Pattern pattern)
        Find elements whose own text matches the supplied regular expression.
        Parameters:
        pattern - regular expression to match text against
        Returns:
        elements matching the supplied regular expression.
        See Also:
        ownText()

      • getElementsMatchingOwnText

        public Elements getElementsMatchingOwnText​(java.lang.String regex)
        Find elements whose own text matches the supplied regular expression.
        Parameters:
        regex - regular expression to match text against. You can use embedded flags (such as (?i) and (?m) to control regex options.
        Returns:
        elements matching the supplied regular expression.
        See Also:
        ownText()

      • getAllElements

        public Elements getAllElements()
        Find all elements under this element (including self, and children of children).
        Returns:
        all elements

      • text

        public java.lang.String text()
        Gets the normalized, combined text of this element and all its children. Whitespace is normalized and trimmed.

        For example, given HTML <p>Hello <b>there</b> now! </p>, p.text() returns "Hello there now!"

        If you do not want normalized text, use wholeText(). If you want just the text of this node (and not children), use ownText()

        Note that this method returns the textual content that would be presented to a reader. The contents of data nodes (such as <script> tags are not considered text. Use data() or html() to retrieve that content.

        Returns:
        unencoded, normalized text, or empty string if none.
        See Also:
        wholeText(), ownText(), textNodes()

      • wholeText

        public java.lang.String wholeText()
        Get the (unencoded) text of all children of this element, including any newlines and spaces present in the original.
        Returns:
        unencoded, un-normalized text
        See Also:
        text()

      • ownText

        public java.lang.String ownText()
        Gets the (normalized) text owned by this element only; does not get the combined text of all children.

        For example, given HTML <p>Hello <b>there</b> now!</p>, p.ownText() returns "Hello now!", whereas p.text() returns "Hello there now!". Note that the text within the b element is not returned, as it is not a direct child of the p element.

        Returns:
        unencoded text, or empty string if none.
        See Also:
        text(), textNodes()

      • ownText

        private void ownText​(java.lang.StringBuilder accum)

      • appendNormalisedText

        private static void appendNormalisedText​(java.lang.StringBuilder accum,
                                         TextNode textNode)

      • appendWhitespaceIfBr

        private static void appendWhitespaceIfBr​(Element element,
                                         java.lang.StringBuilder accum)

      • preserveWhitespace

        static boolean preserveWhitespace​(Node node)

      • text

        public Element text​(java.lang.String text)
        Set the text of this element. Any existing contents (text or elements) will be cleared.

        As a special case, for <script> and <style> tags, the input text will be treated as data, not visible text.

        Parameters:
        text - unencoded text
        Returns:
        this element

      • hasText

        public boolean hasText()
        Test if this element has any text content (that is not just whitespace).
        Returns:
        true if element has non-blank text content.

      • data

        public java.lang.String data()
        Get the combined data of this element. Data is e.g. the inside of a <script> tag. Note that data is NOT the text of the element. Use text() to get the text that would be visible to a user, and data() for the contents of scripts, comments, CSS styles, etc.
        Returns:
        the data, or empty string if none
        See Also:
        dataNodes()

      • className

        public java.lang.String className()
        Gets the literal value of this element's "class" attribute, which may include multiple class names, space separated. (E.g. on <div class="header gray"> returns, "header gray")
        Returns:
        The literal class attribute, or empty string if no class attribute set.

      • classNames

        public java.util.Set<java.lang.String> classNames()
        Get all of the element's class names. E.g. on element <div class="header gray">, returns a set of two elements "header", "gray". Note that modifications to this set are not pushed to the backing class attribute; use the classNames(java.util.Set) method to persist them.
        Returns:
        set of classnames, empty if no class attribute

      • classNames

        public Element classNames​(java.util.Set<java.lang.String> classNames)
        Set the element's class attribute to the supplied class names.
        Parameters:
        classNames - set of classes
        Returns:
        this element, for chaining

      • hasClass

        public boolean hasClass​(java.lang.String className)
        Tests if this element has a class. Case insensitive.
        Parameters:
        className - name of class to check for
        Returns:
        true if it does, false if not

      • addClass

        public Element addClass​(java.lang.String className)
        Add a class name to this element's class attribute.
        Parameters:
        className - class name to add
        Returns:
        this element

      • removeClass

        public Element removeClass​(java.lang.String className)
        Remove a class name from this element's class attribute.
        Parameters:
        className - class name to remove
        Returns:
        this element

      • toggleClass

        public Element toggleClass​(java.lang.String className)
        Toggle a class name on this element's class attribute: if present, remove it; otherwise add it.
        Parameters:
        className - class name to toggle
        Returns:
        this element

      • val

        public java.lang.String val()
        Get the value of a form element (input, textarea, etc).
        Returns:
        the value of the form element, or empty string if not set.

      • val

        public Element val​(java.lang.String value)
        Set the value of a form element (input, textarea, etc).
        Parameters:
        value - value to set
        Returns:
        this element (for chaining)

      • outerHtmlHead

        void outerHtmlHead​(java.lang.Appendable accum,
                   int depth,
                   Document.OutputSettings out)
            throws java.io.IOException
        Description copied from class: Node
        Get the outer HTML of this node.
        Specified by:
        outerHtmlHead in class Node
        Parameters:
        accum - accumulator to place HTML into
        Throws:
        java.io.IOException - if appending to the given accumulator fails.

      • outerHtmlTail

        void outerHtmlTail​(java.lang.Appendable accum,
                   int depth,
                   Document.OutputSettings out)
            throws java.io.IOException
        Specified by:
        outerHtmlTail in class Node
        Throws:
        java.io.IOException

      • html

        public java.lang.String html()
        Retrieves the element's inner HTML. E.g. on a <div> with one empty <p>, would return <p></p>. (Whereas Node.outerHtml() would return <div><p></p></div>.)
        Returns:
        String of HTML.
        See Also:
        Node.outerHtml()

      • html

        public java.lang.Appendable html​(java.lang.Appendable appendable)
        Description copied from class: Node
        Write this node and its children to the given Appendable.
        Overrides:
        html in class Node
        Parameters:
        appendable - the Appendable to write to.
        Returns:
        the supplied Appendable, for chaining.

      • html

        public Element html​(java.lang.String html)
        Set this element's inner HTML. Clears the existing HTML first.
        Parameters:
        html - HTML to parse and set into this element
        Returns:
        this element
        See Also:
        append(String)

      • clone

        public java.lang.Object clone()
        Description copied from class: Node
        Create a stand-alone, deep copy of this node, and all of its children. The cloned node will have no siblings or parent node. As a stand-alone object, any changes made to the clone or any of its children will not impact the original node.

        The cloned node may be adopted into another Document or node structure using appendChild(Node).

        Overrides:
        clone in class Node
        Returns:
        a stand-alone cloned node, including clones of any children
        See Also:
        Node.shallowClone()

      • shallowClone

        public Node shallowClone()
        Description copied from class: Node
        Create a stand-alone, shallow copy of this node. None of its children (if any) will be cloned, and it will have no parent or sibling nodes.
        Overrides:
        shallowClone in class Node
        Returns:
        a single independent copy of this node
        See Also:
        Node.clone()

      • clearAttributes

        public Node clearAttributes()
        Description copied from class: Node
        Clear (remove) all of the attributes in this node.
        Overrides:
        clearAttributes in class Node
        Returns:
        this, for chaining

      • removeAttr

        public Node removeAttr​(java.lang.String attributeKey)
        Description copied from class: Node
        Remove an attribute from this node.
        Overrides:
        removeAttr in class Node
        Parameters:
        attributeKey - The attribute to remove.
        Returns:
        this (for chaining)

      • root

        public Node root()
        Description copied from class: Node
        Get this node's root node; that is, its topmost ancestor. If this node is the top ancestor, returns this.
        Overrides:
        root in class Node
        Returns:
        topmost ancestor.

      • traverse

        public Node traverse​(NodeVisitor nodeVisitor)
        Description copied from class: Node
        Perform a depth-first traversal through this node and its descendants.
        Overrides:
        traverse in class Node
        Parameters:
        nodeVisitor - the visitor callbacks to perform on each node
        Returns:
        this node, for chaining

      • filter

        public Node filter​(NodeFilter nodeFilter)
        Description copied from class: Node
        Perform a depth-first filtering through this node and its descendants.
        Overrides:
        filter in class Node
        Parameters:
        nodeFilter - the filter callbacks to perform on each node
        Returns:
        this node, for chaining