Package io.jmix.ui.component

Interface TextInputField.TextChangeNotifier

All Known Subinterfaces:

PasswordField, ResizableTextArea<V>, TextArea<V>, TextField<V>

All Known Implementing Classes:

AbstractTextArea, PasswordFieldImpl, ResizableTextAreaImpl, TextAreaImpl, TextFieldImpl

Enclosing interface:

TextInputField<V>

public static interface TextInputField.TextChangeNotifier

An interface for UI components that provide additional methods for text change handling.

Method Summary

Modifier and Type	Method	Description
Subscription	addTextChangeListener(Consumer<TextInputField.TextChangeEvent> listener)	Adds a listener that is fired when the component value is changed.
TextInputField.TextChangeEventMode	getTextChangeEventMode()
int	getTextChangeTimeout()	Gets the timeout used to fire TextInputField.TextChangeEvents and HasValue.ValueChangeEvents when the getTextChangeEventMode() is TextInputField.TextChangeEventMode.LAZY or TextInputField.TextChangeEventMode.TIMEOUT.
void	setTextChangeEventMode(TextInputField.TextChangeEventMode mode)	Sets the mode how the TextField triggers TextInputField.TextChangeEvents and HasValue.ValueChangeEvents.
void	setTextChangeTimeout(int timeout)	The text change timeout modifies how often text change events are communicated to the application when getTextChangeEventMode() is TextInputField.TextChangeEventMode.LAZY or TextInputField.TextChangeEventMode.TIMEOUT.

Method Details

addTextChangeListener

Subscription addTextChangeListener(Consumer<TextInputField.TextChangeEvent> listener)

Adds a listener that is fired when the component value is changed.

Parameters:

listener - a listener to add

Returns:

a Subscription object

getTextChangeTimeout

int getTextChangeTimeout()

Gets the timeout used to fire TextInputField.TextChangeEvents and HasValue.ValueChangeEvents when the getTextChangeEventMode() is TextInputField.TextChangeEventMode.LAZY or TextInputField.TextChangeEventMode.TIMEOUT.

Returns:

timeout in milliseconds

setTextChangeTimeout

@StudioProperty(name="textChangeTimeout",
                defaultValue="400")
void setTextChangeTimeout(int timeout)

The text change timeout modifies how often text change events are communicated to the application when getTextChangeEventMode() is TextInputField.TextChangeEventMode.LAZY or TextInputField.TextChangeEventMode.TIMEOUT.

Parameters:

timeout - timeout in milliseconds

getTextChangeEventMode

TextInputField.TextChangeEventMode getTextChangeEventMode()

Returns:

the mode used to trigger TextInputField.TextChangeEvents and HasValue.ValueChangeEvents.

setTextChangeEventMode

@StudioProperty(name="textChangeEventMode",
                defaultValue="LAZY",
                options={"BLUR","EAGER","TIMEOUT","LAZY"})
void setTextChangeEventMode(TextInputField.TextChangeEventMode mode)

Sets the mode how the TextField triggers TextInputField.TextChangeEvents and HasValue.ValueChangeEvents.

Parameters:

mode - the new mode