com.whitestein.lsps.vaadin.forms

Class WInputComponentWithValue<T>

java.lang.Object

com.whitestein.lsps.vaadin.forms.FormComponent

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

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

Type Parameters:

T - the value type

All Implemented Interfaces:

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

Direct Known Subclasses:

WAbstractSelect, WAbstractTextField, WCheckBox, WCustomField, WDateField, WDecimalField, WRichTextArea, WSlider, WTokenField, WTree

public abstract class WInputComponentWithValue<T>
extends ComponentWithValue<T>

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

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

Method Summary

Modifier and Type	Method and Description
void	addValidator(ClosureHolder validator) Adds a validator.
protected abstract com.vaadin.ui.AbstractField<?>	createWidget() Called once, to create the actual Vaadin component.
protected void	fireValueChanged()
void	focus() Sets the focus for this component if the component is Component.Focusable.
ClosureHolder	getOnChange() Gets the closure handling the value change event.
ListHolder	getValidationErrors() Returns all validation errors produced by the validators attached to this component.
com.vaadin.ui.AbstractField<?>	getWidget() Gets the Vaadin representation of this component.
void	inferValidator(CollectionHolder tags) Infers validators for the provided tags.
boolean	isConvertible() Indicates if the field value is convertible or not.
boolean	isImmediate() Returns the immediate mode of the component.
boolean	isRequired() Is this field required.
boolean	isValid() Tests the current value against registered validators if the field is not empty.
void	preventGC(Set<ValueHolder> set) Override for all components which are actively using some record holders, not directly linked to the model.
void	removeAllValidators() Removes all validators.
protected void	restoreInternalState(Map<String,Object> state) Restores the UI state of this component which was previously written by FormComponent.writeInternalState(Map).
void	setImmediate(boolean immediate) Sets the component's immediate mode to the specified status.
void	setOnChange(ClosureHolder onChange) Sets the on change handler
void	setRequired(boolean required) Sets the required flag.
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.ComponentWithValue

getBinding, getProperty, isFullyInitialized, 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

WInputComponentWithValue

protected WInputComponentWithValue(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

createWidget

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

Description copied from class: FormComponent

Called once, to create the actual Vaadin component.

Specified by:

createWidget in class FormComponent

Returns:

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

getWidget

public com.vaadin.ui.AbstractField<?> getWidget()

Description copied from class: FormComponent

Gets the Vaadin representation of this component.

Overrides:

getWidget in class FormComponent

Returns:

the Vaadin representation of this form component.

setRequired

public void setRequired(boolean required)

Sets the required flag.

Parameters:

required -

isRequired

public boolean isRequired()

Is this field required. Required fields must filled by the user. If the field is required, it is visually indicated in the user interface. Furthermore, setting field to be required implicitly adds "non-empty" validator and thus isValid() == false or any isEmpty() fields. In those cases validation errors are not painted as it is obvious that the user must fill in the required fields. On the other hand, for the non-required fields isValid() == true if the field isEmpty() regardless of any attached validators.

Returns:

true if the field is required, otherwise false.

focus

public void focus()

Sets the focus for this component if the component is Component.Focusable.

isImmediate

public boolean isImmediate()

Returns the immediate mode of the component.

Certain operations such as adding a value change listener will set the component into immediate mode if setImmediate(boolean) has not been explicitly called with false.

Returns:

true if the component is in immediate mode (explicitly or implicitly set), false if the component if not in immediate mode

setImmediate

public void setImmediate(boolean immediate)

Sets the component's immediate mode to the specified status.

Parameters:

immediate - the boolean value specifying if the component should be in the immediate mode after the call.

setOnChange

public void setOnChange(ClosureHolder onChange)

Sets the on change handler

Parameters:

onChange -

fireValueChanged

protected void fireValueChanged()

getOnChange

public ClosureHolder getOnChange()

Gets the closure handling the value change event.

Returns:

the closure handling the value change event or null if no closure was set.

inferValidator

public void inferValidator(CollectionHolder tags)

Infers validators for the provided tags.

Parameters:

tags -

removeAllValidators

public void removeAllValidators()

Removes all validators.

addValidator

public void addValidator(ClosureHolder validator)

Adds a validator.

Parameters:

validator -

isConvertible

public boolean isConvertible()

Indicates if the field value is convertible or not.

Specified by:

isConvertible in class ComponentWithValue<T>

Returns:

true if the field value is convertible.

isValid

public boolean isValid()

Description copied from class: ComponentWithValue

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.

Specified by:

isValid in class ComponentWithValue<T>

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 ListHolder getValidationErrors()

Description copied from class: ComponentWithValue

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.

Specified by:

getValidationErrors in class ComponentWithValue<T>

Returns:

list of validation errors

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 ComponentWithValue<T>

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 ComponentWithValue<T>

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 ComponentWithValue<T>

Parameters:

state - a map of attributes and their values

See Also:

FormComponent.writeInternalState(Map)