com.haulmont.cuba.web.gui.components

Class WebCurrencyField

java.lang.Object

com.haulmont.bali.events.EventRouter

com.haulmont.cuba.web.gui.components.WebAbstractComponent<T>

com.haulmont.cuba.web.gui.components.WebAbstractField<com.haulmont.cuba.web.toolkit.ui.CubaCurrencyField>

com.haulmont.cuba.web.gui.components.WebCurrencyField

All Implemented Interfaces:

Component, Component.BelongToFrame, Component.Buffered, Component.Editable, Component.HasCaption, Component.HasIcon, Component.HasValue, Component.HasXmlDescriptor, Component.Validatable, Component.Wrapper, CurrencyField, DatasourceComponent, Field

public class WebCurrencyField
extends WebAbstractField<com.haulmont.cuba.web.toolkit.ui.CubaCurrencyField>
implements CurrencyField

Nested Class Summary

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

CurrencyField.CurrencyLabelPosition

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.Disposable, Component.Editable, Component.EditableChangeEvent, Component.EditableChangeListener, Component.EditableChangeNotifier, Component.ExpandedStateChangeEvent, Component.ExpandedStateChangeListener, Component.Focusable, Component.HasBorder, Component.HasButtonsPanel, Component.HasCaption, Component.HasFormatter, Component.HasIcon, Component.HasInputPrompt, Component.HasNamedComponents, Component.HasPresentations, Component.HasRowsCount, Component.HasSettings, Component.HasValue, Component.HasXmlDescriptor, Component.LayoutClickEvent, Component.LayoutClickListener, Component.LayoutClickNotifier, Component.Margin, Component.MouseEventDetails, 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 inherited from class com.haulmont.cuba.web.gui.components.WebAbstractComponent

ICON_STYLE, UNIT_SYMBOLS

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

NAME

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

AUTO_SIZE, AUTO_SIZE_PX, UNITS_PERCENTAGE, UNITS_PIXELS

Constructor Summary

Constructors

Constructor and Description
WebCurrencyField()

Method Summary

Modifier and Type	Method and Description
void	addValueChangeListener(Component.ValueChangeListener listener)
void	commit() Updates all changes since the previous commit to the data source.
void	discard() Discards all changes since last commit.
java.lang.String	getCurrency()
CurrencyField.CurrencyLabelPosition	getCurrencyLabelPosition()
Datasource	getDatasource()
Datatype	getDatatype()
MetaProperty	getMetaProperty()
MetaPropertyPath	getMetaPropertyPath()
boolean	getShowCurrencyLabel()
<V> V	getValue()
boolean	isBuffered()
boolean	isModified() Tests if the value stored in the object has been modified since it was last updated from the data source.
boolean	isRequired()
void	removeValueChangeListener(Component.ValueChangeListener listener)
void	setBuffered(boolean buffered) Sets the buffered mode.
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	setDatasource(Datasource datasource, java.lang.String property) Set datasource and its property.
void	setDatatype(Datatype datatype) Sets the given datatype to the component.
void	setRequired(boolean required)
void	setShowCurrencyLabel(boolean showCurrencyLabel) Enables or disables currency label displaying.
void	setValue(java.lang.Object value)
void	validate()

Methods inherited from class com.haulmont.cuba.web.gui.components.WebAbstractField

addListener, addValidator, getRequiredMessage, getValidators, isEditable, isValid, removeListener, removeValidator, setEditable, setParent, setRequiredMessage

Methods inherited from class com.haulmont.cuba.web.gui.components.WebAbstractComponent

addStyleName, assignAutoDebugId, getAlignment, getCaption, getComponent, getComponentEnabledFlag, getComponentVisibleFlag, getComposition, getDebugId, getDescription, getFrame, getHeight, getHeightUnits, getIcon, getId, getParent, getStyleName, getWidth, getWidthUnits, getXmlDescriptor, isEnabled, isEnabledItself, isResponsive, isVisible, isVisibleItself, removeStyleName, requestFocus, setAlignment, setCaption, setDebugId, setDescription, setEnabled, setFrame, setHeight, setIcon, setId, setResponsive, setStyleName, setVisible, setWidth, setXmlDescriptor, unwrap, unwrapComposition

Methods inherited from class com.haulmont.bali.events.EventRouter

addListener, addListener, fireEvent, hasListeners, removeListener, removeListener

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

addValidator, getRequiredMessage, getValidators, removeValidator, setRequiredMessage

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

addListener, removeListener

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

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

getIcon, setIcon

Constructor Detail

WebCurrencyField

public WebCurrencyField()

Method Detail

setCurrency

public void setCurrency(java.lang.String currency)

Description copied from interface: CurrencyField

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.

Specified by:

setCurrency in interface CurrencyField

Parameters:

currency - currency ($, EUR, etc)

getCurrency

public java.lang.String getCurrency()

Specified by:

getCurrency in interface CurrencyField

Returns:

current currency

setShowCurrencyLabel

public void setShowCurrencyLabel(boolean showCurrencyLabel)

Description copied from interface: CurrencyField

Enables or disables currency label displaying.

Specified by:

setShowCurrencyLabel in interface CurrencyField

getShowCurrencyLabel

public boolean getShowCurrencyLabel()

Specified by:

