com.whitestein.lsps.vaadin.forms

Class WMultiselectComboBox

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

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

com.whitestein.lsps.vaadin.forms.WMultiselectComboBox

All Implemented Interfaces:

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

public class WMultiselectComboBox
extends WAbstractMultiSelect<Object>

Author:

mvy

See Also:

Serialized Form

Nested Class Summary

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

WAbstractMultiSelect.SetHolderConverter

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

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.
protected com.vaadin.ui.AbstractSelect	createWidget() Called once, to create the actual Vaadin component.
String	getInputPrompt() Gets the current input prompt.
Decimal	getPageLength() Gets the length of the popup page
com.whitestein.lsps.vaadin.extensions.ComboBoxMultiselect	getWidget() Gets the Vaadin representation of this component.
boolean	isNullSelectionAllowed() Checks if null empty selection is allowed by the user.
void	setInputPrompt(String inputPrompt) Sets the input prompt - a textual prompt that is displayed when the select would otherwise be empty, to prompt the user for input.
void	setPageLength(Decimal pageLength) Sets the length of the popup page.

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

configure, setOptions

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

preventGC, refresh, restoreInternalState, setNullSelectionAllowed, setOptions, setOptionsToContainer, writeInternalState

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

WMultiselectComboBox

public WMultiselectComboBox()

Method Detail

createWidget

protected com.vaadin.ui.AbstractSelect createWidget()

Description copied from class: FormComponent

Called once, to create the actual Vaadin component.

Specified by:

createWidget in class WAbstractSelect<Set<Object>>

Returns:

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

isNullSelectionAllowed

public boolean isNullSelectionAllowed()

Checks if null empty selection is allowed by the user.

Overrides:

isNullSelectionAllowed in class WAbstractSelect<Set<Object>>

Returns:

whether or not empty selection is allowed

See Also:

WAbstractSelect.setNullSelectionAllowed(boolean)

getWidget

public com.whitestein.lsps.vaadin.extensions.ComboBoxMultiselect getWidget()

Description copied from class: FormComponent

Gets the Vaadin representation of this component.

Overrides:

getWidget in class WAbstractSelect<Set<Object>>

Returns:

the Vaadin representation of this form component.

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

setPageLength

public void setPageLength(Decimal pageLength)

Sets the length of the popup page.

Parameters:

pageLength -

getPageLength

public Decimal getPageLength()

Gets the length of the popup page

Returns:

the page length

getInputPrompt

public String getInputPrompt()

Gets the current input prompt.

Returns:

the current input prompt, or null if not enabled

See Also:

setInputPrompt(String)

setInputPrompt

public void setInputPrompt(String inputPrompt)

Sets the input prompt - a textual prompt that is displayed when the select would otherwise be empty, to prompt the user for input.

Parameters:

inputPrompt - the desired input prompt, or null to disable