io.jmix.ui.component

Enum TextInputField.TextChangeEventMode

java.lang.Object

java.lang.Enum<TextInputField.TextChangeEventMode>

io.jmix.ui.component.TextInputField.TextChangeEventMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TextInputField.TextChangeEventMode>

Enclosing interface:

TextInputField<V>

public static enum TextInputField.TextChangeEventMode
extends java.lang.Enum<TextInputField.TextChangeEventMode>

Different modes how the TextField can trigger TextInputField.TextChangeEvents.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BLUR Fires a server-side event when the field loses focus.
EAGER An event is triggered on each text content change, most commonly key press events.
LAZY An event is triggered when there is a pause of text modifications.
TIMEOUT Each text change event in the UI causes the event to be communicated to the application after a timeout.

Method Summary

Modifier and Type	Method and Description
static TextInputField.TextChangeEventMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TextInputField.TextChangeEventMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BLUR

public static final TextInputField.TextChangeEventMode BLUR

Fires a server-side event when the field loses focus.

EAGER

public static final TextInputField.TextChangeEventMode EAGER

An event is triggered on each text content change, most commonly key press events.

TIMEOUT

public static final TextInputField.TextChangeEventMode TIMEOUT

Each text change event in the UI causes the event to be communicated to the application after a timeout. The length of the timeout can be controlled with TextInputField.TextChangeNotifier.setTextChangeTimeout(int). Only the last input event is reported to the server side if several text change events happen during the timeout.

In case of a ValueChangeEvent the schedule is not kept strictly. Before a ValueChangeEvent a TextInputField.TextChangeEvent is triggered if the text content has changed since the previous TextChangeEvent regardless of the schedule.

LAZY

public static final TextInputField.TextChangeEventMode LAZY

An event is triggered when there is a pause of text modifications. The length of the pause can be modified with TextInputField.TextChangeNotifier.setTextChangeTimeout(int). Like with the TIMEOUT mode, an event is forced before ValueChangeEvents, even if the user did not keep a pause while entering the text.

This is the default mode.

Method Detail

values

public static TextInputField.TextChangeEventMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TextInputField.TextChangeEventMode c : TextInputField.TextChangeEventMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TextInputField.TextChangeEventMode valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null