Package com.vaadin.flow.component.textfield

Class BigDecimalField

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.AbstractField<C,T>

com.vaadin.flow.component.AbstractSinglePropertyField<R,T>

com.vaadin.flow.component.textfield.GeneratedVaadinTextField<BigDecimalField,BigDecimal>

com.vaadin.flow.component.textfield.BigDecimalField

All Implemented Interfaces:

AttachNotifier, BlurNotifier<BigDecimalField>, CompositionNotifier, DetachNotifier, Focusable<BigDecimalField>, FocusNotifier<BigDecimalField>, HasElement, HasEnabled, HasHelper, HasLabel, HasSize, HasStyle, HasTheme, HasValidation, HasValue<AbstractField.ComponentValueChangeEvent<BigDecimalField,BigDecimal>,BigDecimal>, HasValueAndElement<AbstractField.ComponentValueChangeEvent<BigDecimalField,BigDecimal>,BigDecimal>, InputNotifier, KeyNotifier, HasClearButton, HasThemeVariant<TextFieldVariant>, HasTooltip, HasAutocapitalize, HasAutocomplete, HasAutocorrect, HasPrefixAndSuffix, HasValidator<BigDecimal>, HasValueChangeMode, Serializable

@Tag("vaadin-big-decimal-field")
@NpmPackage(value="@vaadin/polymer-legacy-adapter",
            version="23.6.3")
@JsModule("@vaadin/polymer-legacy-adapter/style-modules.js") @JsModule("./vaadin-big-decimal-field.js")
public class BigDecimalField
extends GeneratedVaadinTextField<BigDecimalField,BigDecimal>
implements HasSize, HasValidation, HasValueChangeMode, HasPrefixAndSuffix, InputNotifier, KeyNotifier, CompositionNotifier, HasAutocomplete, HasAutocapitalize, HasAutocorrect, HasHelper, HasLabel, HasClearButton, HasThemeVariant<TextFieldVariant>, HasTooltip, HasValidator<BigDecimal>

BigDecimalField is an input field for handling decimal numbers with high precision. This field uses BigDecimal as the server-side value type, and only allows numeric input.

When setting values from the server-side, the scale of the provided BigDecimal is preserved in the presentation format shown to the user, as described in setValue(BigDecimal).

Author:

Vaadin Ltd.

See Also:

Serialized Form

Nested Class Summary

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

GeneratedVaadinTextField.ChangeEvent<R extends GeneratedVaadinTextField<R,?>>, GeneratedVaadinTextField.InvalidChangeEvent<R extends GeneratedVaadinTextField<R,?>>

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

AbstractField.ComponentValueChangeEvent<C extends Component,V>

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

BlurNotifier.BlurEvent<C extends Component>

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

FocusNotifier.FocusEvent<C extends Component>

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

HasValue.ValueChangeEvent<V>, HasValue.ValueChangeListener<E extends 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
BigDecimalField()	Constructs an empty BigDecimalField.
BigDecimalField(HasValue.ValueChangeListener<? super AbstractField.ComponentValueChangeEvent<BigDecimalField,BigDecimal>> listener)	Constructs an empty BigDecimalField with a value change listener.
BigDecimalField(String label)	Constructs an empty BigDecimalField with the given label.
BigDecimalField(String label, HasValue.ValueChangeListener<? super AbstractField.ComponentValueChangeEvent<BigDecimalField,BigDecimal>> listener)	Constructs an empty BigDecimalField with a label and a value change listener.
BigDecimalField(String label, String placeholder)	Constructs an empty BigDecimalField with the given label and placeholder text.
BigDecimalField(String label, BigDecimal initialValue, HasValue.ValueChangeListener<? super AbstractField.ComponentValueChangeEvent<BigDecimalField,BigDecimal>> listener)	Constructs an empty BigDecimalField with a label,a value change listener and an initial value.
BigDecimalField(String label, BigDecimal initialValue, String placeholder)	Constructs a BigDecimalField with the given label, an initial value and placeholder text.

Method Summary

