com.haulmont.cuba.gui.components

Interface LookupField<V>

Type Parameters:

V - type of options and value

All Superinterfaces:

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

All Known Subinterfaces:

LookupPickerField<V>, SearchField<V>, SearchPickerField<V>

public interface LookupField<V>
extends OptionsField<V,V>, HasInputPrompt, Buffered, LookupComponent, Component.Focusable, HasOptionsStyleProvider<V>

A filtering dropdown single-select. Items are filtered based on user input.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	LookupField.FilterMode
static interface	LookupField.FilterPredicate A predicate that tests whether an item with the given caption matches to the given search string.
static interface	LookupField.NewOptionHandler Deprecated.
static interface	LookupField.OptionIconProvider<T> Deprecated.

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

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

LookupComponent.LookupSelectionChangeEvent<T extends Entity>, LookupComponent.LookupSelectionChangeNotifier<T extends Entity>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME
static com.google.common.reflect.TypeToken<LookupField<java.lang.String>>	TYPE_STRING

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
LookupField.FilterMode	getFilterMode()
LookupField.FilterPredicate	getFilterPredicate()
java.util.function.Consumer<java.lang.String>	getNewOptionHandler()
V	getNullOption() Deprecated. Use getNullSelectionCaption() instead
java.lang.String	getNullSelectionCaption()
java.util.function.Function<? super V,java.lang.String>	getOptionIconProvider()
java.util.function.Function<? super V,Resource>	getOptionImageProvider()
int	getPageLength()
java.lang.String	getPopupWidth() Returns the suggestion pop-up's width as a string.
boolean	isAutomaticPopupOnFocus()
boolean	isNewOptionAllowed() Deprecated.
boolean	isNullOptionVisible()
boolean	isTextInputAllowed()
static <T> com.google.common.reflect.TypeToken<LookupField<T>>	of(java.lang.Class<T> valueClass)
void	setAutomaticPopupOnFocus(boolean automaticPopupOnFocus) When enabled popup automatically opens on focus.
void	setFilterMode(LookupField.FilterMode mode)
void	setFilterPredicate(LookupField.FilterPredicate filterPredicate) Enables to setup how items should be filtered.
void	setNewOptionAllowed(boolean newOptionAllowed) Deprecated. setting the new option handler enables new options
void	setNewOptionHandler(java.util.function.Consumer<java.lang.String> newOptionHandler) Sets the handler that is called when user types a new item.
void	setNullOption(V nullOption) Deprecated. Use setNullSelectionCaption(String) instead
void	setNullOptionVisible(boolean nullOptionVisible) Sets visibility for first null element in suggestion popup.
void	setNullSelectionCaption(java.lang.String nullOption) Sets the null selection caption.
void	setOptionIconProvider(java.lang.Class<V> optionClass, java.util.function.Function<? super V,java.lang.String> optionIconProvider) Deprecated. Use setOptionIconProvider(Function)
void	setOptionIconProvider(java.util.function.Function<? super V,java.lang.String> optionIconProvider) Set the icon provider for the LookupField.
void	setOptionImageProvider(java.util.function.Function<? super V,Resource> optionImageProvider) Sets a function that provides option images.
void	setPageLength(int pageLength) Sets the page length for the suggestion popup.
void	setPopupWidth(java.lang.String width) Sets the suggestion pop-up's width as a string.
void	setTextInputAllowed(boolean textInputAllowed) Sets whether it is possible to input text into the field or whether the field area of the component is just used to show what is selected.

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

getOptions, getOptionsDatasource, getOptionsEnum, getOptionsList, getOptionsMap, setOptions, setOptionsDatasource, setOptionsEnum, setOptionsList, setOptionsMap

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, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

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

isHtmlSanitizerEnabled, setHtmlSanitizerEnabled

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

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

getInputPrompt, setInputPrompt

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

commit, discard, isBuffered, isModified, setBuffered

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

getLookupSelectedItems, setLookupSelectHandler

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

getOptionsStyleProvider, getOptionStyleProvider, setOptionsStyleProvider, setOptionStyleProvider

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

TYPE_STRING

static final com.google.common.reflect.TypeToken<LookupField<java.lang.String>> TYPE_STRING

Method Detail

of

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

getNullOption

@Deprecated
V getNullOption()

Deprecated. Use getNullSelectionCaption() instead

setNullOption

@Deprecated
void setNullOption(V nullOption)

