com.whitestein.lsps.vaadin.forms

Class ComponentWithValue<T>

java.lang.Object

com.whitestein.lsps.vaadin.forms.FormComponent

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

Type Parameters:

T - the value type

All Implemented Interfaces:

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

Direct Known Subclasses:

WInputComponentWithValue, WLabel, WPdfViewer

public abstract class ComponentWithValue<T>
extends FormComponent

Author:

mvy

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	ComponentWithValue.ValueChangeListenerImpl
static class	ComponentWithValue.ValueProperty<T> Wraps the forms::Binding LSPS record and adapts it to the Vaadin Property interface.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	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

Modifier	Constructor and Description
protected	ComponentWithValue(Class<T> valueType) Constructor.

Method Summary

Modifier and Type	Method and Description
protected Variant.RecordVariant	getBinding()
RecordHolder	getProperty() Gets the binding of this component.
abstract ListHolder	getValidationErrors() Returns all validation errors produced by the validators attached to this component.
abstract boolean	isConvertible() Indicates if the field value is convertible or not.
protected boolean	isFullyInitialized()
abstract boolean	isValid() Tests the current value against registered validators if the field is not empty.
protected void	onPropertyValueSet(Object newValue) This method is called each time components property value is set.
void	preventGC(Set<ValueHolder> set) Override for all components which are actively using some record holders, not directly linked to the model.
void	refresh() Refreshes the component (binding, datasource, children).
void	refreshBinding() Refreshes the content of this component using the provided binding.
protected void	restoreInternalState(Map<String,Object> state) Restores the UI state of this component which was previously written by FormComponent.writeInternalState(Map).
void	setProperty(RecordHolder property) Sets the binding of this component.
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.FormComponent

addDataErrorMessage, addStyleName, attach, call, clearDataErrorMessages, createEvent, createWidget, equals, getCaption, getComponentAlignment, getContextClickHandler, getCustomErrorMessage, getDataErrorMessages, getDescription, getExpandRatio, getHasChildrenAdapter, getHeight, getIcon, getModelingId, getNamespace, getStyleName, getTabIndex, getWidget, 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

Field Detail

refreshing

protected boolean refreshing

Constructor Detail

ComponentWithValue

protected ComponentWithValue(Class<T> valueType)

Constructor.

Parameters:

valueType - The type of value this component is able to edit. For example, CheckBox puts Boolean.class here.

Method Detail

isFullyInitialized

protected boolean isFullyInitialized()

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.

getBinding

protected final Variant.RecordVariant getBinding()

getProperty

public RecordHolder getProperty()

Gets the binding of this component.

Returns:

property/value binding

setProperty

public void setProperty(RecordHolder property)

Sets the binding of this component.

Parameters:

property -

refresh

public void refresh()

Refreshes the component (binding, datasource, children).

refreshBinding

public void refreshBinding()

Refreshes the content of this component using the provided binding.

preventGC

public void preventGC(Set<ValueHolder> set)

Description copied from class: FormComponent

Override for all components which are actively using some record holders, not directly linked to the model. You will need to return those record holders here, otherwise they will be garbage-collected.

For example, WTabSheet maintains a set of opened tabs. These tab records are not referenced directly from forms::TabSheet and will therefore be garbage-collected. We however need those records to not to be GCed as the user may ask for them simply by calling getTab(Integer).

Please note that the component definition records (e.g. forms::Button) are already GC-protected and they do not need to be added to this set. Also, any child components currently attached to the UI are automatically protected and are not required to be registered in the set.

Overrides:

preventGC in class FormComponent

Parameters:

set - a set of records which are to be GC-prevented, never null. The component should add any records here. Default implementation does nothing.

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 FormComponent

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 FormComponent

Parameters:

state - a map of attributes and their values

See Also:

FormComponent.writeInternalState(Map)

onPropertyValueSet

protected void onPropertyValueSet(Object newValue)

This method is called each time components property value is set. User for example by WTree.

Parameters:

newValue -

isConvertible

public abstract boolean isConvertible()

Indicates if the field value is convertible or not.

Returns:

true if the field value is convertible.

isValid

public abstract boolean isValid()

Tests the current value against registered validators if the field is not empty. If the field is empty it is considered valid if it is not required and invalid otherwise. Validators are never checked for empty fields.

Returns:

true if all registered validators claim that the current value is valid or if the field is empty and not required, false otherwise.

getValidationErrors

public abstract ListHolder getValidationErrors()

Returns all validation errors produced by the validators attached to this component. If there are no validators or all of them pass, returns an empty list (never null). Note: does NOT contain error set by from FormComponent.setCustomErrorMessage(java.lang.String) method.

Returns:

list of validation errors