Modifier and Type	Method	Description
void	addThemeVariants(TextFieldVariant... variants)	Adds theme variants to the component.
BigDecimal	getEmptyValue()	Returns the value that represents an empty value.
String	getErrorMessage()	Gets current error message from the component.
String	getLabel()	String used for the label element.
Locale	getLocale()	Gets the locale used by this BigDecimalField.
String	getPlaceholder()	A hint to the user of what can be entered in the component.
String	getTitle()	The text usually displayed in a tooltip popup when the mouse is over the field.
BigDecimal	getValue()	Returns the current value of the field.
ValueChangeMode	getValueChangeMode()	Gets current value change mode of the component.
int	getValueChangeTimeout()	Returns the currently set timeout, for how often HasValue.ValueChangeEvents are triggered when the ValueChangeMode is set to ValueChangeMode.LAZY, or ValueChangeMode.TIMEOUT.
boolean	isAutofocus()	Specify that this control should have input focus when the page loads.
boolean	isAutoselect()	Specifies if the field value gets automatically selected when the field gains focus.
boolean	isInvalid()	Returns true if component input is invalid, false otherwise.
protected void	onAttach(AttachEvent attachEvent)	Called when the component is attached to a UI.
void	removeThemeVariants(TextFieldVariant... variants)	Removes theme variants from the component.
void	setAutofocus(boolean autofocus)	Description copied from corresponding location in WebComponent:
void	setAutoselect(boolean autoselect)	Set to true to always have the field value automatically selected when the field gains focus, false otherwise.
void	setErrorMessage(String errorMessage)	Description copied from corresponding location in WebComponent:
void	setInvalid(boolean invalid)	Description copied from corresponding location in WebComponent:
void	setLabel(String label)	Description copied from corresponding location in WebComponent:
void	setLocale(Locale locale)	Sets the locale for this BigDecimalField.
void	setPlaceholder(String placeholder)	Description copied from corresponding location in WebComponent:
void	setRequiredIndicatorVisible(boolean requiredIndicatorVisible)	Sets the required indicator visible or not.
void	setTitle(String title)	Description copied from corresponding location in WebComponent:
void	setValue(BigDecimal value)	Sets the value of this field.
void	setValueChangeMode(ValueChangeMode valueChangeMode)	Sets new value change mode for the component.
void	setValueChangeTimeout(int valueChangeTimeout)	Sets how often HasValue.ValueChangeEvents are triggered when the ValueChangeMode is set to ValueChangeMode.LAZY, or ValueChangeMode.TIMEOUT.
protected void	validate()	Performs server-side validation of the current value.

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

addChangeListener, addInvalidChangeListener, addToInput, addToPrefix, addToSuffix, checkValidity, getAutocapitalizeString, getAutocompleteString, getAutocorrectString, getErrorMessageString, getLabelString, getListString, getMaxlengthDouble, getMinlengthDouble, getNameString, getPatternString, getPlaceholderString, getTitleString, isAutofocusBoolean, isAutoselectBoolean, isDisabledBoolean, isInvalidBoolean, isPreventInvalidInputBoolean, isReadonlyBoolean, isRequiredBoolean, remove, removeAll, setAutocapitalize, setAutocomplete, setAutocorrect, setDisabled, setList, setMaxlength, setMinlength, setName, setPattern, setPreventInvalidInput, setReadonly, setRequired

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, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onDetach, onEnabledStateChanged, 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.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.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.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.textfield.HasPrefixAndSuffix

getPrefixComponent, getSuffixComponent, setPrefixComponent, setSuffixComponent

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.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.data.binder.HasValidator

addValidationStatusChangeListener, getDefaultValidator

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

clear, getOptionalValue

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

isReadOnly, isRequiredIndicatorVisible, 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

Constructor Detail

BigDecimalField

public BigDecimalField()

Constructs an empty BigDecimalField.

BigDecimalField

public BigDecimalField(String label)

Constructs an empty BigDecimalField with the given label.

Parameters:

label - the text to set as the label

BigDecimalField

public BigDecimalField(String label,
                       String placeholder)

Constructs an empty BigDecimalField with the given label and placeholder text.

Parameters:

label - the text to set as the label

placeholder - the placeholder text to set

BigDecimalField

public BigDecimalField(String label,
                       BigDecimal initialValue,
                       String placeholder)

Constructs a BigDecimalField with the given label, an initial value and placeholder text.

Parameters:

label - the text to set as the label

initialValue - the initial value

placeholder - the placeholder text to set

See Also:

AbstractField.setValue(Object), setPlaceholder(String)

BigDecimalField

public BigDecimalField(HasValue.ValueChangeListener<? super AbstractField.ComponentValueChangeEvent<BigDecimalField,BigDecimal>> listener)

Constructs an empty BigDecimalField with a value change listener.

Parameters:

listener - the value change listener

See Also:

AbstractField.addValueChangeListener(com.vaadin.flow.component.HasValue.ValueChangeListener)

BigDecimalField

public BigDecimalField(String label,
                       HasValue.ValueChangeListener<? super AbstractField.ComponentValueChangeEvent<BigDecimalField,BigDecimal>> listener)

Constructs an empty BigDecimalField with a label and a value change listener.

Parameters:

label - the text to set as the label

listener - the value change listener

See Also:

setLabel(String), AbstractField.addValueChangeListener(com.vaadin.flow.component.HasValue.ValueChangeListener)

BigDecimalField

public BigDecimalField(String label,
                       BigDecimal initialValue,
                       HasValue.ValueChangeListener<? super AbstractField.ComponentValueChangeEvent<BigDecimalField,BigDecimal>> listener)

