Package com.storedobject.ui

Class MoneyField

java.lang.Object

com.vaadin.flow.component.Component

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

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

com.storedobject.vaadin.CustomField<Money>

com.storedobject.vaadin.CustomTextField<Money>

com.storedobject.ui.MoneyField

All Implemented Interfaces:

DisablePaste, HasStyle, RequiredField, com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.BlurNotifier<com.vaadin.flow.component.customfield.CustomField<Money>>, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.Focusable<com.vaadin.flow.component.customfield.CustomField<Money>>, com.vaadin.flow.component.FocusNotifier<com.vaadin.flow.component.customfield.CustomField<Money>>, 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<Money>,Money>,Money>, com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.customfield.CustomField<Money>,Money>,Money>, 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<Money>,Money>,Money>, com.vaadin.flow.component.textfield.HasAutocomplete, Serializable

public class MoneyField
extends CustomTextField<Money>
implements RequiredField

Field to accept monetary values (Money).

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

Constructor	Description
MoneyField()	Constructor.
MoneyField(int width)	Constructor.
MoneyField(int width, String currency)	Constructor.
MoneyField(int width, Currency currency)	Constructor.
MoneyField(String label)	Constructor.
MoneyField(String label, int width)	Constructor.
MoneyField(String label, int width, String currency)	Constructor.
MoneyField(String label, int width, Currency currency)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	customizeTextField(HasTextValue textField)	Customize the internal text field.
protected String	format(Money value)	Format the value to display it as a string.
Currency	getCurrency()	Get the currency of the current value.
Money	getEmptyValue()
protected Money	getModelValue(String string)	Create the model value from the string value passed.
boolean	isEmpty()
protected void	onAttach(com.vaadin.flow.component.AttachEvent attachEvent)
void	setAllowedCurrencies(String... allowedCurrencies)	Restrict allowed currencies to a given set of values.
void	setAllowedCurrencies(Collection<Currency> allowedCurrencies)	Restrict allowed currencies to a given set of values.
void	setAllowedCurrencies(Currency... allowedCurrencies)	Restrict allowed currencies to a given set of values.
void	setLocalCurrency(boolean localCurrency)	Set local currency mode.
protected void	setPresentationValue(Money value)
void	setReadOnly(boolean readOnly)
void	setRequired(boolean required)	Indicate that value is required for this field.
void	setTagDebit(boolean tagDebit)	Tag negative values with "DB".
void	setValue(Money value)
protected boolean	valueEquals(Money value1, Money value2)

Methods inherited from class com.storedobject.vaadin.CustomTextField

alignRight, createField, disablePaste, generateModelValue, getAutocomplete, getField, getInternalElement, getPrefixComponent, getSuffixComponent, isAutoselect, setAutocomplete, setAutoselect, setEmptyDisplay, setEnabled, setHeight, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setPlaceholder, setPrefixComponent, setSuffixComponent, setWidth

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, getValue, setModelValue

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, getOptionalValue, getValue

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

isReadOnly, isRequiredIndicatorVisible, setRequiredIndicatorVisible

Constructor Details

MoneyField

public MoneyField()

Constructor.

MoneyField

public MoneyField(int width)

Constructor.

Parameters:

width - Width of the field (number of characters).

MoneyField

public MoneyField(int width,
 Currency currency)

Constructor.

Parameters:

width - Width of the field (number of characters).

currency - Initial currency to use.

MoneyField

public MoneyField(int width,
 String currency)

Constructor.

Parameters:

width - Width of the field (number of characters).

currency - Initial currency to use.

MoneyField

public MoneyField(String label)

Constructor.

Parameters:

label - Label.

MoneyField

public MoneyField(String label,
 int width)

Constructor.

Parameters:

label - Label.

width - Width of the field (number of characters).

MoneyField

public MoneyField(String label,
 int width,
 String currency)

Constructor.

Parameters:

label - Label.

width - Width of the field (number of characters).

currency - Initial currency to use.

MoneyField

public MoneyField(String label,
 int width,
 Currency currency)

Constructor.

Parameters:

label - Label.

width - Width of the field (number of characters).

currency - Initial currency to use.

Method Details

setTagDebit

public void setTagDebit(boolean tagDebit)

Tag negative values with "DB".

Parameters:

tagDebit - To tag or not.

setLocalCurrency

public void setLocalCurrency(boolean localCurrency)

Set local currency mode. In local currency mode, no currency symbol/name is displayed.

Parameters:

localCurrency - True/false.

onAttach

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

Overrides:

onAttach in class CustomTextField<Money>

customizeTextField

protected void customizeTextField(HasTextValue textField)

Description copied from class: CustomTextField

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

Overrides:

customizeTextField in class CustomTextField<Money>

Parameters:

textField - Internal text field

setValue

public void setValue(Money value)

Specified by:

setValue in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.customfield.CustomField<Money>,Money>,Money>

Overrides:

setValue in class com.vaadin.flow.component.AbstractField<com.vaadin.flow.component.customfield.CustomField<Money>,Money>

getModelValue

protected Money getModelValue(String string)

Description copied from class: CustomTextField

Create the model value from the string value passed.

Specified by:

getModelValue in class CustomTextField<Money>

Parameters:

string - String value to convert.

Returns:

Model value created from the string value.

format

protected String format(Money value)

Description copied from class: CustomTextField

Format the value to display it as a string.

Overrides:

format in class CustomTextField<Money>

Parameters:

value - Value to format.

Returns:

Displayable string.

setPresentationValue

protected void setPresentationValue(Money value)

Overrides:

setPresentationValue in class CustomTextField<Money>

getCurrency

public Currency getCurrency()

Get the currency of the current value.

Returns:

Currency.

setAllowedCurrencies

public void setAllowedCurrencies(Collection<Currency> allowedCurrencies)

Restrict allowed currencies to a given set of values.

Parameters:

allowedCurrencies - Allowed currencies.

setAllowedCurrencies

public void setAllowedCurrencies(Currency... allowedCurrencies)

Restrict allowed currencies to a given set of values.

Parameters:

allowedCurrencies - Allowed currencies.

setAllowedCurrencies

public void setAllowedCurrencies(String... allowedCurrencies)

Restrict allowed currencies to a given set of values.

Parameters:

allowedCurrencies - Allowed currencies.

setRequired

public void setRequired(boolean required)

Description copied from interface: RequiredField

Indicate that value is required for this field.

Specified by:

setRequired in interface RequiredField

Parameters:

required - True/false.

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<Money>,Money>,Money>

Specified by:

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

Overrides:

setReadOnly in class CustomTextField<Money>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.customfield.CustomField<Money>,Money>,Money>

Overrides:

isEmpty in class com.vaadin.flow.component.AbstractField<com.vaadin.flow.component.customfield.CustomField<Money>,Money>

getEmptyValue

public Money getEmptyValue()

Specified by:

getEmptyValue in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.customfield.CustomField<Money>,Money>,Money>

Overrides:

getEmptyValue in class com.vaadin.flow.component.AbstractField<com.vaadin.flow.component.customfield.CustomField<Money>,Money>

valueEquals

protected boolean valueEquals(Money value1,
 Money value2)

Overrides:

valueEquals in class com.vaadin.flow.component.AbstractField<com.vaadin.flow.component.customfield.CustomField<Money>,Money>