com.whitestein.lsps.vaadin.forms

Class WAbstractComboBox

java.lang.Object

com.whitestein.lsps.vaadin.forms.FormComponent

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

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

com.whitestein.lsps.vaadin.forms.WAbstractSelect<Object>

com.whitestein.lsps.vaadin.forms.WAbstractComboBox

All Implemented Interfaces:

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

Direct Known Subclasses:

WComboBox, WSearchComboBox

public abstract class WAbstractComboBox
extends WAbstractSelect<Object>

Author:

mna

See Also:

Serialized Form

Nested Class Summary

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

WAbstractSelect.VariantConverter

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.WAbstractSelect

options, PROPERTY_CAPTION, 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
WAbstractComboBox(Class<Object> valueType)

Method Summary

Modifier and Type	Method and Description
protected IVaadinContainerDataSourceAdapter	createDataSource(RecordHolder dataSource, RecordHolder captionValueProvider) Called to obtain a data source which will provide available options (row objects) to the select component.
void	refresh() 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	setExtendableOptions(CollectionHolder selectItems, RecordHolder captionValueProvider) Sets the options given as a collection of uicommon::SelectItems.
void	setNewItemHandler(ClosureHolder itemProvider) Enables or disables possibility to add new options by the user.
void	setOptions(CollectionHolder selectItems) Sets the options given as a collection of uicommon::SelectItems.
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.WAbstractSelect

configure, createWidget, getWidget, isNullSelectionAllowed, preventGC, setNullSelectionAllowed, setOptions, setOptionsToContainer

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

Constructor Detail

WAbstractComboBox

public WAbstractComboBox(Class<Object> valueType)

Method Detail

setNewItemHandler

public void setNewItemHandler(ClosureHolder itemProvider)

Enables or disables possibility to add new options by the user. The itemProvider is expected to convert string user wrote into textfield to value. Returned object will be set to the combo-box and available via getValue method. It will be selected in combo-box, but wont appear in the dropdown list. If user de-selects the value, it dissappears from the combo. The label of the new item is generated by caption provider supplied via setOptions(Collection options*, ValueProvider caption) method. If none is supplied, result items toString method is used. If the itemProvider parameter is null, user wont be able to add new options to the drop down - value written into the field will be treated as filter only.

Parameters:

itemProvider - - converts string into object

createDataSource

protected IVaadinContainerDataSourceAdapter createDataSource(RecordHolder dataSource,
                                                             RecordHolder captionValueProvider)

Description copied from class: WAbstractSelect

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.

Overrides:

createDataSource in class WAbstractSelect<Object>

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.

refresh

public void refresh()

Refreshes the content of this component using the provided binding. Data source is refreshed too.

Overrides:

refresh in class WAbstractSelect<Object>

setOptions

public void setOptions(CollectionHolder selectItems)

Description copied from class: WAbstractSelect

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

Overrides:

setOptions in class WAbstractSelect<Object>

Parameters:

selectItems - select items representing the options

setExtendableOptions

public void setExtendableOptions(CollectionHolder selectItems,
                                 RecordHolder captionValueProvider)

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

Parameters:

selectItems - - select items representing the options

captionValueProvider - - generates labels for items not contained in selectItems collection. Defaults to ToStringValueProvider.

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

Parameters:

state - a map of attributes and their values

See Also:

FormComponent.writeInternalState(Map)

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

Parameters:

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

See Also:

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