iText7 7.2.0  Overview   Package   Class  Text Changes  Statistics  Help 
Generated by
JDiff
PREV PACKAGE    NEXT PACKAGE          FRAMES    NO FRAMES  

com.itextpdf.styledxmlparser.jsoup.nodes Documentation Differences

This file contains all the changes in documentation in the package com.itextpdf.styledxmlparser.jsoup.nodes as colored differences. Deletions are shown like this , and additions are shown like this.
If no deletions or additions are shown in an entry, the HTML tags will be what has changed. The new HTML tags are shown in the differences. If no documentation existed, and then some was added in a later version, this change is noted in the appropriate class pages of differences, but the change is not shown on this page. Only changes in existing text are shown here. Similarly, documentation which was inherited from another class or interface is not shown here.
Note that an HTML error in the new documentation may cause the display of other documentation changes to be presented incorrectly. For instance, failure to close a tag will cause all subsequent paragraphs to be displayed differently.
Class Attribute

A single key + value attribute. Keys (Only are trimmed used for and normalised to lower-case. @author Jonathan Hedley, jonathan@hedley presentation. net )
Class Attribute, constructor Attribute(String, String)

Create a new attribute from unencoded (raw) key and value. @param key attribute key key; case is preserved. @param value attribute value value (may be null) @see #createFromEncoded
Class Attribute, String getValue()

Get the attribute value. Will return an empty string if the value is not set. @return the attribute value
Class Attribute, void setKey(String)

Set the attribute key . Gets normalised as per ; the constructor method case is preserved. @param key the new key; must not be null
Class Attribute, String setValue(String)

Set the attribute value. @param value val the new attribute value; must not be null
Class Attribute, boolean shouldCollapseAttribute(OutputSettings)

Collapsible if it's a boolean attribute and value is empty or same as name @param out Outputsettings output settings @return Returns whether collapsible or not
Class Attributes

The attributes of an Element.

Attributes are treated as a map: there can be only one value associated with an attribute key/name.

Attribute key name and value comparisons are done generally case insensitively sensitive. By default for HTML, and keys are normalised to attribute names are normalized to lower-case on parsing. That means you should use lower-case strings when referring to attributes by name. @author Jonathan Hedley, jonathan@hedley.net

Class Attributes, List asList()

Get the attributes as a List, for iteration. Do not modify the keys of the attributes via this view, as changes to keys will not be recognised in the containing set. @return an view of the attributes as a an unmodifiable List.
Class Attributes, String get(String)

Get an attribute value by key. @param key the (case-sensitive) attribute key @return the attribute value if set; or empty string if not set (or a boolean attribute). @see #hasKey(String)
Class Attributes, boolean hasKey(String)

Tests if these attributes contain an attribute with this key. @param key case-sensitive key to check for @return true if key exists, false otherwise
Class Attributes, String html()

Get the HTML representation of these attributes. @return HTML @throws SerializationException if the HTML representation of the attributes cannot be constructed.
Class Attributes, Attributes put(Attribute)

Set a new attribute, or replace an existing one by key. @param attribute attribute with case sensitive key @return these attributes, for chaining
Class Attributes, Attributes put(String, String)

Set a new attribute, or replace an existing one by key. @param key attribute key case sensitive attribute key (not null) @param value attribute value (may be null, to set a boolean attribute) @return these attributes, for chaining
Class Attributes, Attributes put(String, boolean)

Set a new boolean attribute, remove attribute if value is false. @param key attribute key case insensitive attribute key @param value attribute value value @return these attributes, for chaining
Class Attributes, void remove(String)

Remove an attribute by key. Case sensitive. @param key attribute key to remove
Class Comment, constructor Comment(String)

Create a new comment node. @param data The contents of the comment @param baseUri base URI comment
Class DataNode, constructor DataNode(String)

Create a new DataNode. @param data data contents @param baseUri base URI contents
Class DataNode, DataNode createFromEncoded(String, String)

Create a new DataNode from HTML encoded data. @param encodedData encoded data @param baseUri bass base URI @return new DataNode DataNode @deprecated Unused, and will be removed in 1.15.1.
Class Document, constructor Document(String)