Constructs an empty BigDecimalField with a label,a value change listener and an initial value.

Parameters:

label - the text to set as the label

initialValue - the initial value

listener - the value change listener

See Also:

setLabel(String), AbstractField.setValue(Object), AbstractField.addValueChangeListener(com.vaadin.flow.component.HasValue.ValueChangeListener)

Method Detail

getValueChangeMode

public ValueChangeMode getValueChangeMode()

Gets current value change mode of the component.

The default value is ValueChangeMode.ON_CHANGE.

Specified by:

getValueChangeMode in interface HasValueChangeMode

Returns:

current value change mode of the component, or null if the value is not synchronized

setValueChangeMode

public void setValueChangeMode(ValueChangeMode valueChangeMode)

Description copied from interface: HasValueChangeMode

Sets new value change mode for the component.

Specified by:

setValueChangeMode in interface HasValueChangeMode

Parameters:

valueChangeMode - new value change mode, or null to disable the value synchronization

setValueChangeTimeout

public void setValueChangeTimeout(int valueChangeTimeout)

Description copied from interface: HasValueChangeMode

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

Implementations should use ValueChangeMode.applyChangeTimeout(ValueChangeMode, int, DomListenerRegistration).

Specified by:

setValueChangeTimeout in interface HasValueChangeMode

Parameters:

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

getValueChangeTimeout

public int getValueChangeTimeout()

Description copied from interface: HasValueChangeMode

Returns the currently set timeout, for how often HasValue.ValueChangeEvents are triggered when the ValueChangeMode is set to ValueChangeMode.LAZY, or ValueChangeMode.TIMEOUT.

Specified by:

getValueChangeTimeout in interface HasValueChangeMode

Returns:

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

getErrorMessage

public String getErrorMessage()

Description copied from interface: HasValidation

Gets current error message from the component.

Specified by:

getErrorMessage in interface HasValidation

Returns:

current error message

setErrorMessage

public void setErrorMessage(String errorMessage)

Description copied from class: GeneratedVaadinTextField

Description copied from corresponding location in WebComponent:

Error to show when the input value is invalid.

Specified by:

setErrorMessage in interface HasValidation

Overrides:

setErrorMessage in class GeneratedVaadinTextField<BigDecimalField,BigDecimal>

Parameters:

errorMessage - the String value to set

isInvalid

public boolean isInvalid()

Description copied from interface: HasValidation

Returns true if component input is invalid, false otherwise.

Specified by:

isInvalid in interface HasValidation

Returns:

whether the component input is valid

setInvalid

public void setInvalid(boolean invalid)

Description copied from class: GeneratedVaadinTextField

Description copied from corresponding location in WebComponent:

This property is set to true when the control value is invalid.

Specified by:

setInvalid in interface HasValidation

Overrides:

setInvalid in class GeneratedVaadinTextField<BigDecimalField,BigDecimal>

Parameters:

invalid - the boolean value to set

setLabel

public void setLabel(String label)

Description copied from class: GeneratedVaadinTextField

Description copied from corresponding location in WebComponent:

String used for the label element.

Specified by:

setLabel in interface HasLabel

Overrides:

setLabel in class GeneratedVaadinTextField<BigDecimalField,BigDecimal>

Parameters:

label - the String value to set

getLabel

public String getLabel()

String used for the label element.

Specified by:

getLabel in interface HasLabel

Returns:

the label property from the webcomponent

setPlaceholder

public void setPlaceholder(String placeholder)

Description copied from class: GeneratedVaadinTextField

Description copied from corresponding location in WebComponent:

A hint to the user of what can be entered in the control.

Overrides:

setPlaceholder in class GeneratedVaadinTextField<BigDecimalField,BigDecimal>

Parameters:

placeholder - the String value to set

getPlaceholder

public String getPlaceholder()

A hint to the user of what can be entered in the component.

Returns:

the placeholder property from the webcomponent

isAutoselect

public boolean isAutoselect()

Specifies if the field value gets automatically selected when the field gains focus.

Returns:

true if autoselect is active, false otherwise

setAutoselect

public void setAutoselect(boolean autoselect)

Set to true to always have the field value automatically selected when the field gains focus, false otherwise.

Overrides:

setAutoselect in class GeneratedVaadinTextField<BigDecimalField,BigDecimal>

Parameters:

autoselect - true to set auto select on, false otherwise

setAutofocus

public void setAutofocus(boolean autofocus)

Description copied from class: GeneratedVaadinTextField

Description copied from corresponding location in WebComponent:

Specify that this control should have input focus when the page loads.

Overrides:

setAutofocus in class GeneratedVaadinTextField<BigDecimalField,BigDecimal>

Parameters:

autofocus - the boolean value to set

