com.vaadin.flow.dom

Class ElementUtil

java.lang.Object

com.vaadin.flow.dom.ElementUtil

public class ElementUtil
extends Object

Provides utility methods for Element.

Since:

1.0

Author:

Vaadin Ltd

Method Summary

Modifier and Type	Method and Description
static Optional<Element>	from(StateNode node) Gets the element mapped to the given state node.
static Optional<Element>	fromJsoup(org.jsoup.nodes.Node node) Converts a given JSoup Node and its children into a matching Element hierarchy.
static boolean	isCustomElement(Element element) Checks whether the given element is a custom element or not.
static boolean	isScript(Element element) Checks whether the given element is a script or not.
static boolean	isValidAttributeName(String attribute) Checks if the given attribute name is valid.
static boolean	isValidStylePropertyName(String name) Checks if the given style property name is valid.
static boolean	isValidStylePropertyValue(String value) Checks if the given style property value is valid.
static boolean	isValidTagName(String tag) Checks if the given tag name is valid.
static void	setComponent(Element element, Component component) Defines a mapping between this element and the given Component.
static org.jsoup.nodes.Node	toJsoup(org.jsoup.nodes.Document document, Element element) Converts the given element and its children to a JSoup node with children.
static void	validateStylePropertyName(String name) Validates the given style property name and throws an exception if the name is invalid.
static void	validateStylePropertyValue(String value) Checks if the given style property value is valid.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

isValidTagName

public static boolean isValidTagName(String tag)

Checks if the given tag name is valid.

Parameters:

tag - the tag name

Returns:

true if the string is valid as a tag name, false otherwise

isValidAttributeName

public static boolean isValidAttributeName(String attribute)

Checks if the given attribute name is valid.

Parameters:

attribute - the name of the attribute in lower case

Returns:

true if the name is valid, false otherwise

validateStylePropertyName

public static void validateStylePropertyName(String name)

Validates the given style property name and throws an exception if the name is invalid.

Parameters:

name - the style property name to validate

isValidStylePropertyName

public static boolean isValidStylePropertyName(String name)

Checks if the given style property name is valid.

Parameters:

name - the name to validate

Returns:

true if the name is valid, false otherwise

isValidStylePropertyValue

public static boolean isValidStylePropertyValue(String value)

Checks if the given style property value is valid.

Parameters:

value - the value to validate

Returns:

true if the value is valid, false otherwise

validateStylePropertyValue

public static void validateStylePropertyValue(String value)

Checks if the given style property value is valid.

Throws an exception if it's certain the value is invalid

Parameters:

value - the value to validate

setComponent

public static void setComponent(Element element,
                                Component component)

Defines a mapping between this element and the given Component.

An element can only be mapped to one component and the mapping cannot be changed. The only exception is Composite which can overwrite the mapping for its content.

Parameters:

element - the element to map to the component

component - the component this element is attached to

toJsoup

public static org.jsoup.nodes.Node toJsoup(org.jsoup.nodes.Document document,
                                           Element element)

Converts the given element and its children to a JSoup node with children.

Parameters:

document - A JSoup document

element - The element to convert

Returns:

A JSoup node containing the converted element

fromJsoup

public static Optional<Element> fromJsoup(org.jsoup.nodes.Node node)

Converts a given JSoup Node and its children into a matching Element hierarchy.

Only nodes of type TextNode and Element are converted - other node types return an empty optional.

Parameters:

node - JSoup node to convert

Returns:

element with the matching hierarchy as the given node, or empty

isCustomElement

public static boolean isCustomElement(Element element)

Checks whether the given element is a custom element or not.

Custom elements (Web Components) are recognized by having at least one dash in the tag name.

Parameters:

element - the element to check

Returns:

true if a custom element, false if not

isScript

public static boolean isScript(Element element)

Checks whether the given element is a script or not.

Parameters:

element - the element to check

Returns:

true if a script, false if not

from

public static Optional<Element> from(StateNode node)

Gets the element mapped to the given state node.

Parameters:

node - the state node, not null

Returns:

the element for the node, or an empty Optional if the state node is not mapped to any particular element.