com.haulmont.cuba.gui.components

Interface CurrencyField

All Superinterfaces:

Component, Component.BelongToFrame, Component.Buffered, Component.Editable, Component.HasCaption, Component.HasContextHelp, Component.HasIcon, Component.HasValue, Component.Validatable, DatasourceComponent, Field

public interface CurrencyField
extends Field, Component.Buffered

The CurrencyField component is intended for displaying currency values.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CurrencyField.CurrencyLabelPosition Defines where the currency label is located.

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Field

Field.Validator

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Component

Component.ActionOwner, Component.ActionsHolder, Component.Alignment, Component.BelongToFrame, Component.Buffered, Component.ChildEditableController, Component.Collapsable, Component.Container, Component.ContextHelpIconClickEvent, Component.Disposable, Component.Editable, Component.EditableChangeEvent, Component.EditableChangeListener, Component.EditableChangeNotifier, Component.ExpandedStateChangeEvent, Component.ExpandedStateChangeListener, Component.Focusable, Component.HasBorder, Component.HasButtonsPanel, Component.HasCaption, Component.HasContextHelp, Component.HasFormatter, Component.HasIcon, Component.HasInputPrompt, Component.HasNamedComponents, Component.HasOptionsStyleProvider, Component.HasPresentations, Component.HasRowsCount, Component.HasSettings, Component.HasValue, Component.HasXmlDescriptor, Component.LayoutClickEvent, Component.LayoutClickListener, Component.LayoutClickNotifier, Component.Margin, Component.MouseEventDetails, Component.OptionsStyleProvider, Component.OrderedContainer, Component.OuterMargin, Component.SecuredActionsHolder, Component.ShortcutAction, Component.ShortcutNotifier, Component.ShortcutTriggeredEvent, Component.Spacing, Component.UiPermissionAware, Component.Validatable, Component.ValueChangeEvent, Component.ValueChangeListener, Component.Wrapper

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Fields inherited from interface com.haulmont.cuba.gui.components.Component

AUTO_SIZE, AUTO_SIZE_PX, UNITS_PERCENTAGE, UNITS_PIXELS

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCurrency()
CurrencyField.CurrencyLabelPosition	getCurrencyLabelPosition()
Datatype	getDatatype()
boolean	getShowCurrencyLabel()
void	setCurrency(java.lang.String currency) Sets the given currency to the field.
void	setCurrencyLabelPosition(CurrencyField.CurrencyLabelPosition currencyLabelPosition) Sets where the currency label will be located: to the left or to the right from the text input component.
void	setDatatype(Datatype datatype) Sets the given datatype to the component.
void	setShowCurrencyLabel(boolean showCurrencyLabel) Enables or disables currency label displaying.

Methods inherited from interface com.haulmont.cuba.gui.components.Field

addValidator, getRequiredMessage, getValidators, isRequired, removeValidator, setRequired, setRequiredMessage

Methods inherited from interface com.haulmont.cuba.gui.components.DatasourceComponent

getDatasource, getMetaProperty, getMetaPropertyPath, setDatasource

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasValue

addListener, addValueChangeListener, getValue, removeListener, removeValueChangeListener, setValue

Methods inherited from interface com.haulmont.cuba.gui.components.Component.Editable

isEditable, isEditableWithParent, setEditable

Methods inherited from interface com.haulmont.cuba.gui.components.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface com.haulmont.cuba.gui.components.Component

addStyleName, getAlignment, getDebugId, getHeight, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthUnits, isEnabled, isEnabledItself, isResponsive, isVisible, isVisibleItself, removeStyleName, requestFocus, setAlignment, setDebugId, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasCaption

getCaption, getDescription, setCaption, setDescription

Methods inherited from interface com.haulmont.cuba.gui.components.Component.Validatable

isValid, isValidateOnCommit, validate

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasIcon

getIcon, setIcon, setIconFromSet

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasContextHelp

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

Methods inherited from interface com.haulmont.cuba.gui.components.Component.Buffered

commit, discard, isBuffered, isModified, setBuffered

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

setCurrency

void setCurrency(java.lang.String currency)

Sets the given currency to the field. Currency label will be displayed next to the text input component if the showCurrency option is enabled. Recommended max currency length - 3 character.

Parameters:

currency - currency ($, EUR, etc)

getCurrency

java.lang.String getCurrency()

Returns:

current currency

setShowCurrencyLabel

void setShowCurrencyLabel(boolean showCurrencyLabel)

Enables or disables currency label displaying.

getShowCurrencyLabel

boolean getShowCurrencyLabel()

Returns:

true if currency label is displayed or false otherwise

setCurrencyLabelPosition

void setCurrencyLabelPosition(CurrencyField.CurrencyLabelPosition currencyLabelPosition)

Sets where the currency label will be located: to the left or to the right from the text input component.

Parameters:

currencyLabelPosition - not-null CurrencyField.CurrencyLabelPosition value

getCurrencyLabelPosition

CurrencyField.CurrencyLabelPosition getCurrencyLabelPosition()

Returns:

where the currency label is located

setDatatype

void setDatatype(Datatype datatype)

Sets the given datatype to the component. Its value will be formatted according to this datatype.

Parameters:

datatype - Datatype instance

getDatatype

Datatype getDatatype()

Returns:

a datatype that is used by this component