Package org.teamapps.ux.component.field.multicurrency

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:

Component, TextInputHandlingField

public class CurrencyField
extends AbstractField<CurrencyValue>
implements TextInputHandlingField

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CurrencyField.Currency

Field Summary

Fields

Modifier and Type	Field	Description
Event<SpecialKey>	onSpecialKeyPressed
Event<java.lang.String>	onTextInput

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

onValueChanged, onVisibilityChanged

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

onDestroyed, onRendered

Constructor Summary

Constructors

Constructor	Description
CurrencyField()

Method Summary

Modifier and Type	Method	Description
CurrencyValue	convertUiValueToUxValue(java.lang.Object value)
java.lang.Object	convertUxValueToUiValue(CurrencyValue currencyValue)	Converts a server-side value to a client-side field-specific value.
org.teamapps.dto.UiField	createUiComponent()
protected void	doDestroy()	Override this method to release resources whenever this component gets destroyed
java.util.List<CurrencyField.Currency>	getCurrencyList()
CurrencyField.Currency	getDefaultCurrency()
int	getPrecision()
void	handleUiEvent(org.teamapps.dto.UiEvent event)
boolean	isAlphaKeysQueryForCurrency()
boolean	isShowCurrencyBeforeAmount()
boolean	isShowCurrencySymbol()
Event<SpecialKey>	onSpecialKeyPressed()
Event<java.lang.String>	onTextInput()
void	setAlphaKeysQueryForCurrency(boolean alphaKeysQueryForCurrency)
CurrencyField	setCurrencyList(java.util.List<CurrencyField.Currency> currencyList)
CurrencyField	setDefaultCurrency(CurrencyField.Currency defaultCurrency)
void	setPrecision(int precision)
CurrencyField	setShowCurrencyBeforeAmount(boolean showCurrencyBeforeAmount)
CurrencyField	setShowCurrencySymbol(boolean showCurrencySymbol)

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

addFieldMessage, applyValueFromUi, focus, getEditingMode, getFieldMessages, getValue, isVisible, mapAbstractFieldAttributesToUiField, removeFieldMessage, removeFieldMessages, removeValidationMessages, setAndLockValue, setEditingMode, setFieldMessages, setValidationMessage, setValue, setVisible

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

createUiComponentReference, destroy, getId, getParent, getSessionContext, isDestroyed, isEffectivelyVisible, isRendered, mapAbstractUiComponentProperties, queueCommandIfRendered, render, reRenderIfRendered, setCssStyle, setMargin, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setParent, setShadow, 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.Component

setCssStyle

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

defaultHandleTextInputEvent

Field Detail

onTextInput

public final Event<java.lang.String> onTextInput

onSpecialKeyPressed

public final Event<SpecialKey> onSpecialKeyPressed

Constructor Detail

CurrencyField

public CurrencyField()

Method Detail

createUiComponent

public org.teamapps.dto.UiField createUiComponent()

Specified by:

createUiComponent in class AbstractComponent

handleUiEvent

public void handleUiEvent(org.teamapps.dto.UiEvent event)

Specified by:

handleUiEvent in interface Component

Overrides:

handleUiEvent in class AbstractField<CurrencyValue>

getDefaultCurrency

public CurrencyField.Currency getDefaultCurrency()

setDefaultCurrency

public CurrencyField setDefaultCurrency(CurrencyField.Currency defaultCurrency)

getCurrencyList

public java.util.List<CurrencyField.Currency> getCurrencyList()

setCurrencyList

public CurrencyField setCurrencyList(java.util.List<CurrencyField.Currency> currencyList)

convertUxValueToUiValue

public java.lang.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(java.lang.Object value)

Overrides:

convertUiValueToUxValue in class AbstractField<CurrencyValue>

doDestroy

protected void doDestroy()

Description copied from class: AbstractComponent

Override this method to release resources whenever this component gets destroyed

Specified by:

doDestroy in class AbstractField<CurrencyValue>

getPrecision

public int getPrecision()

isShowCurrencyBeforeAmount

public boolean isShowCurrencyBeforeAmount()

setShowCurrencyBeforeAmount

public CurrencyField setShowCurrencyBeforeAmount(boolean showCurrencyBeforeAmount)

isShowCurrencySymbol

public boolean isShowCurrencySymbol()

setShowCurrencySymbol

public CurrencyField setShowCurrencySymbol(boolean showCurrencySymbol)

isAlphaKeysQueryForCurrency

public boolean isAlphaKeysQueryForCurrency()

setPrecision

public void setPrecision(int precision)

setAlphaKeysQueryForCurrency

public void setAlphaKeysQueryForCurrency(boolean alphaKeysQueryForCurrency)

onTextInput

public Event<java.lang.String> onTextInput()

Specified by:

onTextInput in interface TextInputHandlingField

onSpecialKeyPressed

public Event<SpecialKey> onSpecialKeyPressed()

Specified by:

onSpecialKeyPressed in interface TextInputHandlingField