com.whitestein.lsps.vaadin.forms

Class WDecimalField

java.lang.Object

com.whitestein.lsps.vaadin.forms.FormComponent

com.whitestein.lsps.vaadin.forms.ComponentWithValue<T>

com.whitestein.lsps.vaadin.forms.WInputComponentWithValue<Decimal>

com.whitestein.lsps.vaadin.forms.WDecimalField

All Implemented Interfaces:

com.vaadin.event.ConnectorEventListener, com.vaadin.server.ClientConnector.AttachListener, Serializable, EventListener

public class WDecimalField
extends WInputComponentWithValue<Decimal>

Author:

mvy

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.whitestein.lsps.vaadin.forms.ComponentWithValue

ComponentWithValue.ValueChangeListenerImpl, ComponentWithValue.ValueProperty<T>

Field Summary

Fields inherited from class com.whitestein.lsps.vaadin.forms.ComponentWithValue

refreshing

Fields inherited from class com.whitestein.lsps.vaadin.forms.FormComponent

form, INTERNAL_STATE_RECORD_PROPERTY

Fields inherited from interface com.vaadin.server.ClientConnector.AttachListener

attachMethod

Constructor Summary

Constructors

Constructor and Description
WDecimalField() Creates a new instance of decimal field.

Method Summary

Modifier and Type	Method and Description
protected com.vaadin.ui.AbstractField<?>	createWidget() Called once, to create the actual Vaadin component.
protected boolean	isFullyInitialized()
protected void	restoreInternalState(Map<String,Object> state) Restores the UI state of this component which was previously written by FormComponent.writeInternalState(Map).
void	setNumberFormat(String numberFormat) Sets the number format to this field.
protected void	writeInternalState(Map<String,Object> state) Writes the UI state of this component to the provided map.

Methods inherited from class com.whitestein.lsps.vaadin.forms.WInputComponentWithValue

addValidator, fireValueChanged, focus, getOnChange, getValidationErrors, getWidget, inferValidator, isConvertible, isImmediate, isRequired, isValid, preventGC, removeAllValidators, setImmediate, setOnChange, setRequired

Methods inherited from class com.whitestein.lsps.vaadin.forms.ComponentWithValue

getBinding, getProperty, onPropertyValueSet, refresh, refreshBinding, setProperty

Methods inherited from class com.whitestein.lsps.vaadin.forms.FormComponent

addDataErrorMessage, addStyleName, attach, call, clearDataErrorMessages, createEvent, equals, getCaption, getComponentAlignment, getContextClickHandler, getCustomErrorMessage, getDataErrorMessages, getDescription, getExpandRatio, getHasChildrenAdapter, getHeight, getIcon, getModelingId, getNamespace, getStyleName, getTabIndex, getWidth, hashCode, isEnabled, isReadOnly, isVisible, localize, markAsDirty, removeStyleName, restoreState, saveState, setCaption, setComponentAlignment, setContextClickHandler, setContextMenuItems, setCustomErrorMessage, setDescription, setEnabled, setExpandRatio, setHeight, setIcon, setReadOnly, setStyleName, setTabIndex, setVisible, setWidth, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WDecimalField

public WDecimalField()

Creates a new instance of decimal field.

Method Detail

createWidget

protected com.vaadin.ui.AbstractField<?> createWidget()

Description copied from class: FormComponent

Called once, to create the actual Vaadin component.

Specified by:

createWidget in class WInputComponentWithValue<Decimal>

Returns:

the actual Vaadin component, may be null if the component has no UI counterpart.

isFullyInitialized

protected boolean isFullyInitialized()

Overrides:

isFullyInitialized in class ComponentWithValue<Decimal>

Returns:

true if the component was truly initialized e.g. widgets attach() method is fully finished. The `getWidget().isAttached()` does the job for most components, but not all of them. Notably, decimal field initializes locale *after* `isAttached` was set to true and attachment event was set - therefore neither of those reliably tells when the component is fully initialized.

setNumberFormat

public void setNumberFormat(String numberFormat)

Sets the number format to this field.

Parameters:

numberFormat -

writeInternalState

protected void writeInternalState(Map<String,Object> state)

Description copied from class: FormComponent

Writes the UI state of this component to the provided map. The written state is later used to restore the UI when a saved document or saved Todo is reopened.

Many UI attributes such as size, caption, etc. are not held in the records but are stored exclusively in the Vaadin components. In the records the getter/setter methods of such attributes directly delegate to the underlying component. For the purposes of the Save Document/Todo use case the state of such attributes has to be preserved.

Subclasses should override this method. The overriding method should call super.writeInternalState(state) to store the state form the super class as well. The attributes should be written to the provided state parameter. The type of the values written to the state can only by Java representation of LSPS types. That is java.util.Date, java.lang.String, Decimal, RecordHolder, ListHolder, ... The name of the attributes stored in the map should be unique and should not collide with the names used by any of the superclass. It is the responsibility of the overridden method to ensure that.

Subclasses overriding this method should also override FormComponent.restoreInternalState(Map) and restore the state written by this method.

Overrides:

writeInternalState in class WInputComponentWithValue<Decimal>

Parameters:

state - a map to which this method should write the component's UI state.

See Also:

FormComponent.restoreInternalState(Map), FormComponent.saveState()

restoreInternalState

protected void restoreInternalState(Map<String,Object> state)

Description copied from class: FormComponent

Restores the UI state of this component which was previously written by FormComponent.writeInternalState(Map). Subclasses should override and call super.restoreInternalState(state);

Overrides:

restoreInternalState in class WInputComponentWithValue<Decimal>

Parameters:

state - a map of attributes and their values

See Also:

FormComponent.writeInternalState(Map)