com.haulmont.cuba.gui.components

Interface SuggestionField<V>

Type Parameters:

V - type of value

All Superinterfaces:

Component, Component.BelongToFrame, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, DatasourceComponent<V>, Field<V>, HasCaptionMode, HasContextHelp, HasHtmlCaption, HasHtmlDescription, HasInputPrompt, HasOptionCaptionProvider<V>, HasOptionsStyleProvider<V>, HasValue<V>, HasValueSource<V>, Validatable

All Known Subinterfaces:

SuggestionPickerField<V>

public interface SuggestionField<V>
extends Field<V>, Component.Focusable, HasInputPrompt, HasOptionsStyleProvider<V>, HasOptionCaptionProvider<V>, HasCaptionMode

A filtering dropdown single-select. Items are filtered based on user input using asynchronous data loading.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SuggestionField.ArrowDownActionHandler ARROW_DOWN key pressed listener.
static interface	SuggestionField.EnterActionHandler ENTER key pressed listener.
static class	SuggestionField.OptionWrapper<V> Represents a value and its string representation.
static interface	SuggestionField.ParametrizedSearchExecutor<E> Extended version of SuggestionField.SearchExecutor that allows to pass parameters.
static interface	SuggestionField.SearchExecutor<E> Custom suggestions search action interface.

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Field

Field.Validator<T>

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.HasValue

HasValue.ValueChangeEvent<V>

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Component

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.OptionsStyleProvider, Component.Wrapper

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.HasContextHelp

HasContextHelp.ContextHelpIconClickEvent

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME
static java.lang.String	POPUP_AUTO_WIDTH
static java.lang.String	POPUP_PARENT_WIDTH

Fields inherited from interface com.haulmont.cuba.gui.components.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE, UNITS_PERCENTAGE, UNITS_PIXELS

Method Summary

Modifier and Type	Method and Description
SuggestionField.ArrowDownActionHandler	getArrowDownActionHandler()
int	getAsyncSearchDelayMs()
SuggestionField.EnterActionHandler	getEnterActionHandler()
int	getMinSearchStringLength()
java.lang.String	getPopupWidth()
SuggestionField.SearchExecutor	getSearchExecutor()
int	getSuggestionsLimit()
static <T> com.google.common.reflect.TypeToken<SuggestionField<T>>	of(java.lang.Class<T> valueClass)
void	setArrowDownActionHandler(SuggestionField.ArrowDownActionHandler arrowDownActionHandler) Sets SuggestionField.ArrowDownActionHandler which handles ARROW_DOWN key pressing.
void	setAsyncSearchDelayMs(int asyncSearchDelayMs) Sets delay between the last key press action and async search.
void	setEnterActionHandler(SuggestionField.EnterActionHandler enterActionHandler) Sets SuggestionField.EnterActionHandler which handles ENTER key pressing.
void	setMinSearchStringLength(int minSearchStringLength) Sets min string length which is required to perform suggestions search.
void	setPopupWidth(java.lang.String width) Sets the given width to the component popup.
void	setSearchExecutor(SuggestionField.SearchExecutor searchExecutor) Sets SuggestionField.SearchExecutor which performs search.
void	setSuggestionsLimit(int suggestionsLimit) Sets limit of suggestions which will be shown.
void	showSuggestions(java.util.List<V> suggestions) Show passed suggestions in popup.

Methods inherited from interface com.haulmont.cuba.gui.components.Field

addValidator, addValidators, getRequiredMessage, getValidators, isRequired, removeValidator, setRequired, setRequiredMessage

Methods inherited from interface com.haulmont.cuba.gui.components.DatasourceComponent

getDatasource, getMetaProperty, getMetaPropertyPath, setDatasource

Methods inherited from interface com.haulmont.cuba.gui.components.HasValue

addValueChangeListener, clear, getEmptyValue, getValue, isEmpty, removeValueChangeListener, setValue

Methods inherited from interface com.haulmont.cuba.gui.components.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, getWidthUnits, isEnabled, isEnabledItself, isEnabledRecursive, isResponsive, isVisible, isVisibleItself, isVisibleRecursive, removeStyleName, requestFocus, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition

Methods inherited from interface com.haulmont.cuba.gui.components.data.HasValueSource

getValueSource, setValueSource

Methods inherited from interface com.haulmont.cuba.gui.components.Component.Editable

isEditable, isEditableWithParent, setEditable

Methods inherited from interface com.haulmont.cuba.gui.components.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface com.haulmont.cuba.gui.components.Validatable

