Package com.storedobject.vaadin

Class ActionTextField

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.AbstractField<com.vaadin.flow.component.textfield.TextField,String>

com.vaadin.flow.component.AbstractSinglePropertyField<com.vaadin.flow.component.textfield.TextField,String>

com.vaadin.flow.component.textfield.TextFieldBase<com.vaadin.flow.component.textfield.TextField,String>

com.vaadin.flow.component.textfield.TextField

com.storedobject.vaadin.TextField

com.storedobject.vaadin.ActionTextField

All Implemented Interfaces:

DisablePaste, RequiredField, SpellCheck, HasTextValue, ValueRequired, com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.BlurNotifier<com.vaadin.flow.component.textfield.TextField>, com.vaadin.flow.component.CompositionNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.Focusable<com.vaadin.flow.component.textfield.TextField>, com.vaadin.flow.component.FocusNotifier<com.vaadin.flow.component.textfield.TextField>, com.vaadin.flow.component.HasAriaLabel, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasHelper, com.vaadin.flow.component.HasLabel, com.vaadin.flow.component.HasPlaceholder, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasText, com.vaadin.flow.component.HasTheme, com.vaadin.flow.component.HasValidation, com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.textfield.TextField,String>,String>, com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.textfield.TextField,String>,String>, com.vaadin.flow.component.InputNotifier, com.vaadin.flow.component.KeyNotifier, com.vaadin.flow.component.shared.HasAllowedCharPattern, com.vaadin.flow.component.shared.HasClearButton, com.vaadin.flow.component.shared.HasClientValidation, com.vaadin.flow.component.shared.HasPrefix, com.vaadin.flow.component.shared.HasSuffix, com.vaadin.flow.component.shared.HasThemeVariant<com.vaadin.flow.component.textfield.TextFieldVariant>, com.vaadin.flow.component.shared.HasTooltip, com.vaadin.flow.component.shared.HasValidationProperties, com.vaadin.flow.component.shared.InputField<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.textfield.TextField,String>,String>, com.vaadin.flow.component.textfield.HasAutocapitalize, com.vaadin.flow.component.textfield.HasAutocomplete, com.vaadin.flow.component.textfield.HasAutocorrect, com.vaadin.flow.component.textfield.HasPrefixAndSuffix, com.vaadin.flow.data.binder.HasValidator<String>, com.vaadin.flow.data.value.HasValueChangeMode, Serializable

Direct Known Subclasses:

SearchField

public class ActionTextField
extends TextField

A TextField that triggers a Consumer action (when value changed or "Enter" key is pressed). A value-change-timeout of 1000 milliseconds is set as the default but it may be changed.

Author:

Syam

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.flow.component.textfield.TextField

com.vaadin.flow.component.textfield.TextField.TextFieldI18n

Nested classes/interfaces inherited from class com.vaadin.flow.component.AbstractField

com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<C extends com.vaadin.flow.component.Component,V>

Nested classes/interfaces inherited from interface com.vaadin.flow.component.BlurNotifier

com.vaadin.flow.component.BlurNotifier.BlurEvent<C extends com.vaadin.flow.component.Component>

Nested classes/interfaces inherited from interface com.vaadin.flow.component.FocusNotifier

com.vaadin.flow.component.FocusNotifier.FocusEvent<C extends com.vaadin.flow.component.Component>

Nested classes/interfaces inherited from interface com.vaadin.flow.component.shared.HasClientValidation

com.vaadin.flow.component.shared.HasClientValidation.ClientValidatedEvent

Nested classes/interfaces inherited from interface com.vaadin.flow.component.HasText

com.vaadin.flow.component.HasText.WhiteSpace

Nested classes/interfaces inherited from interface com.vaadin.flow.component.HasValue

com.vaadin.flow.component.HasValue.ValueChangeEvent<V>, com.vaadin.flow.component.HasValue.ValueChangeListener<E extends com.vaadin.flow.component.HasValue.ValueChangeEvent<?>>

Field Summary

Fields inherited from interface com.vaadin.flow.component.textfield.HasAutocapitalize

AUTOCAPITALIZE_ATTRIBUTE

Fields inherited from interface com.vaadin.flow.component.textfield.HasAutocomplete

AUTOCOMPLETE_ATTRIBUTE

