Package org.jboss.elemento

Class Elements

java.lang.Object

org.jboss.elemento.Elements

public final class Elements
extends Object

Builder and helper methods for working with HTMLElements and/or IsElement.

/* The code below, builds the following HTML snippet
<section class="main">
    <input class="toggle-all" type="checkbox">
    <label for="toggle-all">Mark all as complete</label>
    <ul class="todo-list">
        <li>
            <div class="view">
                <input class="toggle" type="checkbox" checked>
                <label>Taste Elemento</label>
                <button class="destroy"></button>
            </div>
            <input class="edit">
        </li>
    </ul>
</section>
 */
TodoRepository repository = new TodoRepository();
HTMLElement section = section().css("main")
        .add(input(checkbox).id("toggle-all").css("toggle-all"))
        .add(label()
                .apply(l -> l.htmlFor = "toggle-all")
                .textContent("Mark all as complete"))
        .add(ul().css("todo-list")
                .run(ul -> {
                    for (Todo todo : repository.todos()) {
                        ul.add(li()
                                .add(div().css("view")
                                        .add(input(checkbox)
                                                .css("toggle")
                                                .checked(todo.completed))
                                        .add(label().textContent(todo.text))
                                        .add(button().css("destroy")))
                                .add(input(text).css("edit")));
                    }
                }))
        .element();

See Also:

• https://developer.mozilla.org/en-US/docs/Web/HTML/Element

Method Summary

