org.dominokit.domino.ui.utils

Class DelayedTextInput

java.lang.Object

org.dominokit.domino.ui.utils.DelayedTextInput

public class DelayedTextInput
extends Object

A component that wraps an HTMLInputElement and performs an action when the user stops typing in the input after a configurable delay

 TextBox search = TextBox.create("Search");
 DelayedTextInput.create(search.getInputElement(), 300)
         .setDelayedAction(() -> Notification.create(search.getValue()).show());
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DelayedTextInput.DelayedAction A function to implement the action to be taken for DelayedTextInput

Constructor Summary

Constructors

Constructor and Description
DelayedTextInput(elemental2.dom.HTMLInputElement inputElement, int delay)
DelayedTextInput(elemental2.dom.HTMLInputElement inputElement, int delay, DelayedTextInput.DelayedAction delayedAction)

Method Summary

Modifier and Type	Method and Description
static DelayedTextInput	create(DominoElement<elemental2.dom.HTMLInputElement> inputElement, int delay)
static DelayedTextInput	create(elemental2.dom.HTMLInputElement inputElement, int delay)
static DelayedTextInput	create(elemental2.dom.HTMLInputElement inputElement, int delay, DelayedTextInput.DelayedAction delayedAction)
int	getDelay()
DelayedTextInput.DelayedAction	getOnEnterAction()
protected void	prepare() Initialize the component and the delay timer
void	setDelay(int delay)
DelayedTextInput	setDelayedAction(DelayedTextInput.DelayedAction delayedAction)
DelayedTextInput	setOnEnterAction(DelayedTextInput.DelayedAction onEnterAction)

Methods inherited from class java.lang.Object

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

Constructor Detail

DelayedTextInput

public DelayedTextInput(elemental2.dom.HTMLInputElement inputElement,
                        int delay)

Parameters:

inputElement - HTMLInputElement

delay - int delay in milli-seconds

DelayedTextInput

public DelayedTextInput(elemental2.dom.HTMLInputElement inputElement,
                        int delay,
                        DelayedTextInput.DelayedAction delayedAction)

Parameters:

inputElement - HTMLInputElement

delay - int delay in milli-seconds

delayedAction - DelayedTextInput.DelayedAction

Method Detail

create

public static DelayedTextInput create(elemental2.dom.HTMLInputElement inputElement,
                                      int delay,
                                      DelayedTextInput.DelayedAction delayedAction)

Parameters:

inputElement - HTMLInputElement

delay - int delay in milli-seconds

delayedAction - DelayedTextInput.DelayedAction

Returns:

new instance

create

public static DelayedTextInput create(elemental2.dom.HTMLInputElement inputElement,
                                      int delay)

Parameters:

inputElement - HTMLInputElement

delay - int delay in milli-seconds

Returns:

new instance

create

public static DelayedTextInput create(DominoElement<elemental2.dom.HTMLInputElement> inputElement,
                                      int delay)

Parameters:

inputElement - HTMLInputElement wrapped as DominoElement

delay - int delay in milli-seconds

Returns:

new instance

prepare

protected void prepare()

Initialize the component and the delay timer

setDelayedAction

public DelayedTextInput setDelayedAction(DelayedTextInput.DelayedAction delayedAction)

Parameters:

delayedAction - DelayedTextInput.DelayedAction that will be executed when the user stop typing

Returns:

same instance

getOnEnterAction

public DelayedTextInput.DelayedAction getOnEnterAction()

Returns:

the DelayedTextInput.DelayedAction that will be executed when the user press Enter key

setOnEnterAction

public DelayedTextInput setOnEnterAction(DelayedTextInput.DelayedAction onEnterAction)

Parameters:

onEnterAction - DelayedTextInput.DelayedAction that will be executed when the user press Enter key

Returns:

same instance

getDelay

public int getDelay()

Returns:

int delay in milli-seconds before executing the DelayedTextInput.DelayedAction after the user stops typing

setDelay

public void setDelay(int delay)

Parameters:

delay - int delay in milli-seconds before executing the DelayedTextInput.DelayedAction after the user stops typing