org.dominokit.domino.ui.utils

Class ElementUtil

java.lang.Object

org.dominokit.domino.ui.utils.ElementUtil

public class ElementUtil
extends Object

A general purpose utility class

Constructor Summary

Constructors

Constructor and Description
ElementUtil()

Method Summary

Modifier and Type	Method and Description
static void	clear(elemental2.dom.Element element) Removes all the children of the element
static void	clear(org.jboss.elemento.IsElement<?> element) Removes all the children of the element
static <E extends elemental2.dom.HTMLElement> org.jboss.elemento.HtmlContentBuilder<E>	contentBuilder(E element)
static <E extends elemental2.dom.HTMLElement> org.jboss.elemento.HtmlContentBuilder<E>	contentBuilder(org.jboss.elemento.IsElement<E> element)
static <T extends HasInputElement> T	decimalOnly(T hasInputElement) Force an input component to accept only numbers input with decimal characters
static boolean	isArrowDown(elemental2.dom.KeyboardEvent keyboardEvent)
static boolean	isArrowUp(elemental2.dom.KeyboardEvent keyboardEvent)
static boolean	isEnterKey(elemental2.dom.KeyboardEvent keyboardEvent)
static boolean	isEscapeKey(elemental2.dom.KeyboardEvent keyboardEvent)
static boolean	isKeyOf(String keyCode, elemental2.dom.KeyboardEvent keyboardEvent)
static boolean	isSpaceKey(elemental2.dom.KeyboardEvent keyboardEvent)
static boolean	isTabKey(elemental2.dom.KeyboardEvent keyboardEvent)
static <T extends HasInputElement> T	numbersOnly(T hasInputElement) Force an input component to accept only numbers inputs
static Optional<ElementObserver>	onAttach(elemental2.dom.HTMLElement element, org.jboss.elemento.ObserverCallback callback) Registers a callback when an element is appended to the document body.
static Optional<ElementObserver>	onAttach(org.jboss.elemento.IsElement<?> element, org.jboss.elemento.ObserverCallback callback) onAttach(HTMLElement, ObserverCallback)
static Optional<ElementObserver>	onDetach(elemental2.dom.HTMLElement element, org.jboss.elemento.ObserverCallback callback) Registers a callback when an element is removed from the document body.
static Optional<ElementObserver>	onDetach(org.jboss.elemento.IsElement<?> element, org.jboss.elemento.ObserverCallback callback) onDetach(HTMLElement, ObserverCallback)
static elemental2.dom.HTMLAnchorElement	openInNewTabLink(String text, String targetUrl) Creates an HTMLAnchorElement that opens it target link in a new browser tab
static void	scrollIntoParent(elemental2.dom.Element child, elemental2.dom.Element parent) Scrolls a parent to make child visible in the browser window
static void	scrollToElement(elemental2.dom.HTMLElement element) Scrolls the document to the specified element, making the element visible on the screen
static void	scrollToElement(org.jboss.elemento.IsElement<?> isElement) Scrolls the document to the specified element, making the element visible on the screen
static void	scrollTop() Scroll the document body to the top of the page

Methods inherited from class java.lang.Object

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

Constructor Detail

ElementUtil

public ElementUtil()

Method Detail

clear

public static void clear(elemental2.dom.Element element)

Removes all the children of the element

Parameters:

element - Element

clear

public static void clear(org.jboss.elemento.IsElement<?> element)

Removes all the children of the element

Parameters:

element - IsElement

contentBuilder

public static <E extends elemental2.dom.HTMLElement> org.jboss.elemento.HtmlContentBuilder<E> contentBuilder(E element)

Type Parameters:

E - the type extending from HTMLElement

Parameters:

element - the target element

Returns:

new HtmlContentBuilder for the provided element

contentBuilder

public static <E extends elemental2.dom.HTMLElement> org.jboss.elemento.HtmlContentBuilder<E> contentBuilder(org.jboss.elemento.IsElement<E> element)

Type Parameters:

E - the type extending from HTMLElement

Parameters:

element - the target IsElement

Returns:

new HtmlContentBuilder for the provided element

isKeyOf

public static boolean isKeyOf(String keyCode,
                              elemental2.dom.KeyboardEvent keyboardEvent)