isAutofocus

public boolean isAutofocus()

Specify that this control should have input focus when the page loads.

Returns:

the autofocus property from the webcomponent

getTitle

public String getTitle()

The text usually displayed in a tooltip popup when the mouse is over the field.

Returns:

the title property from the webcomponent

setTitle

public void setTitle(String title)

Description copied from class: GeneratedVaadinTextField

Description copied from corresponding location in WebComponent:

The text usually displayed in a tooltip popup when the mouse is over the field.

Overrides:

setTitle in class GeneratedVaadinTextField<BigDecimalField,BigDecimal>

Parameters:

title - the String value to set

getEmptyValue

public BigDecimal getEmptyValue()

Description copied from interface: HasValue

Returns the value that represents an empty value.

By default HasValue is expected to support null as empty values. Specific implementations might not support this.

Specified by:

getEmptyValue in interface HasValue<AbstractField.ComponentValueChangeEvent<BigDecimalField,BigDecimal>,BigDecimal>

Overrides:

getEmptyValue in class AbstractField<BigDecimalField,BigDecimal>

Returns:

empty value

setValue

public void setValue(BigDecimal value)

Sets the value of this field. If the new value is not equal to getValue(), fires a value change event.

You can adjust how the value is presented in the field with the APIs provided by the value type BigDecimal. For example, you can change the number of decimal places with BigDecimal.setScale(int). This doesn't however restrict the user from entering values with different number of decimals. Note that BigDecimals are immutable, so their methods will return new instances instead of editing the existing ones. Scientific notation (such as 1e9) is turned into plain number format for the presentation.

Specified by:

setValue in interface HasValue<AbstractField.ComponentValueChangeEvent<BigDecimalField,BigDecimal>,BigDecimal>

Overrides:

setValue in class AbstractField<BigDecimalField,BigDecimal>

Parameters:

value - the new value

getValue

public BigDecimal getValue()

Returns the current value of the field. By default, the empty BigDecimalField will return null.

Specified by:

getValue in interface HasValue<AbstractField.ComponentValueChangeEvent<BigDecimalField,BigDecimal>,BigDecimal>

Overrides:

getValue in class AbstractField<BigDecimalField,BigDecimal>

Returns:

the current value.

validate

protected void validate()

Performs server-side validation of the current value. This is needed because it is possible to circumvent the client-side validation constraints using browser development tools.

Overrides:

validate in class GeneratedVaadinTextField<BigDecimalField,BigDecimal>

setRequiredIndicatorVisible

public void setRequiredIndicatorVisible(boolean requiredIndicatorVisible)

Description copied from interface: HasValue

Sets the required indicator visible or not.

If set visible, it is visually indicated in the user interface.

The method is intended to be used with Binder which does server-side validation. In case HTML element has its own (client-side) validation it should be disabled when setRequiredIndicatorVisible(true) is called and re-enabled back on setRequiredIndicatorVisible(false). It's responsibility of each component implementation to follow the contract so that the method call doesn't do anything else than show/hide the "required" indication. Usually components provide their own setRequired method which should be called in case the client-side validation is required.

Specified by:

setRequiredIndicatorVisible in interface HasValue<AbstractField.ComponentValueChangeEvent<BigDecimalField,BigDecimal>,BigDecimal>

Specified by:

setRequiredIndicatorVisible in interface HasValueAndElement<AbstractField.ComponentValueChangeEvent<BigDecimalField,BigDecimal>,BigDecimal>

Parameters:

requiredIndicatorVisible - true to make the required indicator visible, false if not

setLocale

public void setLocale(Locale locale)

Sets the locale for this BigDecimalField. It is used to determine which decimal separator (the radix point) should be used.

Parameters:

locale - the locale to set, not null

getLocale

public Locale getLocale()

Gets the locale used by this BigDecimalField. It is used to determine which decimal separator (the radix point) should be used.

Overrides:

getLocale in class Component

Returns:

the locale of this field, never null

onAttach

protected void onAttach(AttachEvent attachEvent)

Description copied from class: Component

Called when the component is attached to a UI.

The default implementation does nothing.

This method is invoked before the AttachEvent is fired for the component.

Overrides:

onAttach in class Component

Parameters:

attachEvent - the attach event

addThemeVariants

public void addThemeVariants(TextFieldVariant... variants)

Description copied from interface: HasThemeVariant

Adds theme variants to the component.

Specified by:

addThemeVariants in interface HasThemeVariant<TextFieldVariant>

Parameters:

variants - theme variants to add

removeThemeVariants

public void removeThemeVariants(TextFieldVariant... variants)

Description copied from interface: HasThemeVariant

Removes theme variants from the component.

Specified by:

removeThemeVariants in interface HasThemeVariant<TextFieldVariant>

Parameters:

variants - theme variants to remove