Deprecated. Use setNullSelectionCaption(String) instead

getNullSelectionCaption

java.lang.String getNullSelectionCaption()

Returns:

the null selection caption, not null

setNullSelectionCaption

void setNullSelectionCaption(java.lang.String nullOption)

Sets the null selection caption.

The empty string "" is the default null selection caption.

If null selection is allowed then the null item will be shown with the given caption.

Parameters:

nullOption - the caption to set, not null

getFilterMode

LookupField.FilterMode getFilterMode()

setFilterMode

void setFilterMode(LookupField.FilterMode mode)

isNewOptionAllowed

@Deprecated
boolean isNewOptionAllowed()

Deprecated.

Returns:

true if the component handles new options entered by user.

See Also:

setNewOptionHandler(Consumer)

setNewOptionAllowed

@Deprecated
void setNewOptionAllowed(boolean newOptionAllowed)

Deprecated. setting the new option handler enables new options

Makes the component handle new options entered by user.

See Also:

setNewOptionHandler(Consumer)

isTextInputAllowed

boolean isTextInputAllowed()

Returns:

true if text input allowed

setTextInputAllowed

void setTextInputAllowed(boolean textInputAllowed)

Sets whether it is possible to input text into the field or whether the field area of the component is just used to show what is selected.

setAutomaticPopupOnFocus

void setAutomaticPopupOnFocus(boolean automaticPopupOnFocus)

When enabled popup automatically opens on focus.

isAutomaticPopupOnFocus

boolean isAutomaticPopupOnFocus()

Returns:

whether popup is automatically shows on focus.

getNewOptionHandler

java.util.function.Consumer<java.lang.String> getNewOptionHandler()

Returns:

current handler

setNewOptionHandler

void setNewOptionHandler(java.util.function.Consumer<java.lang.String> newOptionHandler)

Sets the handler that is called when user types a new item.

Parameters:

newOptionHandler - handler instance

getPageLength

int getPageLength()

Returns:

the page length of the suggestion popup.

setPageLength

void setPageLength(int pageLength)

Sets the page length for the suggestion popup. Setting the page length to 0 will disable suggestion popup paging (all items visible).

Parameters:

pageLength - the pageLength to set

setNullOptionVisible

void setNullOptionVisible(boolean nullOptionVisible)

Sets visibility for first null element in suggestion popup.

isNullOptionVisible

boolean isNullOptionVisible()

Returns:

true if first null element is visible.

setOptionIconProvider

void setOptionIconProvider(java.util.function.Function<? super V,java.lang.String> optionIconProvider)

Set the icon provider for the LookupField.

Parameters:

optionIconProvider - provider which provides icons for options

setOptionIconProvider

@Deprecated
void setOptionIconProvider(java.lang.Class<V> optionClass,
                                       java.util.function.Function<? super V,java.lang.String> optionIconProvider)

Deprecated. Use setOptionIconProvider(Function)

Set the icon provider for LookupField.

Parameters:

optionClass - class of the option

optionIconProvider - provider which provides icons for options

getOptionIconProvider

java.util.function.Function<? super V,java.lang.String> getOptionIconProvider()

Returns:

icon provider of the LookupField.

setOptionImageProvider

void setOptionImageProvider(java.util.function.Function<? super V,Resource> optionImageProvider)

Sets a function that provides option images.

Parameters:

optionImageProvider - options image provider

See Also:

Resource

getOptionImageProvider

java.util.function.Function<? super V,Resource> getOptionImageProvider()

Returns:

options image provider.

setFilterPredicate

void setFilterPredicate(LookupField.FilterPredicate filterPredicate)

Enables to setup how items should be filtered.

Parameters:

filterPredicate - items filter predicate

getFilterPredicate

LookupField.FilterPredicate getFilterPredicate()

Returns:

items filter predicate

getPopupWidth

java.lang.String getPopupWidth()

Returns the suggestion pop-up's width as a string. By default this width is set to null.

Returns:

explicitly set popup width as size string or null if not set

setPopupWidth

void setPopupWidth(java.lang.String width)

Sets the suggestion pop-up's width as a string. By using relative units (e.g. "50%") it's possible to set the popup's width relative to the LookupField itself.

By default this width is set to null so that the popup's width can be greater than a component width to fit the content of all displayed items. By setting width to "100%" the pop-up's width will be equal to the width of the LookupField.

Parameters:

width - the width