isValid, isValidateOnCommit, validate

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasIcon

getIcon, setIcon, setIconFromSet

Methods inherited from interface com.haulmont.cuba.gui.components.HasContextHelp

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

Methods inherited from interface com.haulmont.cuba.gui.components.HasHtmlCaption

isCaptionAsHtml, setCaptionAsHtml

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasCaption

getCaption, setCaption

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasDescription

getDescription, setDescription

Methods inherited from interface com.haulmont.cuba.gui.components.HasHtmlDescription

isDescriptionAsHtml, setDescriptionAsHtml

Methods inherited from interface com.haulmont.cuba.gui.components.Component.Focusable

focus, getTabIndex, isFocusable, setFocusable, setTabIndex

Methods inherited from interface com.haulmont.cuba.gui.components.HasInputPrompt

getInputPrompt, setInputPrompt

Methods inherited from interface com.haulmont.cuba.gui.components.HasOptionsStyleProvider

getOptionsStyleProvider, getOptionStyleProvider, setOptionsStyleProvider, setOptionStyleProvider

Methods inherited from interface com.haulmont.cuba.gui.components.HasOptionCaptionProvider

getOptionCaptionProvider, setOptionCaptionProvider

Methods inherited from interface com.haulmont.cuba.gui.components.HasCaptionMode

getCaptionMode, getCaptionProperty, setCaptionMode, setCaptionProperty

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

POPUP_AUTO_WIDTH

static final java.lang.String POPUP_AUTO_WIDTH

See Also:

Constant Field Values

POPUP_PARENT_WIDTH

static final java.lang.String POPUP_PARENT_WIDTH

See Also:

Constant Field Values

Method Detail

of

static <T> com.google.common.reflect.TypeToken<SuggestionField<T>> of(java.lang.Class<T> valueClass)

getAsyncSearchDelayMs

int getAsyncSearchDelayMs()

Returns:

delay between the last key press action and async search

setAsyncSearchDelayMs

void setAsyncSearchDelayMs(int asyncSearchDelayMs)

Sets delay between the last key press action and async search.

Parameters:

asyncSearchDelayMs - delay in ms

getSearchExecutor

SuggestionField.SearchExecutor getSearchExecutor()

Returns:

SuggestionField.SearchExecutor which performs search

setSearchExecutor

void setSearchExecutor(SuggestionField.SearchExecutor searchExecutor)

Sets SuggestionField.SearchExecutor which performs search.

Parameters:

searchExecutor - SearchExecutor instance

getEnterActionHandler

SuggestionField.EnterActionHandler getEnterActionHandler()

Returns:

SuggestionField.EnterActionHandler which handles ENTER key pressing

setEnterActionHandler

void setEnterActionHandler(SuggestionField.EnterActionHandler enterActionHandler)

Sets SuggestionField.EnterActionHandler which handles ENTER key pressing.

Parameters:

enterActionHandler - EnterActionHandler instance

getArrowDownActionHandler

SuggestionField.ArrowDownActionHandler getArrowDownActionHandler()

Returns:

SuggestionField.ArrowDownActionHandler which handles ARROW_DOWN key pressing

setArrowDownActionHandler

void setArrowDownActionHandler(SuggestionField.ArrowDownActionHandler arrowDownActionHandler)

Sets SuggestionField.ArrowDownActionHandler which handles ARROW_DOWN key pressing.

Parameters:

arrowDownActionHandler - ArrowDownActionHandler instance

getMinSearchStringLength

int getMinSearchStringLength()

Returns:

min string length to perform suggestions search

setMinSearchStringLength

void setMinSearchStringLength(int minSearchStringLength)

Sets min string length which is required to perform suggestions search.

Parameters:

minSearchStringLength - required string length to perform search

getSuggestionsLimit

int getSuggestionsLimit()

Returns:

limit of suggestions which will be shown

setSuggestionsLimit

void setSuggestionsLimit(int suggestionsLimit)

Sets limit of suggestions which will be shown.

Parameters:

suggestionsLimit - integer limit value

showSuggestions

void showSuggestions(java.util.List<V> suggestions)

Show passed suggestions in popup.

Parameters:

suggestions - suggestions to show

setPopupWidth

void setPopupWidth(java.lang.String width)

Sets the given width to the component popup. There are two predefined settings available: POPUP_AUTO_WIDTH and POPUP_PARENT_WIDTH.

Parameters:

width - width of the component popup

getPopupWidth

java.lang.String getPopupWidth()

Returns:

component popup width