com.whitestein.lsps.vaadin.forms

Class WTokenField

java.lang.Object

com.whitestein.lsps.vaadin.forms.FormComponent

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

com.whitestein.lsps.vaadin.forms.WInputComponentWithValue<Set<Object>>

com.whitestein.lsps.vaadin.forms.WTokenField

All Implemented Interfaces:

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

public class WTokenField
extends WInputComponentWithValue<Set<Object>>

Author:

jsa

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

Modifier and Type	Field and Description
protected IVaadinContainerDataSourceAdapter	options Data source which provides the options objects.
protected boolean	widgetConfigured

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
WTokenField()

Method Summary

Modifier and Type	Method and Description
protected void	configure()
protected IVaadinContainerDataSourceAdapter	createDataSource(RecordHolder dataSource, RecordHolder captionValueProvider) Called to obtain a data source which will provide available options (row objects) to the select component.
protected org.vaadin.tokenfield.TokenField	createWidget() Called once, to create the actual Vaadin component.
com.whitestein.lsps.vaadin.forms.WTokenField.TokenFieldWidget	getWidget() Gets the Vaadin representation of this component.
boolean	isExcludeSelectedTokens()
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).
protected void	restoreInternalState(Map<String,Object> state) Restores the UI state of this component which was previously written by FormComponent.writeInternalState(Map).
void	setExcludeSelectedTokens(boolean excludeSelectedTokens) Configures whether token field should show selected tokens from the user.
void	setFieldStyle(EnumerationImpl fieldStyle) Set how token field looks like - as combo box or as text field.
void	setOptions(CollectionHolder selectItems) Sets the options given as a collection of uicommon::SelectItems.
void	setOptions(RecordHolder dataSource, RecordHolder captionValueProvider) Configures the AbstractSelect provided by getWidget(): creates a data source via createDataSource(RecordHolder, RecordHolder) and calls AbstractSelect.setContainerDataSource(Container) directs it to use the property caption model Registers WAbstractSelect.VariantConverter ; creates a data source and calls AbstractSelect.setContainerDataSource(Container);
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, inferValidator, isConvertible, isImmediate, isRequired, isValid, removeAllValidators, setImmediate, setOnChange, setRequired

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

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

Field Detail

options

protected IVaadinContainerDataSourceAdapter options

Data source which provides the options objects. Never null.

widgetConfigured

protected boolean widgetConfigured

Constructor Detail

WTokenField

public WTokenField()

Method Detail

createWidget

protected org.vaadin.tokenfield.TokenField createWidget()

Description copied from class: FormComponent

Called once, to create the actual Vaadin component.

Specified by:

createWidget in class WInputComponentWithValue<Set<Object>>

Returns:

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

getWidget

public com.whitestein.lsps.vaadin.forms.WTokenField.TokenFieldWidget getWidget()

Description copied from class: FormComponent

Gets the Vaadin representation of this component.

Overrides:

getWidget in class WInputComponentWithValue<Set<Object>>

Returns:

the Vaadin representation of this form component.

setFieldStyle

public void setFieldStyle(EnumerationImpl fieldStyle)

Set how token field looks like - as combo box or as text field.

Parameters:

fieldStyle - the style of token field

createDataSource

protected IVaadinContainerDataSourceAdapter createDataSource(RecordHolder dataSource,
                                                             RecordHolder captionValueProvider)

Called to obtain a data source which will provide available options (row objects) to the select component. All data source columns are ignored except the "caption" column, which must use captionValueProvider to provide captions for particular option row objects.

Parameters:

dataSource - forms::DataSource instance, may be null - in such case just return EmptyVaadinContainerDataSourceAdapter.

captionValueProvider - provides captions for options from the data source.

Returns:

a data source containing at least the "caption" column. Must not return null.

configure

protected void configure()

setOptions

public void setOptions(RecordHolder dataSource,
                       RecordHolder captionValueProvider)

Configures the AbstractSelect provided by getWidget():

• creates a data source via createDataSource(RecordHolder, RecordHolder) and calls AbstractSelect.setContainerDataSource(Container)
• directs it to use the property caption model
• Registers WAbstractSelect.VariantConverter

; creates a data source and calls AbstractSelect.setContainerDataSource(Container);

Parameters:

dataSource - forms::DataSource instance

captionValueProvider - forms::ValueProvider instance.

setOptions

public void setOptions(CollectionHolder selectItems)

Sets the options given as a collection of uicommon::SelectItems.

Parameters:

selectItems - select items representing the options

setExcludeSelectedTokens

public void setExcludeSelectedTokens(boolean excludeSelectedTokens)

Configures whether token field should show selected tokens from the user.

Parameters:

excludeSelectedTokens - - if it is true, token field will NOT show selected tokens among suggestions. If it is false, selected token fields will be suggested.

isExcludeSelectedTokens

public boolean isExcludeSelectedTokens()

Returns:

true if the field shows selected tokens among its suggestions, false otherwise.

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 WInputComponentWithValue<Set<Object>>

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 WInputComponentWithValue<Set<Object>>

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<Set<Object>>

Parameters:

state - a map of attributes and their values

See Also:

FormComponent.writeInternalState(Map)

refresh

public void refresh()

Description copied from class: ComponentWithValue

Refreshes the component (binding, datasource, children).

Overrides:

refresh in class ComponentWithValue<Set<Object>>