Parameters:

keyCode - String keyboard key code

keyboardEvent - KeyboardEvent

Returns:

boolean, true if the the KeyCode is same as the key of the KeyboradEvent

isEnterKey

public static boolean isEnterKey(elemental2.dom.KeyboardEvent keyboardEvent)

Parameters:

keyboardEvent - KeyboardEvent

Returns:

boolean, true if the Key pressed is Enter key

isSpaceKey

public static boolean isSpaceKey(elemental2.dom.KeyboardEvent keyboardEvent)

Parameters:

keyboardEvent - KeyboardEvent

Returns:

boolean, true if the Key pressed is Space key

isArrowDown

public static boolean isArrowDown(elemental2.dom.KeyboardEvent keyboardEvent)

Parameters:

keyboardEvent - KeyboardEvent

Returns:

boolean, true if the Key pressed is Arrow down key

isArrowUp

public static boolean isArrowUp(elemental2.dom.KeyboardEvent keyboardEvent)

Parameters:

keyboardEvent - KeyboardEvent

Returns:

boolean, true if the Key pressed is Arrow up key

isTabKey

public static boolean isTabKey(elemental2.dom.KeyboardEvent keyboardEvent)

Parameters:

keyboardEvent - KeyboardEvent

Returns:

boolean, true if the Key pressed is Tab key

isEscapeKey

public static boolean isEscapeKey(elemental2.dom.KeyboardEvent keyboardEvent)

Parameters:

keyboardEvent - KeyboardEvent

Returns:

boolean, true if the Key pressed is Escape key

onAttach

public static Optional<ElementObserver> onAttach(elemental2.dom.HTMLElement element,
                                                 org.jboss.elemento.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 HTMLElement which is going to be added to the body

callback - ObserverCallback

Returns:

an Optional ElementObserver

onAttach

public static Optional<ElementObserver> onAttach(org.jboss.elemento.IsElement<?> element,
                                                 org.jboss.elemento.ObserverCallback callback)

onAttach(HTMLElement, ObserverCallback)

Parameters:

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

callback - ObserverCallback

Returns:

an Optional ElementObserver

onDetach

public static Optional<ElementObserver> onDetach(elemental2.dom.HTMLElement element,
                                                 org.jboss.elemento.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 HTMLElement which is going to be removed from the body

callback - ObserverCallback

Returns:

an Optional ElementObserver

onDetach

public static Optional<ElementObserver> onDetach(org.jboss.elemento.IsElement<?> element,
                                                 org.jboss.elemento.ObserverCallback callback)

onDetach(HTMLElement, ObserverCallback)

Parameters:

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

callback - ObserverCallback

Returns:

an Optional ElementObserver

numbersOnly

public static <T extends HasInputElement> T numbersOnly(T hasInputElement)

Force an input component to accept only numbers inputs

Type Parameters:

T - The type of the component that extends from HasInputElement

Parameters:

hasInputElement - HasInputElement

Returns:

same component

decimalOnly

public static <T extends HasInputElement> T decimalOnly(T hasInputElement)

Force an input component to accept only numbers input with decimal characters

Type Parameters:

T - The type of the component that extends from HasInputElement

Parameters:

hasInputElement - HasInputElement

Returns:

same component

scrollTop

public static void scrollTop()

Scroll the document body to the top of the page

scrollToElement

public static void scrollToElement(org.jboss.elemento.IsElement<?> isElement)

Scrolls the document to the specified element, making the element visible on the screen

Parameters:

isElement - IsElement

scrollToElement

public static void scrollToElement(elemental2.dom.HTMLElement element)

Scrolls the document to the specified element, making the element visible on the screen

Parameters:

element - HTMLElement

openInNewTabLink

public static elemental2.dom.HTMLAnchorElement openInNewTabLink(String text,
                                                                String targetUrl)

Creates an HTMLAnchorElement that opens it target link in a new browser tab

Parameters:

text - String link text

targetUrl - String link target url

Returns:

new HTMLAnchorElement instance

scrollIntoParent

public static void scrollIntoParent(elemental2.dom.Element child,
                                    elemental2.dom.Element parent)

Scrolls a parent to make child visible in the browser window

Parameters:

child - Element

parent - Element