Class CurrencyField

java.lang.Object

org.teamapps.ux.component.AbstractComponent

org.teamapps.ux.component.field.AbstractField<CurrencyValue>

org.teamapps.ux.component.field.multicurrency.CurrencyField

All Implemented Interfaces:

ClientObject, Component, TextInputHandlingField

public class CurrencyField
extends AbstractField<CurrencyValue>
implements TextInputHandlingField

Field Summary

Fields

Modifier and Type	Field	Description
final Event<SpecialKey>	onSpecialKeyPressed
final Event<String>	onTextInput

Fields inherited from class org.teamapps.ux.component.field.AbstractField

onBlur, onFocus, onValueChanged, onVisibilityChanged

Fields inherited from class org.teamapps.ux.component.AbstractComponent

DELETED_ATTRIBUTE, onRendered

Constructor Summary

Constructors

Constructor	Description
CurrencyField()
CurrencyField(List<CurrencyUnit> currencies)

Method Summary

Modifier and Type	Method	Description
CurrencyValue	convertUiValueToUxValue(Object value)
Object	convertUxValueToUiValue(CurrencyValue currencyValue)	Converts a server-side value to a client-side field-specific value.
UiField	createUiComponent()
Optional<BigDecimal>	getAmount()
List<CurrencyUnit>	getCurrencies()
Optional<CurrencyUnit>	getCurrency()
int	getFixedPrecision()
Locale	getLocale()
com.ibm.icu.util.ULocale	getULocale()
void	handleUiEvent(UiEvent event)
boolean	isAlphabeticKeysQueryEnabled()
boolean	isCurrencyBeforeAmount()
boolean	isCurrencySymbolsEnabled()
Event<SpecialKey>	onSpecialKeyPressed()
Event<String>	onTextInput()
void	setAlphabeticKeysQueryEnabled(boolean alphabeticKeysQueryEnabled)
void	setAmount(BigDecimal amount)
CurrencyField	setCurrencies(List<CurrencyUnit> currencies)
void	setCurrency(CurrencyUnit currencyUnit)
CurrencyField	setCurrencyBeforeAmount(boolean currencyBeforeAmount)
CurrencyField	setCurrencySymbolsEnabled(boolean currencySymbolsEnabled)
void	setFixedPrecision(int fixedPrecision)
void	setLocale(Locale locale)
void	setULocale(com.ibm.icu.util.ULocale locale)

Methods inherited from class org.teamapps.ux.component.field.AbstractField

addCustomFieldMessage, addCustomFieldMessage, addValidator, applyValueFromUi, clearCustomFieldMessages, clearValidatorMessages, focus, getCustomFieldMessages, getDefaultMessagePosition, getDefaultMessageVisibility, getEditingMode, getFieldMessages, getMaxFieldMessageSeverity, getValidators, getValue, isEmpty, isEmptyValue, isRequired, isValid, isValueChangedByClient, isValueLocked, mapAbstractFieldAttributesToUiField, removeCustomFieldMessage, removeValidator, setAndLockValue, setCustomFieldMessages, setDefaultMessagePosition, setDefaultMessageVisibility, setEditingMode, setRequired, setRequiredIfVisibleAndEditable, setValue, setValueChangedByClient, setVisible, validate

Methods inherited from class org.teamapps.ux.component.AbstractComponent

createUiReference, getDebuggingId, getId, getParent, getSessionContext, isRendered, isVisible, mapAbstractUiComponentProperties, queueCommandIfRendered, render, reRenderIfRendered, setAttribute, setCssStyle, setDebuggingId, setParent, toggleCssClass, toString, unrender

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.teamapps.ux.component.ClientObject

handleUiQuery

Methods inherited from interface org.teamapps.ux.component.Component

setAriaLabel, setAttribute, setCssStyle, setHtmlTitle, setMargin, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setShadow, toggleCssClass

Methods inherited from interface org.teamapps.ux.component.field.TextInputHandlingField

defaultHandleTextInputEvent

Field Details

onTextInput

public final Event<String> onTextInput

onSpecialKeyPressed

public final Event<SpecialKey> onSpecialKeyPressed

Constructor Details

CurrencyField

public CurrencyField()

CurrencyField

public CurrencyField(List<CurrencyUnit> currencies)

Method Details

createUiComponent

public UiField createUiComponent()

Specified by:

createUiComponent in class AbstractComponent

handleUiEvent

public void handleUiEvent(UiEvent event)

Specified by:

handleUiEvent in interface ClientObject

Overrides:

handleUiEvent in class AbstractField<CurrencyValue>

getCurrencies

public List<CurrencyUnit> getCurrencies()

setCurrencies

public CurrencyField setCurrencies(List<CurrencyUnit> currencies)

convertUxValueToUiValue

public Object convertUxValueToUiValue(CurrencyValue currencyValue)

Description copied from class: AbstractField

Converts a server-side value to a client-side field-specific value. Implementations must not have any side effects to the component!

Overrides:

convertUxValueToUiValue in class AbstractField<CurrencyValue>

Parameters:

currencyValue - the server-side value

Returns:

the object to be sent to the ui

convertUiValueToUxValue

public CurrencyValue convertUiValueToUxValue(Object value)

Overrides:

convertUiValueToUxValue in class AbstractField<CurrencyValue>

getCurrency

public Optional<CurrencyUnit> getCurrency()

setCurrency

public void setCurrency(CurrencyUnit currencyUnit)

getAmount

public Optional<BigDecimal> getAmount()

setAmount

public void setAmount(BigDecimal amount)

getFixedPrecision

public int getFixedPrecision()

isCurrencyBeforeAmount

public boolean isCurrencyBeforeAmount()

setCurrencyBeforeAmount

public CurrencyField setCurrencyBeforeAmount(boolean currencyBeforeAmount)

isCurrencySymbolsEnabled

public boolean isCurrencySymbolsEnabled()

setCurrencySymbolsEnabled

public CurrencyField setCurrencySymbolsEnabled(boolean currencySymbolsEnabled)

isAlphabeticKeysQueryEnabled

public boolean isAlphabeticKeysQueryEnabled()

setFixedPrecision

public void setFixedPrecision(int fixedPrecision)

setAlphabeticKeysQueryEnabled

public void setAlphabeticKeysQueryEnabled(boolean alphabeticKeysQueryEnabled)

getLocale

public Locale getLocale()

getULocale

public com.ibm.icu.util.ULocale getULocale()

setLocale

public void setLocale(Locale locale)

setULocale

public void setULocale(com.ibm.icu.util.ULocale locale)

onTextInput

public Event<String> onTextInput()

Specified by:

onTextInput in interface TextInputHandlingField

onSpecialKeyPressed

public Event<SpecialKey> onSpecialKeyPressed()

Specified by:

onSpecialKeyPressed in interface TextInputHandlingField