getShowCurrencyLabel in interface CurrencyField

Returns:

true if currency label is displayed or false otherwise

setCurrencyLabelPosition

public void setCurrencyLabelPosition(CurrencyField.CurrencyLabelPosition currencyLabelPosition)

Description copied from interface: CurrencyField

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

Specified by:

setCurrencyLabelPosition in interface CurrencyField

Parameters:

currencyLabelPosition - not-null CurrencyField.CurrencyLabelPosition value

getCurrencyLabelPosition

public CurrencyField.CurrencyLabelPosition getCurrencyLabelPosition()

Specified by:

getCurrencyLabelPosition in interface CurrencyField

Returns:

where the currency label is located

setDatasource

public void setDatasource(Datasource datasource,
                          java.lang.String property)

Description copied from interface: DatasourceComponent

Set datasource and its property.

Specified by:

setDatasource in interface DatasourceComponent

Overrides:

setDatasource in class WebAbstractField<com.haulmont.cuba.web.toolkit.ui.CubaCurrencyField>

getDatasource

public Datasource getDatasource()

Specified by:

getDatasource in interface DatasourceComponent

Overrides:

getDatasource in class WebAbstractField<com.haulmont.cuba.web.toolkit.ui.CubaCurrencyField>

Returns:

datasource instance

getMetaProperty

public MetaProperty getMetaProperty()

Specified by:

getMetaProperty in interface DatasourceComponent

Overrides:

getMetaProperty in class WebAbstractField<com.haulmont.cuba.web.toolkit.ui.CubaCurrencyField>

Returns:

datasource property

getMetaPropertyPath

public MetaPropertyPath getMetaPropertyPath()

Specified by:

getMetaPropertyPath in interface DatasourceComponent

Overrides:

getMetaPropertyPath in class WebAbstractField<com.haulmont.cuba.web.toolkit.ui.CubaCurrencyField>

Returns:

datasource property path

setDatatype

public void setDatatype(Datatype datatype)

Description copied from interface: CurrencyField

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

Specified by:

setDatatype in interface CurrencyField

Parameters:

datatype - Datatype instance

getDatatype

public Datatype getDatatype()

Specified by:

getDatatype in interface CurrencyField

Returns:

a datatype that is used by this component

addValueChangeListener

public void addValueChangeListener(Component.ValueChangeListener listener)

Specified by:

addValueChangeListener in interface Component.HasValue

Overrides:

addValueChangeListener in class WebAbstractField<com.haulmont.cuba.web.toolkit.ui.CubaCurrencyField>

removeValueChangeListener

public void removeValueChangeListener(Component.ValueChangeListener listener)

Specified by:

removeValueChangeListener in interface Component.HasValue

Overrides:

removeValueChangeListener in class WebAbstractField<com.haulmont.cuba.web.toolkit.ui.CubaCurrencyField>

getValue

public <V> V getValue()

Specified by:

getValue in interface Component.HasValue

Overrides:

getValue in class WebAbstractField<com.haulmont.cuba.web.toolkit.ui.CubaCurrencyField>

setValue

public void setValue(java.lang.Object value)

Specified by:

setValue in interface Component.HasValue

Overrides:

setValue in class WebAbstractField<com.haulmont.cuba.web.toolkit.ui.CubaCurrencyField>

setBuffered

public void setBuffered(boolean buffered)

Description copied from interface: Component.Buffered

Sets the buffered mode.

When in buffered mode, an internal buffer will be used to store changes until Component.Buffered.commit() is called. Calling Component.Buffered.discard() will revert the internal buffer to the value of the data source.

When in non-buffered mode both read and write operations will be done directly on the data source. In this mode the Component.Buffered.commit() and Component.Buffered.discard() methods serve no purpose.

Specified by:

setBuffered in interface Component.Buffered

Parameters:

buffered - true if buffered mode should be turned on, false otherwise

isBuffered

public boolean isBuffered()

Specified by:

isBuffered in interface Component.Buffered

Returns:

true if buffered mode is on, false otherwise

commit

public void commit()

Description copied from interface: Component.Buffered

Updates all changes since the previous commit to the data source.

Specified by:

commit in interface Component.Buffered

discard

public void discard()

Description copied from interface: Component.Buffered

Discards all changes since last commit. The object updates its value from the data source.

Specified by:

discard in interface Component.Buffered

isModified

public boolean isModified()

Description copied from interface: Component.Buffered

Tests if the value stored in the object has been modified since it was last updated from the data source.

Specified by:

isModified in interface Component.Buffered

Returns:

true if the value in the object has been modified since the last data source update, false if not.

validate

public void validate()
              throws ValidationException

Specified by:

validate in interface Component.Validatable

Overrides:

validate in class WebAbstractField<com.haulmont.cuba.web.toolkit.ui.CubaCurrencyField>

Throws:

ValidationException

isRequired

public boolean isRequired()

Specified by:

isRequired in interface Field

Overrides:

isRequired in class WebAbstractField<com.haulmont.cuba.web.toolkit.ui.CubaCurrencyField>

Returns:

whether the field must contain a non-null value

setRequired

public void setRequired(boolean required)

Specified by:

setRequired in interface Field

Overrides:

setRequired in class WebAbstractField<com.haulmont.cuba.web.toolkit.ui.CubaCurrencyField>