Package com.storedobject.vaadin

Class CustomTextField<T>

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.AbstractField<com.vaadin.flow.component.customfield.CustomField<T>,T>

com.vaadin.flow.component.customfield.CustomField<T>

com.storedobject.vaadin.CustomField<T>

com.storedobject.vaadin.CustomTextField<T>

Type Parameters:

T - Value type

All Implemented Interfaces:

DisablePaste, HasStyle, com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.BlurNotifier<com.vaadin.flow.component.customfield.CustomField<T>>, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.Focusable<com.vaadin.flow.component.customfield.CustomField<T>>, com.vaadin.flow.component.FocusNotifier<com.vaadin.flow.component.customfield.CustomField<T>>, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasHelper, com.vaadin.flow.component.HasLabel, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, 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.customfield.CustomField<T>,T>,T>, com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.customfield.CustomField<T>,T>,T>, com.vaadin.flow.component.shared.HasPrefix, com.vaadin.flow.component.shared.HasSuffix, 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.customfield.CustomField<T>,T>,T>, com.vaadin.flow.component.textfield.HasAutocomplete, Serializable

Direct Known Subclasses:

AbstractQuantityField, ClassNameField, DaysField, FreeFormatField, GeolocationField, JSONField, MinutesField, MoneyField, NumericField, ObjectCodeField, SecondsField

public abstract class CustomTextField<T>
extends CustomField<T>
implements com.vaadin.flow.component.shared.HasPrefix, com.vaadin.flow.component.shared.HasSuffix, HasStyle, DisablePaste, com.vaadin.flow.component.textfield.HasAutocomplete

A "custom field" where the value is represented as a "text" using an internal text field.

Author:

Syam

See Also:

• Serialized Form

Nested Class Summary

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.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.HasAutocomplete

AUTOCOMPLETE_ATTRIBUTE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CustomTextField(T defaultValue)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	alignRight()	Align right.
protected HasTextValue	createField()	Create the internal text field.
protected void	customizeTextField(HasTextValue textField)	Customize the internal text field.
void	disablePaste()	Disable paste feature so that Ctrl-V will not paste anything from the copy buffer.
protected String	format(T value)	Format the value to display it as a string.
protected T	generateModelValue()
com.vaadin.flow.component.textfield.Autocomplete	getAutocomplete()
HasTextValue	getField()	Get the internal text field that represents the value of the field.
com.vaadin.flow.dom.Element	getInternalElement()	Get the internal element to which style will be applied.
protected abstract T	getModelValue(String string)	Create the model value from the string value passed.
com.vaadin.flow.component.Component	getPrefixComponent()
com.vaadin.flow.component.Component	getSuffixComponent()
boolean	isAutoselect()	Is in auto-select mode?
protected void	onAttach(com.vaadin.flow.component.AttachEvent attachEvent)
void	setAutocomplete(com.vaadin.flow.component.textfield.Autocomplete autocomplete)
void	setAutoselect(boolean autoselect)	Set auto-select mode.
void	setEmptyDisplay(String emptyDisplay)	Set text to be displayed when the value of the field is empty.
void	setEnabled(boolean enabled)
void	setHeight(String height)
void	setMaxHeight(String maxHeight)
void	setMaxWidth(String maxWidth)
void	setMinHeight(String minHeight)
void	setMinWidth(String minWidth)
void	setPlaceholder(String placeholder)	Set text to be displayed as placeholder when the value of the field is empty.
void	setPrefixComponent(com.vaadin.flow.component.Component component)
protected void	setPresentationValue(T value)
void	setReadOnly(boolean readOnly)
void	setSuffixComponent(com.vaadin.flow.component.Component component)
void	setWidth(String width)

Methods inherited from class com.storedobject.vaadin.CustomField

addField, addField, focus

Methods inherited from class com.vaadin.flow.component.customfield.CustomField

add, addThemeVariants, getLabel, remove, removeThemeVariants, setLabel, updateValue

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

addValueChangeListener, getEmptyValue, getValue, isEmpty, setModelValue, setValue, 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, 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.DetachNotifier

addDetachListener

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

addFocusShortcut, blur, getTabIndex, setTabIndex

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

addFocusListener

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

getElement

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

isEnabled

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

getHelperComponent, getHelperText, setHelperComponent, setHelperText

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

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

Methods inherited from interface com.storedobject.vaadin.HasStyle

getClassName, getClassNames, getStyle, setClassName

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

addClassName, addClassNames, hasClassName, removeClassName, removeClassNames, setClassName

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.HasTooltip

getTooltip, setTooltipText

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

setManualValidation

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

getErrorMessage, isInvalid, setErrorMessage, setInvalid

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

addValueChangeListener, clear, getEmptyValue, getOptionalValue, getValue, isEmpty, setValue

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

