We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.flow.data.value.
Package com.vaadin.flow.data.value
Interface HasValueChangeMode
All Superinterfaces:
All Known Implementing Classes:
AbstractNumberField, BigDecimalField, EmailField, Input, IntegerField, NumberField, PasswordField, RangeInput, RichTextEditor, TextArea, TextField, TextFieldBase
Denotes that the component is able to change the way its value on the client side is synchronized with the server side.
A class implementing this interface should typically also implement
HasValue even though this is not required on the API level.
Since:
1.0.
Author:
Vaadin Ltd
See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intDefault value change timeout for textual inputs in milliseconds.
-
Method Summary
Modifier and TypeMethodDescriptionGets current value change mode of the component.
default intReturns the currently set timeout, for how often
HasValue.ValueChangeEvents are triggered when the ValueChangeMode is set toValueChangeMode.LAZY, orValueChangeMode.TIMEOUT.voidsetValueChangeMode(ValueChangeMode valueChangeMode) Sets new value change mode for the component.
default voidsetValueChangeTimeout(int valueChangeTimeout) Sets how often
HasValue.ValueChangeEvents are triggered when the ValueChangeMode is set toValueChangeMode.LAZY, orValueChangeMode.TIMEOUT.
-
Field Details
-
DEFAULT_CHANGE_TIMEOUT
static final int DEFAULT_CHANGE_TIMEOUTDefault value change timeout for textual inputs in milliseconds.
See Also:
-
-
Method Details
-
getValueChangeMode
ValueChangeMode getValueChangeMode()Gets current value change mode of the component.
Returns:
current value change mode of the component, or
nullif the value is not synchronized -
setValueChangeMode
Sets new value change mode for the component.
Parameters:
valueChangeMode- new value change mode, ornullto disable the value synchronization -
setValueChangeTimeout
default void setValueChangeTimeout(int valueChangeTimeout) Sets how often
HasValue.ValueChangeEvents are triggered when the ValueChangeMode is set toValueChangeMode.LAZY, orValueChangeMode.TIMEOUT.Implementations should use
ValueChangeMode.applyChangeTimeout(ValueChangeMode, int, DomListenerRegistration).Parameters:
valueChangeTimeout- the timeout in milliseconds of how oftenHasValue.ValueChangeEvents are triggered.Throws:
UnsupportedOperationException- if neitherValueChangeMode.LAZY, norValueChangeMode.TIMEOUTis supported -
getValueChangeTimeout
default int getValueChangeTimeout()Returns the currently set timeout, for how often
HasValue.ValueChangeEvents are triggered when the ValueChangeMode is set toValueChangeMode.LAZY, orValueChangeMode.TIMEOUT.Returns:
the timeout in milliseconds of how often
HasValue.ValueChangeEvents are triggered.Throws:
UnsupportedOperationException- if neitherValueChangeMode.LAZY, norValueChangeMode.TIMEOUTis supported
-