Create a new, empty Document. @param baseUri base URI of document @see com.itextpdf.styledxmlparser.jsoup.Jsoup#parse @see #createShell
Class Document, Element body()

Accessor to Get this the document's {@code body } or {@code } element.

As a side-effect, if this Document does not already have a HTML structure, it will be created with a {@code } element. If you do not want that, use {@code #selectFirst("body")} instead. @return {@code body} element for documents with a {@code }, a new {@code } element if the document had no contents, or the outermost {@code element} for frameset documents.

Class Document, void charset(Charset)

Sets the charset used in this document. This method is equivalent to OutputSettings.charset(Charset) but in addition it updates the charset / encoding element within the document.

This enables meta charset update.

If there's no element with charset / encoding information yet it will will be created. Obsolete charset / encoding definitions are removed!

Elements used:

@param charset Charset @see #updateMetaCharsetElement(boolean) @see OutputSettings#charset(java.nio.charset.Charset)
Class Document, Element head()

Accessor to Get this the document's {@code head} element.

As a side-effect, if this Document does not already have a HTML structure, it will be created. If you do not want that, use {@code #selectFirst("head")} instead. @return {@code head} element.

Class Document, String location()

Get the URL this Document was parsed from. If the starting URL is a redirect, this will return the final URL from which the document was served from.

Will return an empty string if the location is unknown (e.g. if parsed from a String). @return location

Class Document, void updateMetaCharsetElement(boolean)

Sets whether the element with charset information in this document is updated on changes through Document.charset(Charset) or not.

If set to false (default) there are no elements elements modified. @param update If true the element updated on charset changes, false if not @see #charset(java.nio.charset.Charset)

Class DocumentType, constructor DocumentType(String, String, String)

Create a new doctype element. @param name the doctype's name @param publicId the doctype's public ID @param systemId the doctype's system ID @param baseUri the doctype's base URI ID
Class Element

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. @author Jonathan Hedley, jonathan@hedley.net
Class Element, constructor Element(Tag, String)

Create a new Element from a tag Tag and a base URI. @param tag element tag @param baseUri the base URI of this element. It is acceptable for the base URI to be an empty Optional, and will inherit from its string parent, but if not null any. @see Tag#valueOf(String, ParseSettings)
Class Element, constructor Element(Tag, String, Attributes)

Create a new, standalone Element. (Standalone in that is has no parent.) @param tag tag of this element @param baseUri the base URI URI (optional, may be null to inherit from parent, or "" to clear parent's) @param attributes initial attributes attributes (optional, may be null) @see #appendChild(Node) @see #appendElement(String)
Class Element, Element addClass(String)

Add a class name to this element's {@code class} attribute. @param className class name to add @return this element
Class Element, Element appendChild(Node)

Add Insert a node child to node to the end of this element Element's children. The incoming node will be re-parented. @param child node to add. @return this element Element, so that for you can add chaining more @see child #prependChild(Node) nodes @see or #insertChildren(int, elements. Collection)
Class Element, Element appendElement(String)

Create a new element by tag name, and add it as the last child. @param tagName the name of the tag (e.g. {@code div}). @return the new element, to allow you to add content to it, e.g.: {@code parent.appendElement("h1").attr("id", "header").text("Welcome");}
Class Element, Element appendText(String)

Create and append a new TextNode to this element. @param text the unencoded text to add @return this element
Class Element, Node attr(String, String)

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. @return this element
Class Element, Element attr(String, boolean)

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. @param attributeKey the attribute key @param attributeValue the attribute value value @return this element
Class Element, Element child(int)

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. @param index the index number of the element to retrieve @return the child element, if it exists, otherwise throws an {@code IndexOutOfBoundsException} @see #childNode(int)

Class Element, Elements children()

Get this element's child elements.

This is effectively a filter on .childNodes() to get Element nodes. @return child elements. If this element has no children, returns an an empty list. @see #childNodes()

Class Element, Element classNames(Set)

Set the element's {@code class} attribute to the supplied class names. @param classNames set of classes @return this element, for chaining
Class Element, String data()

Get the combined data of this element. Data is e.g. the inside of a {@code script