isReadOnly, isRequiredIndicatorVisible, setRequiredIndicatorVisible

Constructor Details

CustomTextField

protected CustomTextField(T defaultValue)

Constructor.

Parameters:

defaultValue - Default value

Method Details

setWidth

public void setWidth(String width)

Specified by:

setWidth in interface com.vaadin.flow.component.HasSize

setHeight

public void setHeight(String height)

Specified by:

setHeight in interface com.vaadin.flow.component.HasSize

setMaxWidth

public void setMaxWidth(String maxWidth)

Specified by:

setMaxWidth in interface com.vaadin.flow.component.HasSize

setMaxHeight

public void setMaxHeight(String maxHeight)

Specified by:

setMaxHeight in interface com.vaadin.flow.component.HasSize

setMinWidth

public void setMinWidth(String minWidth)

Specified by:

setMinWidth in interface com.vaadin.flow.component.HasSize

setMinHeight

public void setMinHeight(String minHeight)

Specified by:

setMinHeight in interface com.vaadin.flow.component.HasSize

alignRight

public void alignRight()

Align right.

createField

protected HasTextValue createField()

Create the internal text field. By default, it creates a TextField.

Returns:

Text field to be used as internal field;

disablePaste

public void disablePaste()

Description copied from interface: DisablePaste

Disable paste feature so that Ctrl-V will not paste anything from the copy buffer.

Specified by:

disablePaste in interface DisablePaste

getField

public HasTextValue getField()

Get the internal text field that represents the value of the field.

Returns:

Internal text field.

customizeTextField

protected void customizeTextField(HasTextValue textField)

Customize the internal text field. This is invoked only when the text field is created.

Parameters:

textField - Internal text field

onAttach

protected void onAttach(com.vaadin.flow.component.AttachEvent attachEvent)

Overrides:

onAttach in class com.vaadin.flow.component.customfield.CustomField<T>

getModelValue

protected abstract T getModelValue(String string)

Create the model value from the string value passed.

Parameters:

string - String value to convert.

Returns:

Model value created from the string value.

generateModelValue

protected T generateModelValue()

Specified by:

generateModelValue in class com.vaadin.flow.component.customfield.CustomField<T>

setPresentationValue

protected void setPresentationValue(T value)

Specified by:

setPresentationValue in class com.vaadin.flow.component.customfield.CustomField<T>

format

protected String format(T value)

Format the value to display it as a string.

Parameters:

value - Value to format.

Returns:

Displayable string.

setEmptyDisplay

public void setEmptyDisplay(String emptyDisplay)

Set text to be displayed when the value of the field is empty.

Parameters:

emptyDisplay - Text to be displayed

setPlaceholder

public void setPlaceholder(String placeholder)

Set text to be displayed as placeholder when the value of the field is empty.

Parameters:

placeholder - Placeholder to be displayed

setPrefixComponent

public void setPrefixComponent(com.vaadin.flow.component.Component component)

Specified by:

setPrefixComponent in interface com.vaadin.flow.component.shared.HasPrefix

getPrefixComponent

public com.vaadin.flow.component.Component getPrefixComponent()

Specified by:

getPrefixComponent in interface com.vaadin.flow.component.shared.HasPrefix

setSuffixComponent

public void setSuffixComponent(com.vaadin.flow.component.Component component)

Specified by:

setSuffixComponent in interface com.vaadin.flow.component.shared.HasSuffix

getSuffixComponent

public com.vaadin.flow.component.Component getSuffixComponent()

Specified by:

getSuffixComponent in interface com.vaadin.flow.component.shared.HasSuffix

setReadOnly

public void setReadOnly(boolean readOnly)

Specified by:

setReadOnly in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.customfield.CustomField<T>,T>,T>

Specified by:

setReadOnly in interface com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.customfield.CustomField<T>,T>,T>

setEnabled

public void setEnabled(boolean enabled)

Specified by:

setEnabled in interface com.vaadin.flow.component.HasEnabled

setAutoselect

public void setAutoselect(boolean autoselect)

Set auto-select mode.

Parameters:

autoselect - True to turn it on.

isAutoselect

public boolean isAutoselect()

Is in auto-select mode?

Returns:

True/false.

getAutocomplete

public com.vaadin.flow.component.textfield.Autocomplete getAutocomplete()

Specified by:

getAutocomplete in interface com.vaadin.flow.component.textfield.HasAutocomplete

setAutocomplete

public void setAutocomplete(com.vaadin.flow.component.textfield.Autocomplete autocomplete)

Specified by:

setAutocomplete in interface com.vaadin.flow.component.textfield.HasAutocomplete

getInternalElement

public com.vaadin.flow.dom.Element getInternalElement()

Description copied from interface: HasStyle

Get the internal element to which style will be applied.

Specified by:

getInternalElement in interface HasStyle

Returns:

The internal element.