Fields inherited from interface com.vaadin.flow.component.textfield.HasAutocorrect

AUTOCORRECT_ATTRIBUTE

Fields inherited from interface com.vaadin.flow.data.value.HasValueChangeMode

DEFAULT_CHANGE_TIMEOUT

Constructor Summary

Constructors

Constructor	Description
ActionTextField(String label, String initialValue, String placeholder, Consumer<String> action)	Constructor.
ActionTextField(String label, String placeholder, Consumer<String> action)	Constructor.
ActionTextField(String label, Consumer<String> action)	Constructor.
ActionTextField(Consumer<String> action)	Constructor.

Method Summary

Modifier and Type	Method	Description
Consumer<String>	getAction()	Get the action.
String	getActionText()	Get the action text.
String	getPreviousActionText()	The action text that was already acted up on.
void	setAction(Consumer<String> action)	Set the action.
void	setIgnoreProgrammaticChanges(boolean ignore)	Flag to ignore programmatic changes.
ActionTextField	toLowerCase()	If this method is used, values will be converted to lowercase before action is carried out.
ActionTextField	toUpperCase()	If this method is used, values will be converted to uppercase before action is carried out.
ActionTextField	trim()	If this method is used, values will be trimmed before action is carried out.

Methods inherited from class com.storedobject.vaadin.TextField

getText, getValue, inputTypeSet, setIcon, setIcon, setText, setValue

Methods inherited from class com.vaadin.flow.component.textfield.TextField

getDefaultValidator, getEmptyValue, getI18n, getMaxLength, getMinLength, getPattern, setErrorMessage, setI18n, setManualValidation, setMaxLength, setMinLength, setPattern, setRequiredIndicatorVisible, validate

Methods inherited from class com.vaadin.flow.component.textfield.TextFieldBase

addToInput, addToPrefix, addToSuffix, getAriaLabel, getAriaLabelledBy, getTitle, getValueChangeMode, getValueChangeTimeout, isAutofocus, isAutoselect, isRequired, isRequiredIndicatorVisible, setAriaLabel, setAriaLabelledBy, setAutofocus, setAutoselect, setLabel, setRequired, setTitle, setValueChangeMode, setValueChangeTimeout

Methods inherited from class com.vaadin.flow.component.AbstractSinglePropertyField

getSynchronizationRegistration, hasValidValue, setPresentationValue, setSynchronizedEvent

Methods inherited from class com.vaadin.flow.component.AbstractField

addValueChangeListener, isEmpty, setModelValue, valueEquals

Methods inherited from class com.vaadin.flow.component.Component

addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisible

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

addAttachListener

Methods inherited from interface com.vaadin.flow.component.BlurNotifier

addBlurListener

Methods inherited from interface com.vaadin.flow.component.CompositionNotifier

addCompositionEndListener, addCompositionStartListener, addCompositionUpdateListener

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

addDetachListener

Methods inherited from interface com.storedobject.vaadin.DisablePaste

disablePaste

Methods inherited from interface com.vaadin.flow.component.Focusable

addFocusShortcut, blur, focus, getTabIndex, setTabIndex

Methods inherited from interface com.vaadin.flow.component.FocusNotifier

addFocusListener

Methods inherited from interface com.vaadin.flow.component.shared.HasAllowedCharPattern

getAllowedCharPattern, setAllowedCharPattern

Methods inherited from interface com.vaadin.flow.component.textfield.HasAutocapitalize

getAutocapitalize, setAutocapitalize

Methods inherited from interface com.vaadin.flow.component.textfield.HasAutocomplete

getAutocomplete, setAutocomplete

Methods inherited from interface com.vaadin.flow.component.textfield.HasAutocorrect

isAutocorrect, setAutocorrect

Methods inherited from interface com.vaadin.flow.component.shared.HasClearButton

isClearButtonVisible, setClearButtonVisible

Methods inherited from interface com.vaadin.flow.component.shared.HasClientValidation

addClientValidatedEventListener

Methods inherited from interface com.vaadin.flow.component.HasElement

getElement

Methods inherited from interface com.vaadin.flow.component.HasEnabled

isEnabled, setEnabled

Methods inherited from interface com.vaadin.flow.component.HasHelper

getHelperComponent, getHelperText, setHelperComponent, setHelperText

