com.whitestein.lsps.vaadin.forms

Class WSearchComboBox

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

com.whitestein.lsps.vaadin.forms.WSearchComboBox

All Implemented Interfaces:

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

public class WSearchComboBox
extends WAbstractComboBox

Combo-box fine tuned for showing large sets of data and lazy query container filtering. The combo-box does not filter data as the user types the text, filtering happens only if user stops typing for a while. This delay is configured via setFilterTimeout(Decimal). Short filter text is ignored even if user stopped typing. The minimal length the text must have in order to be used for filtering is configured via setMinimalFilterLength(Decimal) method.

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
WSearchComboBox() Creates a new combo box.

Method Summary

Modifier and Type	Method and Description
protected com.vaadin.ui.AbstractSelect	createWidget() Called once, to create the actual Vaadin component.
Decimal	getFilterTimeout() Search combo-box does not refresh drop down content until user stopped typing for timeout milliseconds.
String	getInputPrompt() Gets the current input prompt.
Decimal	getMinimalFilterLength() The minimal length the text typed into the combo box must have in order to be used for filtering.
Decimal	getPageLength() Gets the length of the popup page
com.whitestein.lsps.vaadin.extensions.SearchComboBox	getWidget() Gets the Vaadin representation of this component.
protected void	restoreInternalState(Map<String,Object> state) Restores the UI state of this component which was previously written by FormComponent.writeInternalState(Map).
void	setFilterTimeout(Decimal timeout) Search combo-box does not refresh drop down content until user stopped typing for timeout milliseconds.
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	setMinimalFilterLength(Decimal minFilterLength) The minimal length the text typed into the combo box must have in order to be used for filtering.
void	setPageLength(Decimal pageLength) Sets the length of the popup page.
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.WAbstractComboBox

createDataSource, refresh, setExtendableOptions, setNewItemHandler, setOptions

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

configure, 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

WSearchComboBox

public WSearchComboBox()

Creates a new combo box.

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

Returns:

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

getWidget

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

Description copied from class: FormComponent

Gets the Vaadin representation of this component.

Overrides:

getWidget in class WAbstractSelect<Object>

Returns:

the Vaadin representation of this form component.

setMinimalFilterLength

public void setMinimalFilterLength(Decimal minFilterLength)

The minimal length the text typed into the combo box must have in order to be used for filtering. Text longer then minFilterLength is used as a filter for drop down options - only options containing typed substring are available. Shorter text typed into the combo-box is ignored and all options are shown.

Parameters:

minFilterLength - - minimal length of filter

getMinimalFilterLength

public Decimal getMinimalFilterLength()

The minimal length the text typed into the combo box must have in order to be used for filtering. Text longer then minFilterLength is used as a filter for drop down options - only options containing typed substring are available. Shorter text typed into the combo-box is ignored and all options are shown.

Returns:

minimal filter length

setFilterTimeout

public void setFilterTimeout(Decimal timeout)

Search combo-box does not refresh drop down content until user stopped typing for timeout milliseconds.

Parameters:

timeout -

getFilterTimeout

public Decimal getFilterTimeout()

Search combo-box does not refresh drop down content until user stopped typing for timeout milliseconds.

Returns:

expected pause in typing before the combo-box search for data

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

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 WAbstractComboBox

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 WAbstractComboBox

Parameters:

state - a map of attributes and their values

See Also:

FormComponent.writeInternalState(Map)

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