com.vaadin.ui

Interface HasValueChangeMode

All Superinterfaces:

ClientConnector, Component, Connector, Serializable, Sizeable

All Known Implementing Classes:

AbstractTextField, PasswordField, RichTextArea, TextArea, TextField

public interface HasValueChangeMode
extends Component

Implemented by components which support value change modes.

Since:

8.0

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.ui.Component

Component.ErrorEvent, Component.Event, Component.Focusable, Component.Listener

Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

ClientConnector.AttachEvent, ClientConnector.AttachListener, ClientConnector.ConnectorErrorEvent, ClientConnector.DetachEvent, ClientConnector.DetachListener

Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable

Sizeable.Unit

Field Summary

Fields inherited from interface com.vaadin.server.Sizeable

SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

Method Summary

Modifier and Type	Method and Description
ValueChangeMode	getValueChangeMode() Returns the currently set ValueChangeMode.
int	getValueChangeTimeout() Returns the currently set timeout, in milliseconds, for how often HasValue.ValueChangeEvents are triggered if the current ValueChangeMode is set to either ValueChangeMode.LAZY or ValueChangeMode.TIMEOUT.
void	setValueChangeMode(ValueChangeMode valueChangeMode) Sets the mode how the TextField triggers HasValue.ValueChangeEvents.
void	setValueChangeTimeout(int valueChangeTimeout) Sets how often HasValue.ValueChangeEvents are triggered when the ValueChangeMode is set to either ValueChangeMode.LAZY or ValueChangeMode.TIMEOUT.

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, addStyleNames, attach, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isVisible, readDesign, removeListener, removeStyleName, removeStyleNames, setCaption, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setStyleName, setStyleName, setVisible, writeDesign

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, beforeClientResponse, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.server.Sizeable

getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthUndefined

Method Detail

setValueChangeMode

void setValueChangeMode(ValueChangeMode valueChangeMode)

Sets the mode how the TextField triggers HasValue.ValueChangeEvents.

Parameters:

valueChangeMode - the new mode

See Also:

ValueChangeMode

getValueChangeMode

ValueChangeMode getValueChangeMode()

Returns the currently set ValueChangeMode.

Returns:

the mode used to trigger HasValue.ValueChangeEvents.

See Also:

ValueChangeMode

setValueChangeTimeout

void setValueChangeTimeout(int valueChangeTimeout)

Sets how often HasValue.ValueChangeEvents are triggered when the ValueChangeMode is set to either ValueChangeMode.LAZY or ValueChangeMode.TIMEOUT.

Parameters:

valueChangeTimeout - timeout in milliseconds, must be greater or equal to 0

Throws:

IllegalArgumentException - if given timeout is smaller than 0

See Also:

ValueChangeMode

getValueChangeTimeout

int getValueChangeTimeout()

Returns the currently set timeout, in milliseconds, for how often HasValue.ValueChangeEvents are triggered if the current ValueChangeMode is set to either ValueChangeMode.LAZY or ValueChangeMode.TIMEOUT.

Returns:

the timeout in milliseconds of how often HasValue.ValueChangeEvents are triggered.