Methods inherited from interface com.vaadin.flow.component.HasLabel

getLabel

Methods inherited from interface com.vaadin.flow.component.HasPlaceholder

getPlaceholder, setPlaceholder

Methods inherited from interface com.vaadin.flow.component.shared.HasPrefix

getPrefixComponent, setPrefixComponent

Methods inherited from interface com.vaadin.flow.component.HasSize

getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull

Methods inherited from interface com.vaadin.flow.component.HasStyle

addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

Methods inherited from interface com.vaadin.flow.component.shared.HasSuffix

getSuffixComponent, setSuffixComponent

Methods inherited from interface com.vaadin.flow.component.HasText

getWhiteSpace, setWhiteSpace

Methods inherited from interface com.storedobject.vaadin.util.HasTextValue

capitalize, lowercase, normal, setMaxLength, setMinLength, setPattern, uppercase

Methods inherited from interface com.vaadin.flow.component.HasTheme

addThemeName, addThemeNames, getThemeName, getThemeNames, hasThemeName, removeThemeName, removeThemeNames, setThemeName, setThemeName

Methods inherited from interface com.vaadin.flow.component.shared.HasThemeVariant

addThemeVariants, removeThemeVariants

Methods inherited from interface com.vaadin.flow.component.shared.HasTooltip

getTooltip, setTooltipText

Methods inherited from interface com.vaadin.flow.component.shared.HasValidationProperties

getErrorMessage, isInvalid, setInvalid

Methods inherited from interface com.vaadin.flow.data.binder.HasValidator

addValidationStatusChangeListener

Methods inherited from interface com.vaadin.flow.component.HasValue

addValueChangeListener, clear, getOptionalValue, isEmpty

Methods inherited from interface com.vaadin.flow.component.HasValueAndElement

isReadOnly, setReadOnly

Methods inherited from interface com.vaadin.flow.component.InputNotifier

addInputListener

Methods inherited from interface com.vaadin.flow.component.KeyNotifier

addKeyDownListener, addKeyDownListener, addKeyPressListener, addKeyPressListener, addKeyUpListener, addKeyUpListener

Methods inherited from interface com.storedobject.vaadin.RequiredField

setRequired

Methods inherited from interface com.storedobject.vaadin.SpellCheck

setSpellCheck

Methods inherited from interface com.storedobject.vaadin.ValueRequired

isRequired, setRequired

Constructor Details

ActionTextField

public ActionTextField(Consumer<String> action)

Constructor.

Parameters:

action - Action to be executed when value changed or "Enter" key is pressed

ActionTextField

public ActionTextField(String label,
 Consumer<String> action)

Constructor.

Parameters:

label - Label

action - Action to be executed when value changed or "Enter" key is pressed

ActionTextField

public ActionTextField(String label,
 String placeholder,
 Consumer<String> action)

Constructor.

Parameters:

label - Label

placeholder - Placeholder

action - Action to be executed when value changed or "Enter" key is pressed

ActionTextField

public ActionTextField(String label,
 String initialValue,
 String placeholder,
 Consumer<String> action)

Constructor.

Parameters:

label - Label

initialValue - Initial value

placeholder - Placeholder

action - Action to be executed when value changed or "Enter" key is pressed

Method Details

setIgnoreProgrammaticChanges

public void setIgnoreProgrammaticChanges(boolean ignore)

Flag to ignore programmatic changes. By default, all value changes will trigger the action.

Parameters:

ignore - Whether to ignore programmatic changes or not

setAction

public void setAction(Consumer<String> action)

Set the action.

Parameters:

action - Action

getAction

public Consumer<String> getAction()

Get the action.

Returns:

Action.

getActionText

public String getActionText()

Get the action text. (Action may not have invoked on this text).

Returns:

Action text.

getPreviousActionText

public String getPreviousActionText()

The action text that was already acted up on. (Could be null).

Returns:

Previous action text.

trim

public ActionTextField trim()

If this method is used, values will be trimmed before action is carried out.

Returns:

This (for chained use).

toUpperCase

public ActionTextField toUpperCase()

If this method is used, values will be converted to uppercase before action is carried out.

Returns:

This (for chained use).

toLowerCase

public ActionTextField toLowerCase()

If this method is used, values will be converted to lowercase before action is carried out.

Returns:

This (for chained use).