Modifier and Type	Method	Description
static HTMLContainerBuilder<HTMLAnchorElement>	a()
static HTMLContainerBuilder<HTMLAnchorElement>	a(Element element)
static HTMLContainerBuilder<HTMLAnchorElement>	a(String href)
static HTMLContainerBuilder<HTMLAnchorElement>	a(String href, String target)
static HTMLContainerBuilder<HTMLElement>	abbr()
static HTMLContainerBuilder<HTMLElement>	abbr(Element element)
static HTMLContainerBuilder<HTMLElement>	abbr(String text)
static HTMLContainerBuilder<HTMLElement>	address()
static HTMLContainerBuilder<HTMLElement>	address(Element element)
static HTMLElementBuilder<HTMLAreaElement>	area()
static HTMLElementBuilder<HTMLAreaElement>	area(Element element)
static HTMLContainerBuilder<HTMLElement>	article()
static HTMLContainerBuilder<HTMLElement>	article(Element element)
static <T extends Node> Function<T,HTMLElement>	asHtmlElement()	Casts to HTMLElement.
static HTMLContainerBuilder<HTMLElement>	aside()
static HTMLContainerBuilder<HTMLElement>	aside(Element element)
static HTMLContainerBuilder<HTMLAudioElement>	audio()
static HTMLContainerBuilder<HTMLAudioElement>	audio(Element element)
static HTMLContainerBuilder<HTMLElement>	b()
static HTMLContainerBuilder<HTMLElement>	b(Element element)
static HTMLContainerBuilder<HTMLElement>	b(String text)
static ElementsBag	bag()	Returns a builder to collect HTMLElements.
static HTMLContainerBuilder<HTMLQuoteElement>	blockquote()
static HTMLContainerBuilder<HTMLQuoteElement>	blockquote(Element element)
static HTMLContainerBuilder<HTMLBodyElement>	body()	Returns an HTML content builder for the document body.
static HTMLElementBuilder<HTMLBRElement>	br()
static HTMLElementBuilder<HTMLBRElement>	br(Element element)
static String	buildId(String id, String... additionalIds)	Deprecated. Replaced bv Id.build(String, String...)
static HTMLContainerBuilder<HTMLButtonElement>	button()
static HTMLContainerBuilder<HTMLButtonElement>	button(Element element)
static HTMLContainerBuilder<HTMLButtonElement>	button(String text)
static HTMLContainerBuilder<HTMLCanvasElement>	canvas()
static HTMLContainerBuilder<HTMLCanvasElement>	canvas(Element element)
static HTMLContainerBuilder<HTMLTableCaptionElement>	caption()
static HTMLContainerBuilder<HTMLTableCaptionElement>	caption(Element element)
static Iterable<HTMLElement>	children(HTMLElement parent)	Returns an iterable for the child elements of the given parent element.
static Iterable<Node>	children(Node parent)	Returns an iterable for the child nodes of the given parent node.
static <E extends HTMLElement> Iterable<HTMLElement>	children(IsElement<E> parent)	Returns an iterable for the child elements of the given parent element.
static HTMLContainerBuilder<HTMLElement>	cite()
static HTMLContainerBuilder<HTMLElement>	cite(Element element)
static HTMLContainerBuilder<HTMLElement>	cite(String text)
static <E extends HTMLElement> E	closest(Element element, By selector)	Finds the closest HTML elements for the given selector.
static <E extends HTMLElement, F extends HTMLElement> F	closest(IsElement<E> element, By selector)	Finds the closest HTML elements for the given selector.
static HTMLContainerBuilder<HTMLElement>	code()
static HTMLContainerBuilder<HTMLElement>	code(Element element)
static HTMLContainerBuilder<HTMLElement>	code(String text)
static HTMLElementBuilder<HTMLTableColElement>	col()
static HTMLElementBuilder<HTMLTableColElement>	col(Element element)
static HTMLContainerBuilder<HTMLTableColElement>	colgroup()
static HTMLContainerBuilder<HTMLTableColElement>	colgroup(Element element)
static <E extends HTMLElement> E	createHtmlElement(String element, Class<E> type)	Creates the specified HTML element.
static HTMLContainerBuilder<HTMLDataListElement>	datalist()
static HTMLContainerBuilder<HTMLDataListElement>	datalist(Element element)
static HTMLContainerBuilder<HTMLElement>	dd()
static HTMLContainerBuilder<HTMLElement>	dd(Element element)
static HTMLContainerBuilder<HTMLModElement>	del()
static HTMLContainerBuilder<HTMLModElement>	del(Element element)
static HTMLContainerBuilder<HTMLModElement>	del(String text)
static HTMLContainerBuilder<HTMLElement>	dfn()
static HTMLContainerBuilder<HTMLElement>	dfn(Element element)
static HTMLContainerBuilder<HTMLElement>	dfn(String text)
static HTMLContainerBuilder<HTMLDivElement>	div()
static HTMLContainerBuilder<HTMLDivElement>	div(Element element)
static HTMLContainerBuilder<HTMLDListElement>	dl()
static HTMLContainerBuilder<HTMLDListElement>	dl(Element element)
static HTMLContainerBuilder<HTMLElement>	dt()
static HTMLContainerBuilder<HTMLElement>	dt(Element element)
static <E> Iterable<E>	elements(jsinterop.base.JsArrayLike<E> nodes)	Returns an iterable for the elements in the given array-like.
static HTMLContainerBuilder<HTMLElement>	em()
static HTMLContainerBuilder<HTMLElement>	em(Element element)
static HTMLContainerBuilder<HTMLElement>	em(String text)
static HTMLElementBuilder<HTMLEmbedElement>	embed()
static HTMLElementBuilder<HTMLEmbedElement>	embed(Element element)
static boolean	failSafeRemove(Node parent, Element child)	Removes the child from parent if both parent and child are not null and parent contains child.
static <E extends HTMLElement> boolean	failSafeRemove(Node parent, IsElement<E> child)	Removes the child from parent if both parent and child are not null and parent contains child.
static boolean	failSafeRemoveFromParent(Element element)	Removes the element from its parent if the element is not null and has a parent.
static <E extends HTMLElement> boolean	failSafeRemoveFromParent(IsElement<E> element)	Removes the element from its parent if the element is not null and has a parent.
static HTMLContainerBuilder<HTMLFieldSetElement>	fieldset()
static HTMLContainerBuilder<HTMLFieldSetElement>	fieldset(Element element)
static HTMLContainerBuilder<HTMLElement>	figcaption()
static HTMLContainerBuilder<HTMLElement>	figcaption(Element element)
static HTMLContainerBuilder<HTMLElement>	figure()
static HTMLContainerBuilder<HTMLElement>	figure(Element element)
static <E extends HTMLElement> E	find(Node node, By selector)	Finds a single HTML elements for the given selector.
static <E extends HTMLElement, F extends HTMLElement> F	find(IsElement<E> element, By selector)	Finds a single HTML elements for the given selector.
static Iterable<HTMLElement>	findAll(Node node, By selector)	Finds all HTML elements for the given selector.
static <E extends HTMLElement> Iterable<HTMLElement>	findAll(IsElement<E> element, By selector)	Finds all HTML elements for the given selector.
static HTMLContainerBuilder<HTMLElement>	footer()
static HTMLContainerBuilder<HTMLElement>	footer(Element element)
static HTMLContainerBuilder<HTMLFormElement>	form()
static HTMLContainerBuilder<HTMLFormElement>	form(Element element)
static HTMLContainerBuilder<HTMLHeadingElement>	h(int n)
static HTMLContainerBuilder<HTMLHeadingElement>	h(int n, String text)
static HTMLContainerBuilder<HTMLHeadingElement>	h(Element element)
static HTMLContainerBuilder<HTMLElement>	header()
static HTMLContainerBuilder<HTMLElement>	header(Element element)
static HTMLContainerBuilder<HTMLElement>	hgroup()
static HTMLContainerBuilder<HTMLElement>	hgroup(Element element)
static HTMLElementBuilder<HTMLHRElement>	hr()
static HTMLElementBuilder<HTMLHRElement>	hr(Element element)
static <E extends HTMLElement> HTMLContainerBuilder<E>	htmlContainer(String element, Class<E> type)	Returns a builder for the specified HTML element.
static <E extends HTMLElement> HTMLElementBuilder<E>	htmlElement(String element, Class<E> type)	Returns a builder for the specified HTML element.
static <T extends Node> Predicate<T>	htmlElements()	Returns a predicate for HTML elements.
static HTMLContainerBuilder<HTMLElement>	i()
static HTMLContainerBuilder<HTMLElement>	i(Element element)
static HTMLContainerBuilder<HTMLElement>	i(String text)
static HTMLContainerBuilder<HTMLIFrameElement>	iframe()
static HTMLContainerBuilder<HTMLIFrameElement>	iframe(Element element)
static HTMLContainerBuilder<HTMLIFrameElement>	iframe(String src)
static HTMLElementBuilder<HTMLImageElement>	img()
static HTMLElementBuilder<HTMLImageElement>	img(Element element)
static HTMLElementBuilder<HTMLImageElement>	img(String src)
static void	innerHtml(HTMLElement element, SafeHtml html)	Convenience method to set the inner HTML of the given element.
static <E extends HTMLElement> void	innerHtml(IsElement<E> element, SafeHtml html)	Convenience method to set the inner HTML of the given element.
static InputElementBuilder<HTMLInputElement>	input(Element element)
static InputElementBuilder<HTMLInputElement>	input(String type)
static <E extends HTMLInputElement> InputElementBuilder<E>	input(String type, Class<E> jType)
static InputElementBuilder<HTMLInputElement>	input(InputType type)
static <E extends HTMLInputElement> InputElementBuilder<E>	inputElement(String type, Class<E> jType)	Returns a builder for the specified input element.
static HTMLContainerBuilder<HTMLModElement>	ins()
static HTMLContainerBuilder<HTMLModElement>	ins(Element element)
static HTMLContainerBuilder<HTMLModElement>	ins(String text)
static void	insertAfter(Element newElement, Element after)	Inserts element newElement into the parent after element after.
static <E extends HTMLElement> void	insertAfter(IsElement<E> newElement, Element after)	Inserts element newElement into the parent after element after.
static void	insertBefore(Element newElement, Element before)	Inserts element newElement into the parent before element before.
static <E extends HTMLElement> void	insertBefore(IsElement<E> newElement, Element before)	Inserts element newElement into the parent before element before.
static void	insertFirst(Element parent, Element newElement)	Inserts element newElement as first element into parent.
static <E extends HTMLElement> void	insertFirst(Element parent, IsElement<E> newElement)	Inserts element newElement as first element into parent.
static boolean	isAttached(Node node)	Fail-safe shortcut for Node.isConnected
static <E extends HTMLElement> boolean	isAttached(IsElement<E> element)	Returns true if the element is connected by calling Node.isConnected on the element's IsElement.element().
static boolean	isElementInView(HTMLElement container, HTMLElement element, boolean partial)	This function returns whether an element is within the viewable area of a container.
static <E extends HTMLElement> boolean	isElementInView(HTMLElement container, IsElement<E> element, boolean partial)
static <E extends HTMLElement> boolean	isElementInView(IsElement<E> container, HTMLElement element, boolean partial)
static <E extends HTMLElement, F extends HTMLElement> boolean	isElementInView(IsElement<E> container, IsElement<F> element, boolean partial)
static boolean	isVisible(HTMLElement element)	Checks whether the given element is visible (i.e.
static <E extends HTMLElement> boolean	isVisible(IsElement<E> element)	Checks whether the given element is visible (i.e.
static Iterator<HTMLElement>	iterator(HTMLElement parent)	Returns an iterator over the children of the given parent element.
static Iterator<Node>	iterator(Node parent)	Returns an iterator over the children of the given parent node.
static <E> Iterator<E>	iterator(jsinterop.base.JsArrayLike<E> data)	Returns an iterator over the given array-like.
static <E extends HTMLElement> Iterator<HTMLElement>	iterator(IsElement<E> parent)	Returns an iterator over the children of the given parent element.
static HTMLContainerBuilder<HTMLElement>	kbd()
static HTMLContainerBuilder<HTMLElement>	kbd(Element element)
static HTMLContainerBuilder<HTMLElement>	kbd(String text)
static HTMLContainerBuilder<HTMLLabelElement>	label()
static HTMLContainerBuilder<HTMLLabelElement>	label(Element element)
static HTMLContainerBuilder<HTMLLabelElement>	label(String text)
static void	lazyAppend(Element parent, Element child)	Appends element child to element parent if not already present.
static <E extends HTMLElement> void	lazyAppend(Element parent, IsElement<E> child)	Appends element child to element parent if not already present.
static void	lazyInsertAfter(Element newElement, Element after)	Inserts element newElement into the parent after element after if not already present.
static void	lazyInsertAfter(Element parent, Element newElement, Element after)	Inserts element newElement into the parent after element after if not already present.
static <E extends HTMLElement> void	lazyInsertAfter(Element parent, IsElement<E> newElement, Element after)	Inserts element newElement into the parent after element after if not already present.
static <E extends HTMLElement> void	lazyInsertAfter(IsElement<E> newElement, Element after)	Inserts element newElement into the parent after element after if not already present.
static void	lazyInsertBefore(Element newElement, Element before)	Inserts element newElement into the parent before element before if not already present.
static void	lazyInsertBefore(Element parent, Element newElement, Element before)	Inserts element newElement into the parent before element before if not already present.
static <E extends HTMLElement> void	lazyInsertBefore(Element parent, IsElement<E> newElement, Element before)	Inserts element newElement into the parent before element before if not already present.
static <E extends HTMLElement> void	lazyInsertBefore(IsElement<E> newElement, Element before)	Inserts element newElement into the parent before element before if not already present.
static HTMLContainerBuilder<HTMLLegendElement>	legend()
static HTMLContainerBuilder<HTMLLegendElement>	legend(Element element)
static HTMLContainerBuilder<HTMLLIElement>	li()
static HTMLContainerBuilder<HTMLLIElement>	li(Element element)
static HTMLContainerBuilder<HTMLElement>	main()
static HTMLContainerBuilder<HTMLElement>	main(Element element)
static HTMLContainerBuilder<HTMLMapElement>	map()
static HTMLContainerBuilder<HTMLMapElement>	map(Element element)
static HTMLContainerBuilder<HTMLElement>	mark()
static HTMLContainerBuilder<HTMLElement>	mark(Element element)
static HTMLContainerBuilder<HTMLElement>	mark(String text)
static HTMLContainerBuilder<HTMLMeterElement>	meter()
static HTMLContainerBuilder<HTMLMeterElement>	meter(Element element)
static HTMLContainerBuilder<HTMLMeterElement>	meter(String text)
static HTMLContainerBuilder<HTMLElement>	nav()
static HTMLContainerBuilder<HTMLElement>	nav(Element element)
static HTMLContainerBuilder<HTMLElement>	noscript()
static HTMLContainerBuilder<HTMLElement>	noscript(Element element)
static HTMLContainerBuilder<HTMLObjectElement>	object()
static HTMLContainerBuilder<HTMLObjectElement>	object(Element element)
static HTMLContainerBuilder<HTMLOListElement>	ol()
static HTMLContainerBuilder<HTMLOListElement>	ol(Element element)
static void	onAttach(HTMLElement element, ObserverCallback callback)	Registers a callback when an element is appended to the document body.
static <E extends HTMLElement> void	onAttach(IsElement<E> element, ObserverCallback callback)	Registers a callback when an element is appended to the document body.
static void	onDetach(HTMLElement element, ObserverCallback callback)	Registers a callback when an element is removed from the document body.
static <E extends HTMLElement> void	onDetach(IsElement<E> element, ObserverCallback callback)	Registers a callback when an element is removed from the document body.
static HTMLContainerBuilder<HTMLOptGroupElement>	optgroup()
static HTMLContainerBuilder<HTMLOptGroupElement>	optgroup(Element element)
static HTMLElementBuilder<HTMLOptionElement>	option()
static HTMLElementBuilder<HTMLOptionElement>	option(Element element)
static HTMLElementBuilder<HTMLOptionElement>	option(String text)
static HTMLContainerBuilder<HTMLOutputElement>	output()
static HTMLContainerBuilder<HTMLOutputElement>	output(Element element)
static HTMLContainerBuilder<HTMLOutputElement>	output(String text)
static HTMLContainerBuilder<HTMLParagraphElement>	p()
static HTMLContainerBuilder<HTMLParagraphElement>	p(Element element)
static HTMLElementBuilder<HTMLParamElement>	param()
static HTMLElementBuilder<HTMLParamElement>	param(Element element)
static HTMLContainerBuilder<HTMLPictureElement>	picture()
static HTMLContainerBuilder<HTMLPictureElement>	picture(Element element)
static HTMLContainerBuilder<HTMLPreElement>	pre()
static HTMLContainerBuilder<HTMLPreElement>	pre(Element element)
static HTMLContainerBuilder<HTMLProgressElement>	progress()
static HTMLContainerBuilder<HTMLProgressElement>	progress(Element element)
static HTMLContainerBuilder<HTMLQuoteElement>	q()
static HTMLContainerBuilder<HTMLQuoteElement>	q(Element element)
static HTMLContainerBuilder<HTMLQuoteElement>	q(String text)
static void	removeChildrenFrom(Element element)	Removes all child elements from element
static <E extends HTMLElement> void	removeChildrenFrom(IsElement<E> element)	Removes all child elements from element
static <E extends HTMLElement> ResizeObserverCleanup	resizeObserver(E element, ResizeCallback callback)	Register a resize observer for the given element.
static <E extends HTMLElement> ResizeObserverCleanup	resizeObserver(IsElement<E> element, ResizeCallback callback)	Register a resize observer for the given element.
static HTMLElementBuilder<HTMLScriptElement>	script()
static HTMLElementBuilder<HTMLScriptElement>	script(Element element)
static HTMLContainerBuilder<HTMLElement>	section()
static HTMLContainerBuilder<HTMLElement>	section(Element element)
static HTMLContainerBuilder<HTMLSelectElement>	select()
static HTMLContainerBuilder<HTMLSelectElement>	select(Element element)
static void	setVisible(HTMLElement element, boolean visible)	Shows / hide the specified element by modifying the display property.
static <E extends HTMLElement> void	setVisible(IsElement<E> element, boolean visible)	Shows / hide the specified element by modifying the display property.
static HTMLContainerBuilder<HTMLElement>	small()
static HTMLContainerBuilder<HTMLElement>	small(Element element)
static HTMLContainerBuilder<HTMLElement>	small(String text)
static HTMLElementBuilder<HTMLSourceElement>	source()
static HTMLElementBuilder<HTMLSourceElement>	source(Element element)
static HTMLContainerBuilder<HTMLElement>	span()
static HTMLContainerBuilder<HTMLElement>	span(Element element)
static Stream<HTMLElement>	stream(HTMLElement parent)	Returns a stream for the child elements of the given parent element.
static Stream<Node>	stream(Node parent)	Returns a stream for the child nodes of the given parent node.
static <E> Stream<E>	stream(jsinterop.base.JsArrayLike<E> nodes)	Returns a stream for the elements in the given array-like.
static <E extends HTMLElement> Stream<HTMLElement>	stream(IsElement<E> parent)	Returns a stream for the child elements of the given parent element.
static HTMLContainerBuilder<HTMLElement>	strong()
static HTMLContainerBuilder<HTMLElement>	strong(Element element)
static HTMLContainerBuilder<HTMLElement>	strong(String text)
static HTMLContainerBuilder<HTMLElement>	sub()
static HTMLContainerBuilder<HTMLElement>	sub(Element element)
static HTMLContainerBuilder<HTMLElement>	sub(String text)
static HTMLContainerBuilder<HTMLElement>	sup()
static HTMLContainerBuilder<HTMLElement>	sup(Element element)
static HTMLContainerBuilder<HTMLElement>	sup(String text)
static HTMLContainerBuilder<HTMLTableElement>	table()
static HTMLContainerBuilder<HTMLTableElement>	table(Element element)
static HTMLContainerBuilder<HTMLTableSectionElement>	tbody()
static HTMLContainerBuilder<HTMLTableSectionElement>	tbody(Element element)
static HTMLContainerBuilder<HTMLTableCellElement>	td()
static HTMLContainerBuilder<HTMLTableCellElement>	td(Element element)
static HTMLElementBuilder<HTMLTextAreaElement>	textarea()
static HTMLElementBuilder<HTMLTextAreaElement>	textarea(Element element)
static String	textNode(Element element)	Returns the text content of the given HTMLElement.
static <E extends Element> String	textNode(IsElement<E> element)	Returns the text content of the given element.
static HTMLContainerBuilder<HTMLTableSectionElement>	tfoot()
static HTMLContainerBuilder<HTMLTableSectionElement>	tfoot(Element element)
static HTMLContainerBuilder<HTMLTableCellElement>	th()
static HTMLContainerBuilder<HTMLTableCellElement>	th(Element element)
static HTMLContainerBuilder<HTMLTableSectionElement>	thead()
static HTMLContainerBuilder<HTMLTableSectionElement>	thead(Element element)
static HTMLContainerBuilder<HTMLElement>	time()
static HTMLContainerBuilder<HTMLElement>	time(Element element)
static HTMLContainerBuilder<HTMLElement>	time(String text)
static void	toggle(HTMLElement element, String css, boolean condition)	Adds the specified CSS class to the element if condition is true, removes it otherwise.
static void	toggle(HTMLElement element, String css, Supplier<Boolean> condition)	Adds the specified CSS class to the element if condition is true, removes it otherwise.
static <E extends HTMLElement> void	toggle(IsElement<E> element, String css, boolean condition)	Adds the specified CSS class to the element if condition is true, removes it otherwise.
static <E extends HTMLElement> void	toggle(IsElement<E> element, String css, Supplier<Boolean> condition)	Adds the specified CSS class to the element if condition is true, removes it otherwise.
static String	toString(Element element)
static <E extends Element> String	toString(IsElement<E> element)
static HTMLContainerBuilder<HTMLTableRowElement>	tr()
static HTMLContainerBuilder<HTMLTableRowElement>	tr(Element element)
static HTMLElementBuilder<HTMLTrackElement>	track()
static HTMLElementBuilder<HTMLTrackElement>	track(Element element)
static HTMLContainerBuilder<HTMLElement>	u()
static HTMLContainerBuilder<HTMLElement>	u(Element element)
static HTMLContainerBuilder<HTMLElement>	u(String text)
static HTMLContainerBuilder<HTMLUListElement>	ul()
static HTMLContainerBuilder<HTMLUListElement>	ul(Element element)
static String	uniqueId()	Deprecated. Replaced bv Id.unique()
static String	uniqueId(String id, String... additionalIds)	Deprecated. Replaced bv Id.unique(String, String...)
static HTMLContainerBuilder<HTMLElement>	var()
static HTMLContainerBuilder<HTMLElement>	var(Element element)
static HTMLContainerBuilder<HTMLElement>	var(String text)
static HTMLContainerBuilder<HTMLVideoElement>	video()
static HTMLContainerBuilder<HTMLVideoElement>	video(Element element)
static HTMLElementBuilder<HTMLElement>	wbr()
static HTMLElementBuilder<HTMLElement>	wbr(Element element)
static <E extends HTMLElement> HTMLContainerBuilder<E>	wrapHtmlContainer(E element)	Returns a builder for the existing HTML element.
static <E extends HTMLElement> HTMLElementBuilder<E>	wrapHtmlElement(E element)	Returns a builder for the existing HTML element.
static <E extends HTMLInputElement> InputElementBuilder<E>	wrapInputElement(E element)	Returns a builder for the existing input element.

Methods inherited from class java.lang.Object

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

Method Details

body

public static HTMLContainerBuilder<HTMLBodyElement> body()

Returns an HTML content builder for the document body.

address

public static HTMLContainerBuilder<HTMLElement> address()

address

public static HTMLContainerBuilder<HTMLElement> address(Element element)

article

public static HTMLContainerBuilder<HTMLElement> article()

article

public static HTMLContainerBuilder<HTMLElement> article(Element element)

aside

public static HTMLContainerBuilder<HTMLElement> aside()

aside

public static HTMLContainerBuilder<HTMLElement> aside(Element element)

footer

public static HTMLContainerBuilder<HTMLElement> footer()

footer

public static HTMLContainerBuilder<HTMLElement> footer(Element element)

h

public static HTMLContainerBuilder<HTMLHeadingElement> h(int n)

h

public static HTMLContainerBuilder<HTMLHeadingElement> h(int n,
 String text)

h

public static HTMLContainerBuilder<HTMLHeadingElement> h(Element element)

header

public static HTMLContainerBuilder<HTMLElement> header()

header

public static HTMLContainerBuilder<HTMLElement> header(Element element)

hgroup

public static HTMLContainerBuilder<HTMLElement> hgroup()

hgroup

public static HTMLContainerBuilder<HTMLElement> hgroup(Element element)

nav

public static HTMLContainerBuilder<HTMLElement> nav()

nav

public static HTMLContainerBuilder<HTMLElement> nav(Element element)

section

public static HTMLContainerBuilder<HTMLElement> section()

section

public static HTMLContainerBuilder<HTMLElement> section(Element element)

blockquote

public static HTMLContainerBuilder<HTMLQuoteElement> blockquote()

blockquote

public static HTMLContainerBuilder<HTMLQuoteElement> blockquote(Element element)

dd

public static HTMLContainerBuilder<HTMLElement> dd()

dd

public static HTMLContainerBuilder<HTMLElement> dd(Element element)

div

public static HTMLContainerBuilder<HTMLDivElement> div()

div

public static HTMLContainerBuilder<HTMLDivElement> div(Element element)

dl

public static HTMLContainerBuilder<HTMLDListElement> dl()

dl

public static HTMLContainerBuilder<HTMLDListElement> dl(Element element)

dt

public static HTMLContainerBuilder<HTMLElement> dt()

dt

public static HTMLContainerBuilder<HTMLElement> dt(Element element)

figcaption

public static HTMLContainerBuilder<HTMLElement> figcaption()

figcaption

public static HTMLContainerBuilder<HTMLElement> figcaption(Element element)

figure

public static HTMLContainerBuilder<HTMLElement> figure()

figure

public static HTMLContainerBuilder<HTMLElement> figure(Element element)

hr

public static HTMLElementBuilder<HTMLHRElement> hr()

hr

public static HTMLElementBuilder<HTMLHRElement> hr(Element element)

li

public static HTMLContainerBuilder<HTMLLIElement> li()

li

public static HTMLContainerBuilder<HTMLLIElement> li(Element element)

main

public static HTMLContainerBuilder<HTMLElement> main()

main

public static HTMLContainerBuilder<HTMLElement> main(Element element)

ol

public static HTMLContainerBuilder<HTMLOListElement> ol()

ol

public static HTMLContainerBuilder<HTMLOListElement> ol(Element element)

p

public static HTMLContainerBuilder<HTMLParagraphElement> p()

p

public static HTMLContainerBuilder<HTMLParagraphElement> p(Element element)

pre

public static HTMLContainerBuilder<HTMLPreElement> pre()

pre

public static HTMLContainerBuilder<HTMLPreElement> pre(Element element)

ul

public static HTMLContainerBuilder<HTMLUListElement> ul()

ul

public static HTMLContainerBuilder<HTMLUListElement> ul(Element element)

a

public static HTMLContainerBuilder<HTMLAnchorElement> a()

a

public static HTMLContainerBuilder<HTMLAnchorElement> a(String href)

a

public static HTMLContainerBuilder<HTMLAnchorElement> a(String href,
 String target)

a

public static HTMLContainerBuilder<HTMLAnchorElement> a(Element element)

abbr

public static HTMLContainerBuilder<HTMLElement> abbr()

abbr

public static HTMLContainerBuilder<HTMLElement> abbr(String text)

abbr

public static HTMLContainerBuilder<HTMLElement> abbr(Element element)

b

public static HTMLContainerBuilder<HTMLElement> b()

b

public static HTMLContainerBuilder<HTMLElement> b(String text)

b

public static HTMLContainerBuilder<HTMLElement> b(Element element)

br

public static HTMLElementBuilder<HTMLBRElement> br()

br

public static HTMLElementBuilder<HTMLBRElement> br(Element element)

cite

public static HTMLContainerBuilder<HTMLElement> cite()

cite

public static HTMLContainerBuilder<HTMLElement> cite(String text)

cite

public static HTMLContainerBuilder<HTMLElement> cite(Element element)

code

public static HTMLContainerBuilder<HTMLElement> code()

code

public static HTMLContainerBuilder<HTMLElement> code(String text)

code

public static HTMLContainerBuilder<HTMLElement> code(Element element)

dfn

public static HTMLContainerBuilder<HTMLElement> dfn()

dfn

public static HTMLContainerBuilder<HTMLElement> dfn(String text)

dfn

public static HTMLContainerBuilder<HTMLElement> dfn(Element element)

em

public static HTMLContainerBuilder<HTMLElement> em()

em

public static HTMLContainerBuilder<HTMLElement> em(String text)

em

public static HTMLContainerBuilder<HTMLElement> em(Element element)

i

public static HTMLContainerBuilder<HTMLElement> i()

i

public static HTMLContainerBuilder<HTMLElement> i(String text)

i

public static HTMLContainerBuilder<HTMLElement> i(Element element)

kbd

public static HTMLContainerBuilder<HTMLElement> kbd()

kbd

public static HTMLContainerBuilder<HTMLElement> kbd(String text)

kbd

public static HTMLContainerBuilder<HTMLElement> kbd(Element element)

mark

public static HTMLContainerBuilder<HTMLElement> mark()

mark

public static HTMLContainerBuilder<HTMLElement> mark(String text)

mark

public static HTMLContainerBuilder<HTMLElement> mark(Element element)

q

public static HTMLContainerBuilder<HTMLQuoteElement> q()

q

public static HTMLContainerBuilder<HTMLQuoteElement> q(String text)

q

public static HTMLContainerBuilder<HTMLQuoteElement> q(Element element)

small

public static HTMLContainerBuilder<HTMLElement> small()

small

public static HTMLContainerBuilder<HTMLElement> small(String text)

small

public static HTMLContainerBuilder<HTMLElement> small(Element element)

span

public static HTMLContainerBuilder<HTMLElement> span()

span

public static HTMLContainerBuilder<HTMLElement> span(Element element)

strong

public static HTMLContainerBuilder<HTMLElement> strong()

strong

public static HTMLContainerBuilder<HTMLElement> strong(String text)

strong

public static HTMLContainerBuilder<HTMLElement> strong(Element element)

sub

public static HTMLContainerBuilder<HTMLElement> sub()

sub

public static HTMLContainerBuilder<HTMLElement> sub(String text)

sub

public static HTMLContainerBuilder<HTMLElement> sub(Element element)

sup

public static HTMLContainerBuilder<HTMLElement> sup()

sup

public static HTMLContainerBuilder<HTMLElement> sup(String text)

sup

public static HTMLContainerBuilder<HTMLElement> sup(Element element)

time

public static HTMLContainerBuilder<HTMLElement> time()

time

public static HTMLContainerBuilder<HTMLElement> time(String text)

time

public static HTMLContainerBuilder<HTMLElement> time(Element element)

u

public static HTMLContainerBuilder<HTMLElement> u()

u

public static HTMLContainerBuilder<HTMLElement> u(String text)

u

public static HTMLContainerBuilder<HTMLElement> u(Element element)

var

public static HTMLContainerBuilder<HTMLElement> var()

var

public static HTMLContainerBuilder<HTMLElement> var(String text)

var

public static HTMLContainerBuilder<HTMLElement> var(Element element)

wbr

public static HTMLElementBuilder<HTMLElement> wbr()

wbr

public static HTMLElementBuilder<HTMLElement> wbr(Element element)

area

public static HTMLElementBuilder<HTMLAreaElement> area()

area

public static HTMLElementBuilder<HTMLAreaElement> area(Element element)

audio

public static HTMLContainerBuilder<HTMLAudioElement> audio()

audio

public static HTMLContainerBuilder<HTMLAudioElement> audio(Element element)

img

public static HTMLElementBuilder<HTMLImageElement> img()

img

public static HTMLElementBuilder<HTMLImageElement> img(String src)

img

public static HTMLElementBuilder<HTMLImageElement> img(Element element)

map

public static HTMLContainerBuilder<HTMLMapElement> map()

map

public static HTMLContainerBuilder<HTMLMapElement> map(Element element)

picture

public static HTMLContainerBuilder<HTMLPictureElement> picture()

picture

public static HTMLContainerBuilder<HTMLPictureElement> picture(Element element)

track

public static HTMLElementBuilder<HTMLTrackElement> track()

track

public static HTMLElementBuilder<HTMLTrackElement> track(Element element)

video

public static HTMLContainerBuilder<HTMLVideoElement> video()

video

public static HTMLContainerBuilder<HTMLVideoElement> video(Element element)

canvas

public static HTMLContainerBuilder<HTMLCanvasElement> canvas()

canvas

public static HTMLContainerBuilder<HTMLCanvasElement> canvas(Element element)

embed

public static HTMLElementBuilder<HTMLEmbedElement> embed()

embed

public static HTMLElementBuilder<HTMLEmbedElement> embed(Element element)

iframe

public static HTMLContainerBuilder<HTMLIFrameElement> iframe()

iframe

public static HTMLContainerBuilder<HTMLIFrameElement> iframe(String src)

iframe

public static HTMLContainerBuilder<HTMLIFrameElement> iframe(Element element)

object

public static HTMLContainerBuilder<HTMLObjectElement> object()

object

public static HTMLContainerBuilder<HTMLObjectElement> object(Element element)

param

public static HTMLElementBuilder<HTMLParamElement> param()

param

public static HTMLElementBuilder<HTMLParamElement> param(Element element)

source

public static HTMLElementBuilder<HTMLSourceElement> source()

source

public static HTMLElementBuilder<HTMLSourceElement> source(Element element)

noscript

public static HTMLContainerBuilder<HTMLElement> noscript()

noscript

public static HTMLContainerBuilder<HTMLElement> noscript(Element element)

script

public static HTMLElementBuilder<HTMLScriptElement> script()

script

public static HTMLElementBuilder<HTMLScriptElement> script(Element element)

del

public static HTMLContainerBuilder<HTMLModElement> del()

del

public static HTMLContainerBuilder<HTMLModElement> del(String text)

del

public static HTMLContainerBuilder<HTMLModElement> del(Element element)

ins

public static HTMLContainerBuilder<HTMLModElement> ins()

ins

public static HTMLContainerBuilder<HTMLModElement> ins(String text)

ins

public static HTMLContainerBuilder<HTMLModElement> ins(Element element)

caption

public static HTMLContainerBuilder<HTMLTableCaptionElement> caption()

caption

public static HTMLContainerBuilder<HTMLTableCaptionElement> caption(Element element)

col

public static HTMLElementBuilder<HTMLTableColElement> col()

col

public static HTMLElementBuilder<HTMLTableColElement> col(Element element)

colgroup

public static HTMLContainerBuilder<HTMLTableColElement> colgroup()

colgroup

public static HTMLContainerBuilder<HTMLTableColElement> colgroup(Element element)

table

public static HTMLContainerBuilder<HTMLTableElement> table()

table

public static HTMLContainerBuilder<HTMLTableElement> table(Element element)

tbody

public static HTMLContainerBuilder<HTMLTableSectionElement> tbody()

tbody

public static HTMLContainerBuilder<HTMLTableSectionElement> tbody(Element element)

td

public static HTMLContainerBuilder<HTMLTableCellElement> td()

td

public static HTMLContainerBuilder<HTMLTableCellElement> td(Element element)

tfoot

public static HTMLContainerBuilder<HTMLTableSectionElement> tfoot()

tfoot

public static HTMLContainerBuilder<HTMLTableSectionElement> tfoot(Element element)

th

public static HTMLContainerBuilder<HTMLTableCellElement> th()

th

public static HTMLContainerBuilder<HTMLTableCellElement> th(Element element)

thead

public static HTMLContainerBuilder<HTMLTableSectionElement> thead()

thead

public static HTMLContainerBuilder<HTMLTableSectionElement> thead(Element element)

tr

public static HTMLContainerBuilder<HTMLTableRowElement> tr()

tr

public static HTMLContainerBuilder<HTMLTableRowElement> tr(Element element)

button

public static HTMLContainerBuilder<HTMLButtonElement> button()

button

public static HTMLContainerBuilder<HTMLButtonElement> button(String text)

button

public static HTMLContainerBuilder<HTMLButtonElement> button(Element element)

datalist

public static HTMLContainerBuilder<HTMLDataListElement> datalist()

datalist

public static HTMLContainerBuilder<HTMLDataListElement> datalist(Element element)

fieldset

public static HTMLContainerBuilder<HTMLFieldSetElement> fieldset()

fieldset

public static HTMLContainerBuilder<HTMLFieldSetElement> fieldset(Element element)

form

public static HTMLContainerBuilder<HTMLFormElement> form()

form

public static HTMLContainerBuilder<HTMLFormElement> form(Element element)

input

public static InputElementBuilder<HTMLInputElement> input(InputType type)

input

public static InputElementBuilder<HTMLInputElement> input(String type)

input

public static <E extends HTMLInputElement>
InputElementBuilder<E> input(String type,
 Class<E> jType)

input

public static InputElementBuilder<HTMLInputElement> input(Element element)

label

public static HTMLContainerBuilder<HTMLLabelElement> label()

label

public static HTMLContainerBuilder<HTMLLabelElement> label(String text)

label

public static HTMLContainerBuilder<HTMLLabelElement> label(Element element)

legend

public static HTMLContainerBuilder<HTMLLegendElement> legend()

legend

public static HTMLContainerBuilder<HTMLLegendElement> legend(Element element)

meter

public static HTMLContainerBuilder<HTMLMeterElement> meter()

meter

public static HTMLContainerBuilder<HTMLMeterElement> meter(String text)

meter

public static HTMLContainerBuilder<HTMLMeterElement> meter(Element element)

optgroup

public static HTMLContainerBuilder<HTMLOptGroupElement> optgroup()

optgroup

public static HTMLContainerBuilder<HTMLOptGroupElement> optgroup(Element element)

option

public static HTMLElementBuilder<HTMLOptionElement> option()

option

public static HTMLElementBuilder<HTMLOptionElement> option(String text)

option

public static HTMLElementBuilder<HTMLOptionElement> option(Element element)

output

public static HTMLContainerBuilder<HTMLOutputElement> output()

output

public static HTMLContainerBuilder<HTMLOutputElement> output(String text)

output

public static HTMLContainerBuilder<HTMLOutputElement> output(Element element)

progress

public static HTMLContainerBuilder<HTMLProgressElement> progress()

progress

public static HTMLContainerBuilder<HTMLProgressElement> progress(Element element)

select

public static HTMLContainerBuilder<HTMLSelectElement> select()

select

public static HTMLContainerBuilder<HTMLSelectElement> select(Element element)

textarea

public static HTMLElementBuilder<HTMLTextAreaElement> textarea()

textarea

public static HTMLElementBuilder<HTMLTextAreaElement> textarea(Element element)

bag

public static ElementsBag bag()

Returns a builder to collect HTMLElements.

ElementsBag bag = bag();
Map<String, Todo> data = ...;
data.forEach((text, todo) -> {
    bag.add(dt().textContent(text));
    bag.add(dd().add(new TodoElement(todo)));
});
HTMLDListElement element = dl().addAll(bag.elements()).element();

htmlElement

public static <E extends HTMLElement>
HTMLElementBuilder<E> htmlElement(String element,
 Class<E> type)

Returns a builder for the specified HTML element.

wrapHtmlElement

public static <E extends HTMLElement>
HTMLElementBuilder<E> wrapHtmlElement(E element)

Returns a builder for the existing HTML element.

inputElement

public static <E extends HTMLInputElement>
InputElementBuilder<E> inputElement(String type,
 Class<E> jType)

Returns a builder for the specified input element.

wrapInputElement

public static <E extends HTMLInputElement>
InputElementBuilder<E> wrapInputElement(E element)

Returns a builder for the existing input element.

htmlContainer

public static <E extends HTMLElement>
HTMLContainerBuilder<E> htmlContainer(String element,
 Class<E> type)

Returns a builder for the specified HTML element.

wrapHtmlContainer

public static <E extends HTMLElement>
HTMLContainerBuilder<E> wrapHtmlContainer(E element)

Returns a builder for the existing HTML element.

createHtmlElement

public static <E extends HTMLElement> E createHtmlElement(String element,
 Class<E> type)

Creates the specified HTML element.

findAll

public static Iterable<HTMLElement> findAll(Node node,
 By selector)

Finds all HTML elements for the given selector.

findAll

public static <E extends HTMLElement>
Iterable<HTMLElement> findAll(IsElement<E> element,
 By selector)

Finds all HTML elements for the given selector.

find

public static <E extends HTMLElement> E find(Node node,
 By selector)

Finds a single HTML elements for the given selector.

find

public static <E extends HTMLElement,
F extends HTMLElement>
F find(IsElement<E> element,
 By selector)

Finds a single HTML elements for the given selector.

closest

public static <E extends HTMLElement> E closest(Element element,
 By selector)

Finds the closest HTML elements for the given selector.

See Also:

• https://developer.mozilla.org/en-US/docs/Web/API/Element/closest

closest

public static <E extends HTMLElement,
F extends HTMLElement>
F closest(IsElement<E> element,
 By selector)

Finds the closest HTML elements for the given selector.

See Also:

• https://developer.mozilla.org/en-US/docs/Web/API/Element/closest

iterator

public static <E> Iterator<E> iterator(jsinterop.base.JsArrayLike<E> data)

Returns an iterator over the given array-like. The iterator does not support the Iterator.remove() operation.

iterator

public static Iterator<Node> iterator(Node parent)

Returns an iterator over the children of the given parent node. The iterator supports the Iterator.remove() operation, which removes the current node from its parent.

iterator

public static Iterator<HTMLElement> iterator(HTMLElement parent)

Returns an iterator over the children of the given parent element. The iterator supports the Iterator.remove() operation, which removes the current node from its parent.

iterator

public static <E extends HTMLElement>
Iterator<HTMLElement> iterator(IsElement<E> parent)

Returns an iterator over the children of the given parent element. The iterator supports the Iterator.remove() operation, which removes the current node from its parent.

elements

public static <E> Iterable<E> elements(jsinterop.base.JsArrayLike<E> nodes)

Returns an iterable for the elements in the given array-like.

children

public static Iterable<Node> children(Node parent)

Returns an iterable for the child nodes of the given parent node.

children

public static Iterable<HTMLElement> children(HTMLElement parent)

Returns an iterable for the child elements of the given parent element.

children

public static <E extends HTMLElement>
Iterable<HTMLElement> children(IsElement<E> parent)

Returns an iterable for the child elements of the given parent element.

htmlElements

public static <T extends Node> Predicate<T> htmlElements()

Returns a predicate for HTML elements. Useful in streams of nodes or elements.

asHtmlElement

public static <T extends Node>
Function<T,HTMLElement> asHtmlElement()

Casts to HTMLElement. Make sure to filter for HTML elements before using this function.

stream

public static <E> Stream<E> stream(jsinterop.base.JsArrayLike<E> nodes)

Returns a stream for the elements in the given array-like.

HTMLElement parent = find(body(), By.data("foo", "bar"));
if (parent != null) {
    List<HTMLElement> htmlElements = stream(parent)
            .filter(htmlElements())
            .map(asHtmlElement())
            .collect(toList());
}

stream

public static Stream<Node> stream(Node parent)

Returns a stream for the child nodes of the given parent node.

HTMLElement parent = find(body(), By.data("foo", "bar"));
if (parent != null) {
    List<HTMLElement> htmlElements = stream(parent)
            .filter(htmlElements())
            .map(asHtmlElement())
            .collect(toList());
}

stream

public static Stream<HTMLElement> stream(HTMLElement parent)

Returns a stream for the child elements of the given parent element.

HTMLElement parent = find(body(), By.data("foo", "bar"));
if (parent != null) {
    List<HTMLElement> htmlElements = stream(parent)
            .filter(htmlElements())
            .map(asHtmlElement())
            .collect(toList());
}

stream

public static <E extends HTMLElement>
Stream<HTMLElement> stream(IsElement<E> parent)

Returns a stream for the child elements of the given parent element.

HTMLElement parent = find(body(), By.data("foo", "bar"));
if (parent != null) {
    List<HTMLElement> htmlElements = stream(parent)
            .filter(htmlElements())
            .map(asHtmlElement())
            .collect(toList());
}

lazyAppend

public static void lazyAppend(Element parent,
 Element child)

Appends element child to element parent if not already present. If parent already contains child, this method does nothing.

lazyAppend

public static <E extends HTMLElement> void lazyAppend(Element parent,
 IsElement<E> child)

Appends element child to element parent if not already present. If parent already contains child, this method does nothing.

insertAfter

public static void insertAfter(Element newElement,
 Element after)

Inserts element newElement into the parent after element after.

insertAfter

public static <E extends HTMLElement> void insertAfter(IsElement<E> newElement,
 Element after)

Inserts element newElement into the parent after element after.

lazyInsertAfter

public static void lazyInsertAfter(Element newElement,
 Element after)

Inserts element newElement into the parent after element after if not already present. If parent already contains newElement, this method does nothing.

lazyInsertAfter

public static <E extends HTMLElement> void lazyInsertAfter(IsElement<E> newElement,
 Element after)

Inserts element newElement into the parent after element after if not already present. If parent already contains newElement, this method does nothing.

lazyInsertAfter

public static void lazyInsertAfter(Element parent,
 Element newElement,
 Element after)

Inserts element newElement into the parent after element after if not already present. If parent already contains newElement, this method does nothing.

lazyInsertAfter

public static <E extends HTMLElement> void lazyInsertAfter(Element parent,
 IsElement<E> newElement,
 Element after)

Inserts element newElement into the parent after element after if not already present. If parent already contains newElement, this method does nothing.

insertBefore

public static void insertBefore(Element newElement,
 Element before)

Inserts element newElement into the parent before element before.

insertBefore

public static <E extends HTMLElement> void insertBefore(IsElement<E> newElement,
 Element before)

Inserts element newElement into the parent before element before.

lazyInsertBefore

public static void lazyInsertBefore(Element newElement,
 Element before)

Inserts element newElement into the parent before element before if not already present. If parent already contains newElement, this method does nothing.

lazyInsertBefore

public static <E extends HTMLElement> void lazyInsertBefore(IsElement<E> newElement,
 Element before)

Inserts element newElement into the parent before element before if not already present. If parent already contains newElement, this method does nothing.

lazyInsertBefore

public static void lazyInsertBefore(Element parent,
 Element newElement,
 Element before)

Inserts element newElement into the parent before element before if not already present. If parent already contains newElement, this method does nothing.

lazyInsertBefore

public static <E extends HTMLElement> void lazyInsertBefore(Element parent,
 IsElement<E> newElement,
 Element before)

Inserts element newElement into the parent before element before if not already present. If parent already contains newElement, this method does nothing.

insertFirst

public static void insertFirst(Element parent,
 Element newElement)

Inserts element newElement as first element into parent.

insertFirst

public static <E extends HTMLElement> void insertFirst(Element parent,
 IsElement<E> newElement)

Inserts element newElement as first element into parent.

removeChildrenFrom

public static void removeChildrenFrom(Element element)

Removes all child elements from element

removeChildrenFrom

public static <E extends HTMLElement> void removeChildrenFrom(IsElement<E> element)

Removes all child elements from element

failSafeRemoveFromParent

public static boolean failSafeRemoveFromParent(Element element)

Removes the element from its parent if the element is not null and has a parent.

Returns:

true if the element has been removed from its parent, false otherwise.

failSafeRemoveFromParent

public static <E extends HTMLElement> boolean failSafeRemoveFromParent(IsElement<E> element)

Removes the element from its parent if the element is not null and has a parent.

Returns:

true if the element has been removed from its parent, false otherwise.

failSafeRemove

public static boolean failSafeRemove(Node parent,
 Element child)

Removes the child from parent if both parent and child are not null and parent contains child.

Returns:

true if the element has been removed from its parent, false otherwise.

failSafeRemove

public static <E extends HTMLElement> boolean failSafeRemove(Node parent,
 IsElement<E> child)

Removes the child from parent if both parent and child are not null and parent contains child.

Returns:

true if the element has been removed from its parent, false otherwise.

isAttached

public static <E extends HTMLElement> boolean isAttached(IsElement<E> element)

Returns true if the element is connected by calling Node.isConnected on the element's IsElement.element().

See Also:

• https://developer.mozilla.org/en-US/docs/Web/API/Node/isConnected
• https://dom.spec.whatwg.org/#dom-node-isconnected

isAttached

public static boolean isAttached(Node node)

Fail-safe shortcut for Node.isConnected

See Also:

• https://developer.mozilla.org/en-US/docs/Web/API/Node/isConnected
• https://dom.spec.whatwg.org/#dom-node-isconnected

onAttach

public static void onAttach(HTMLElement element,
 ObserverCallback callback)

Registers a callback when an element is appended to the document body. Note that the callback will be called only once, if the element is appended more than once a new callback should be registered.

Parameters:

element - the HTML element which is going to be added to the body

callback - ObserverCallback

onAttach

public static <E extends HTMLElement> void onAttach(IsElement<E> element,
 ObserverCallback callback)

Registers a callback when an element is appended to the document body. Note that the callback will be called only once, if the element is appended more than once a new callback should be registered.

Parameters:

element - the element which is going to be added to the body

callback - ObserverCallback

onDetach

public static void onDetach(HTMLElement element,
 ObserverCallback callback)

Registers a callback when an element is removed from the document body. Note that the callback will be called only once, if the element is removed and re-appended a new callback should be registered.

Parameters:

element - the HTML element which is going to be removed from the body

callback - ObserverCallback

onDetach

public static <E extends HTMLElement> void onDetach(IsElement<E> element,
 ObserverCallback callback)

Registers a callback when an element is removed from the document body. Note that the callback will be called only once, if the element is removed and re-appended a new callback should be registered.

Parameters:

element - the element which is going to be removed from the body

callback - ObserverCallback

isVisible

public static boolean isVisible(HTMLElement element)

Checks whether the given element is visible (i.e. display is not none)

isVisible

public static <E extends HTMLElement> boolean isVisible(IsElement<E> element)

Checks whether the given element is visible (i.e. display is not none)

setVisible

public static void setVisible(HTMLElement element,
 boolean visible)

Shows / hide the specified element by modifying the display property.

setVisible

public static <E extends HTMLElement> void setVisible(IsElement<E> element,
 boolean visible)

Shows / hide the specified element by modifying the display property.

isElementInView

public static <E extends HTMLElement> boolean isElementInView(IsElement<E> container,
 HTMLElement element,
 boolean partial)

isElementInView

public static <E extends HTMLElement> boolean isElementInView(HTMLElement container,
 IsElement<E> element,
 boolean partial)

isElementInView

public static <E extends HTMLElement,
F extends HTMLElement>
boolean isElementInView(IsElement<E> container,
 IsElement<F> element,
 boolean partial)

isElementInView

public static boolean isElementInView(HTMLElement container,
 HTMLElement element,
 boolean partial)

This function returns whether an element is within the viewable area of a container. If partial is true, then this function will return true even if only part of the element is in view.

Parameters:

container - The container to check if the element is in view of.

element - The element to check if it is view

partial - true if partial view is allowed

Returns:

true if the component is in view.

resizeObserver

public static <E extends HTMLElement>
ResizeObserverCleanup resizeObserver(IsElement<E> element,
 ResizeCallback callback)

Register a resize observer for the given element. The observer will call the provided callback whenever the size of the element changes.

Uses the native ResizeObserver if available. Falls back to window.addEventListener("resize", callback), otherwise.

Type Parameters:

E - The type of element being observed, which must extend from HTMLElement.

Parameters:

element - The element to observe for size changes.

callback - The callback function to be called when the size of the element changes.

Returns:

A cleanup function that can be used to unregister the observer.

resizeObserver

public static <E extends HTMLElement>
ResizeObserverCleanup resizeObserver(E element,
 ResizeCallback callback)

Register a resize observer for the given element. The observer will call the provided callback whenever the size of the element changes.

Uses the native ResizeObserver if available. Falls back to window.addEventListener("resize", callback), otherwise.

Type Parameters:

E - The type of element being observed, which must extend from HTMLElement.

Parameters:

element - The element to observe for size changes.

callback - The callback function to be called when the size of the element changes.

Returns:

A cleanup function that can be used to unregister the observer.

toggle

public static void toggle(HTMLElement element,
 String css,
 boolean condition)

Adds the specified CSS class to the element if condition is true, removes it otherwise.

toggle

public static <E extends HTMLElement> void toggle(IsElement<E> element,
 String css,
 boolean condition)

Adds the specified CSS class to the element if condition is true, removes it otherwise.

toggle

public static void toggle(HTMLElement element,
 String css,
 Supplier<Boolean> condition)

Adds the specified CSS class to the element if condition is true, removes it otherwise.

toggle

public static <E extends HTMLElement> void toggle(IsElement<E> element,
 String css,
 Supplier<Boolean> condition)

Adds the specified CSS class to the element if condition is true, removes it otherwise.

innerHtml

public static void innerHtml(HTMLElement element,
 SafeHtml html)

Convenience method to set the inner HTML of the given element.

innerHtml

public static <E extends HTMLElement> void innerHtml(IsElement<E> element,
 SafeHtml html)

Convenience method to set the inner HTML of the given element.

textNode

public static String textNode(Element element)

Returns the text content of the given HTMLElement.

Parameters:

element - The HTMLElement to retrieve the text content from.

Returns:

The text content of the HTMLElement. If there is a text node present, returns the value of the text node. If there is no text node, returns the text content of the element.

textNode

public static <E extends Element> String textNode(IsElement<E> element)

Returns the text content of the given element.

Type Parameters:

E - the type constraint for the element

Parameters:

element - the element from which to extract the text content

Returns:

the text content of the element, or null if the element is null

toString

public static <E extends Element> String toString(IsElement<E> element)

toString

public static String toString(Element element)

uniqueId

@Deprecated
public static String uniqueId()

Deprecated.

Replaced bv Id.unique()

uniqueId

@Deprecated
public static String uniqueId(String id,
 String... additionalIds)

Deprecated.

Replaced bv Id.unique(String, String...)

buildId

@Deprecated
public static String buildId(String id,
 String... additionalIds)

Deprecated.

Replaced bv Id.build(String, String...)