org.dominokit.domino.ui.loaders

Class Loader

java.lang.Object

org.dominokit.domino.ui.loaders.Loader

public class Loader
extends Object

A component which provides a loader mask on a target element

Customize the component can be done by overwriting classes provided by LoaderStyles

For example:

     Loader.create(element, LoaderEffect.PULSE)
           .setLoadingText("Loading ...")
           .start();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Loader.LoadingTextPosition An enum representing the position of the loading text based on the loader effect

Method Summary

Modifier and Type	Method and Description
static Loader	create(elemental2.dom.HTMLElement target, LoaderEffect effect) Creates a loader for a target element with an effect
static Loader	create(org.jboss.elemento.IsElement<?> target, LoaderEffect effect) Creates a loader for a target element with an effect
IsLoader	getLoaderElement()
Loader.LoadingTextPosition	getLoadingTextPosition()
boolean	isStarted()
Loader	setLoadingText(String text) Sets a loading text which will be shown when the loader starts loading
Loader	setLoadingTextPosition(Loader.LoadingTextPosition loadingTextPosition) Sets the position of the loading text
Loader	setRemoveLoadingText(boolean removeLoadingText) Removes the loading text when loader is shown
Loader	setSize(String width, String height) Sets the width and height for the loader
Loader	start() Starts the loading, the loader will keep loading until stop() is called
Loader	start(int timeout) Starts the loading, the loader will keep loading until stop() is called
Loader	stop() Stops the loading

Methods inherited from class java.lang.Object

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

Method Detail

create

public static Loader create(elemental2.dom.HTMLElement target,
                            LoaderEffect effect)

Creates a loader for a target element with an effect

Parameters:

target - the target element

effect - the LoaderEffect

Returns:

new instance

create

public static Loader create(org.jboss.elemento.IsElement<?> target,
                            LoaderEffect effect)

Creates a loader for a target element with an effect

Parameters:

target - the target element

effect - the LoaderEffect

Returns:

new instance

start

public Loader start()

Starts the loading, the loader will keep loading until stop() is called

Returns:

same instance

start

public Loader start(int timeout)

Starts the loading, the loader will keep loading until stop() is called

Parameters:

timeout - int delay in milliseconds before automatically stopping the loader.

Returns:

same instance

stop

public Loader stop()

Stops the loading

Returns:

same instance

setLoadingText

public Loader setLoadingText(String text)

Sets a loading text which will be shown when the loader starts loading

Parameters:

text - the loading text

Returns:

same instance

setSize

public Loader setSize(String width,
                      String height)

Sets the width and height for the loader

Parameters:

width - the width

height - the height

Returns:

same instance

setRemoveLoadingText

public Loader setRemoveLoadingText(boolean removeLoadingText)

Removes the loading text when loader is shown

Parameters:

removeLoadingText - true to remove the loading text, false otherwise

Returns:

same instance

isStarted

public boolean isStarted()

Returns:

True if the loader is started, false otherwise

getLoadingTextPosition

public Loader.LoadingTextPosition getLoadingTextPosition()

Returns:

The Loader.LoadingTextPosition

setLoadingTextPosition

public Loader setLoadingTextPosition(Loader.LoadingTextPosition loadingTextPosition)

Sets the position of the loading text

Parameters:

loadingTextPosition - the Loader.LoadingTextPosition

Returns:

same instance

getLoaderElement

public IsLoader getLoaderElement()

Returns:

The loader element