com.haulmont.cuba.gui.components

Interface LookupField

All Superinterfaces:

Component, Component.BelongToFrame, Component.Buffered, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasContextHelp, Component.HasIcon, Component.HasInputPrompt, Component.HasOptionsStyleProvider, Component.HasValue, Component.Validatable, DatasourceComponent, Field, LookupComponent, OptionsField

All Known Subinterfaces:

LookupPickerField, SearchField, SearchPickerField

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

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 Interface to be implemented if setNewOptionAllowed(boolean) is set to true.
static interface	LookupField.OptionIconProvider<T> Allows to set icons for particular elements in the options list.

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

Field.Validator

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

Component.ActionOwner, Component.ActionsHolder, Component.Alignment, Component.BelongToFrame, Component.Buffered, Component.ChildEditableController, Component.Collapsable, Component.Container, Component.ContextHelpIconClickEvent, Component.Disposable, Component.Editable, Component.EditableChangeEvent, Component.EditableChangeListener, Component.EditableChangeNotifier, Component.ExpandedStateChangeEvent, Component.ExpandedStateChangeListener, Component.Focusable, Component.HasBorder, Component.HasButtonsPanel, Component.HasCaption, Component.HasContextHelp, Component.HasFormatter, Component.HasIcon, Component.HasInputPrompt, Component.HasNamedComponents, Component.HasOptionsStyleProvider, Component.HasPresentations, Component.HasRowsCount, Component.HasSettings, Component.HasValue, Component.HasXmlDescriptor, Component.LayoutClickEvent, Component.LayoutClickListener, Component.LayoutClickNotifier, Component.Margin, Component.MouseEventDetails, Component.OptionsStyleProvider, Component.OrderedContainer, Component.OuterMargin, Component.SecuredActionsHolder, Component.ShortcutAction, Component.ShortcutNotifier, Component.ShortcutTriggeredEvent, Component.Spacing, Component.UiPermissionAware, Component.Validatable, Component.ValueChangeEvent, Component.ValueChangeListener, Component.Wrapper

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

LookupComponent.LookupSelectionChangeEvent, LookupComponent.LookupSelectionChangeListener, LookupComponent.LookupSelectionChangeNotifier

Field Summary

Fields

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

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

AUTO_SIZE, AUTO_SIZE_PX, UNITS_PERCENTAGE, UNITS_PIXELS

Method Summary

Modifier and Type	Method and Description
LookupField.FilterMode	getFilterMode()
LookupField.FilterPredicate	getFilterPredicate()
LookupField.NewOptionHandler	getNewOptionHandler()
java.lang.Object	getNullOption()
LookupField.OptionIconProvider<?>	getOptionIconProvider()
int	getPageLength()
boolean	isAutomaticPopupOnFocus()
boolean	isNewOptionAllowed()
boolean	isNullOptionVisible()
boolean	isTextInputAllowed()
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) Makes the component handle new options entered by user.
void	setNewOptionHandler(LookupField.NewOptionHandler newOptionHandler) Set handler.
void	setNullOption(java.lang.Object nullOption)
void	setNullOptionVisible(boolean nullOptionVisible) Sets visibility for first null element in suggestion popup.
<T> void	setOptionIconProvider(java.lang.Class<T> optionClass, LookupField.OptionIconProvider<T> optionIconProvider) Set the icon provider for LookupField.
void	setOptionIconProvider(LookupField.OptionIconProvider<?> optionIconProvider) Set the icon provider for the LookupField.
void	setPageLength(int pageLength) Sets the page length for the suggestion popup.
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

getCaptionMode, getCaptionProperty, getDescriptionProperty, getOptionsDatasource, getOptionsEnum, getOptionsList, getOptionsMap, isMultiSelect, setCaptionMode, setCaptionProperty, setDescriptionProperty, setMultiSelect, setOptionsDatasource, setOptionsEnum, setOptionsList, setOptionsMap

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

addValidator, 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.Component.HasValue

addListener, addValueChangeListener, getValue, removeListener, removeValueChangeListener, setValue

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

addStyleName, getAlignment, getDebugId, getHeight, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthUnits, isEnabled, isEnabledItself, isResponsive, isVisible, isVisibleItself, removeStyleName, requestFocus, setAlignment, setDebugId, 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.Component.HasCaption

getCaption, getDescription, setCaption, setDescription

Methods inherited from interface com.haulmont.cuba.gui.components.Component.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.Component.HasContextHelp

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

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

getTabIndex, isFocusable, setFocusable, setTabIndex

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

getLookupSelectedItems, setLookupSelectHandler

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

getInputPrompt, setInputPrompt

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

commit, discard, isBuffered, isModified, setBuffered

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

getOptionsStyleProvider, setOptionsStyleProvider

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

getNullOption

java.lang.Object getNullOption()

setNullOption

void setNullOption(java.lang.Object nullOption)

getFilterMode

LookupField.FilterMode getFilterMode()

setFilterMode

void setFilterMode(LookupField.FilterMode mode)

isNewOptionAllowed

boolean isNewOptionAllowed()

Returns:

true if the component handles new options entered by user.

See Also:

LookupField.NewOptionHandler

setNewOptionAllowed

void setNewOptionAllowed(boolean newOptionAllowed)

Makes the component handle new options entered by user.

See Also:

LookupField.NewOptionHandler

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

LookupField.NewOptionHandler getNewOptionHandler()

Returns:

current handler

setNewOptionHandler

void setNewOptionHandler(LookupField.NewOptionHandler newOptionHandler)

Set handler.

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(LookupField.OptionIconProvider<?> optionIconProvider)

Set the icon provider for the LookupField.

Parameters:

optionIconProvider - provider which provides icons for options

setOptionIconProvider

<T> void setOptionIconProvider(java.lang.Class<T> optionClass,
                               LookupField.OptionIconProvider<T> optionIconProvider)

Set the icon provider for LookupField.

Parameters:

optionClass - class of the option

optionIconProvider - provider which provides icons for options

getOptionIconProvider

LookupField.OptionIconProvider<?> getOptionIconProvider()

Returns:

icon provider of the LookupField.

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