com.haulmont.cuba.gui.components

Interface TokenList<V extends Entity>

All Superinterfaces:

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

public interface TokenList<V extends Entity>
extends Field<java.util.Collection<V>>, Component.BelongToFrame, Component.HasCaption, Component.Editable, Component.Focusable, HasCaptionMode, HasOptionCaptionProvider<V>

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	TokenList.AfterLookupCloseHandler Deprecated. use setLookupProvider(Supplier) instead
static interface	TokenList.AfterLookupSelectionHandler Deprecated. use setLookupProvider(Supplier) instead
static interface	TokenList.ItemChangeHandler Enables to handle selected items change.
static interface	TokenList.ItemClickListener Selected items click handler.
static class	TokenList.Position Defines component editor position.
static interface	TokenList.TokenStyleGenerator 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

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, FULL_SIZE, UNITS_PERCENTAGE, UNITS_PIXELS

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAddButtonCaption()
java.lang.String	getAddButtonIcon()
TokenList.AfterLookupCloseHandler	getAfterLookupCloseHandler() Deprecated. use setLookupProvider(Supplier) instead
TokenList.AfterLookupSelectionHandler	getAfterLookupSelectionHandler() Deprecated. use setLookupProvider(Supplier) instead
java.lang.String	getClearButtonCaption()
java.lang.String	getClearButtonIcon()
default CollectionDatasource	getDatasource() Deprecated. use HasValueSource.getValueSource() instead
LookupField.FilterMode	getFilterMode()
TokenList.ItemChangeHandler	getItemChangeHandler()
TokenList.ItemClickListener	getItemClickListener()
java.util.function.Function<? super V,java.lang.String>	getLookupFieldOptionsCaptionProvider()
java.lang.String	getLookupInputPrompt()
WindowManager.OpenType	getLookupOpenMode() Deprecated.
java.util.function.Supplier<Screen>	getLookupProvider()
java.lang.String	getLookupScreen() Deprecated.
java.util.Map<java.lang.String,java.lang.Object>	getLookupScreenParams() Deprecated.
Options<V>	getOptions()
CaptionMode	getOptionsCaptionMode() Deprecated. use getLookupFieldOptionsCaptionProvider()
java.lang.String	getOptionsCaptionProperty() Deprecated. use getLookupFieldOptionsCaptionProvider() instead
default CollectionDatasource	getOptionsDatasource() Deprecated. use getOptions() instead
default java.util.List	getOptionsList() Deprecated. use getOptions() instead
default java.util.Map<java.lang.String,?>	getOptionsMap() Deprecated. use getOptions() instead
TokenList.Position	getPosition()
java.util.function.Function<java.lang.Object,java.lang.String>	getTokenStyleGenerator() Deprecated.
boolean	isClearEnabled()
boolean	isInline()
boolean	isLookup()
boolean	isMultiSelect()
boolean	isRefreshOptionsOnLookupClose()
boolean	isSimple()
void	setAddButtonCaption(java.lang.String caption) Sets "Add" button caption.
void	setAddButtonIcon(java.lang.String icon) Sets "Add" button icon.
void	setAfterLookupCloseHandler(TokenList.AfterLookupCloseHandler handler) Deprecated. use setLookupProvider(Supplier) instead
void	setAfterLookupSelectionHandler(TokenList.AfterLookupSelectionHandler handler) Deprecated. use setLookupProvider(Supplier) instead
void	setClearButtonCaption(java.lang.String caption) Sets "Clear" button caption.
void	setClearButtonIcon(java.lang.String icon) Sets "Clear" button icon.
void	setClearEnabled(boolean clearEnabled) Sets whether clear button is enabled or not
default void	setDatasource(CollectionDatasource datasource) Deprecated. use HasValueSource.setValueSource(ValueSource) instead
void	setFilterMode(LookupField.FilterMode mode) Sets the given mode to manage how options should be filtered.
void	setInline(boolean inline) Sets whether inline tokens mode should be used.
void	setItemChangeHandler(TokenList.ItemChangeHandler handler) Sets selected items change handler.
void	setItemClickListener(TokenList.ItemClickListener itemClickListener) Sets selected tokens click listener.
void	setLookup(boolean lookup) Sets whether inner LookupPickerField component should have lookup action.
void	setLookupFieldOptionsCaptionProvider(java.util.function.Function<? super V,java.lang.String> optionsCaptionProvider) Sets function that provides caption for LookupField options.
void	setLookupInputPrompt(java.lang.String inputPrompt) Sets the input prompt - a textual prompt that is displayed when the LookupPickerField would otherwise be empty, to prompt the user for input.
void	setLookupOpenMode(WindowManager.OpenType lookupOpenMode) Deprecated. use setLookupProvider(Supplier) instead
void	setLookupProvider(java.util.function.Supplier<Screen> lookupProvider) Sets a lookup screen provider that is used when isLookup() enabled.
void	setLookupScreen(java.lang.String lookupScreen) Deprecated. use setLookupProvider(Supplier) instead
void	setLookupScreenParams(java.util.Map<java.lang.String,java.lang.Object> params) Deprecated. use setLookupProvider(Supplier) instead
void	setMultiSelect(boolean multiselect) Enables multiselect mode.
void	setOptions(Options<V> options) Sets field options.
void	setOptionsCaptionMode(CaptionMode optionsCaptionMode) Deprecated. use setLookupFieldOptionsCaptionProvider(Function) instead
void	setOptionsCaptionProperty(java.lang.String optionsCaptionProperty) Deprecated. use setLookupFieldOptionsCaptionProvider(Function) instead
default void	setOptionsDatasource(CollectionDatasource datasource) Deprecated. use setOptions(Options) instead
default void	setOptionsList(java.util.List optionsList)
default void	setOptionsMap(java.util.Map<java.lang.String,?> optionsMap)
void	setPosition(TokenList.Position position) Sets component editor (LookupPickerField / "Add" button) position.
void	setRefreshOptionsOnLookupClose(boolean refresh) Sets whether options should be refreshed after lookup window closing.
void	setSimple(boolean simple) Sets whether simple mode should be used ("Add button" instead of LookupPickerField)
void	setTokenStyleGenerator(java.util.function.Function<java.lang.Object,java.lang.String> tokenStyleGenerator) Deprecated.

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

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

getCaptionMode, getCaptionProperty, setCaptionMode, setCaptionProperty

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

getOptionCaptionProvider, setOptionCaptionProvider

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

setDatasource

@Deprecated
default void setDatasource(CollectionDatasource datasource)

Deprecated. use HasValueSource.setValueSource(ValueSource) instead

Binds the given datasource with field.

Parameters:

datasource - CollectionDatasource instance

getDatasource

@Deprecated
default CollectionDatasource getDatasource()

Deprecated. use HasValueSource.getValueSource() instead

Specified by:

getDatasource in interface DatasourceComponent<java.util.Collection<V extends Entity>>

Returns:

bound CollectionDatasource instance

setOptions

void setOptions(Options<V> options)

Sets field options.

Parameters:

options - field options

getOptions

Options<V> getOptions()

Returns:

field options

setOptionsDatasource

@Deprecated
default void setOptionsDatasource(CollectionDatasource datasource)

Deprecated. use setOptions(Options) instead

Sets the given datasource as options datasource.

Parameters:

datasource - options datasource

getOptionsDatasource

@Deprecated
default CollectionDatasource getOptionsDatasource()

Deprecated. use getOptions() instead

Returns:

CollectionDatasource instance that stores field options

getFilterMode

LookupField.FilterMode getFilterMode()

Returns:

options filter mode

setFilterMode

void setFilterMode(LookupField.FilterMode mode)

Sets the given mode to manage how options should be filtered.

Parameters:

mode - options filter mode

setLookupFieldOptionsCaptionProvider

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

Sets function that provides caption for LookupField options.

Parameters:

optionsCaptionProvider - caption provider for options

getLookupFieldOptionsCaptionProvider

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

Returns:

caption provider for LookupField options

getOptionsCaptionMode

@Deprecated
CaptionMode getOptionsCaptionMode()

Deprecated. use getLookupFieldOptionsCaptionProvider()

Returns:

option captions mode generation

setOptionsCaptionMode

@Deprecated
void setOptionsCaptionMode(CaptionMode optionsCaptionMode)

Deprecated. use setLookupFieldOptionsCaptionProvider(Function) instead

Sets how LookupField option captions should be generated.

Parameters:

optionsCaptionMode - mode

getOptionsCaptionProperty

@Deprecated
java.lang.String getOptionsCaptionProperty()

Deprecated. use getLookupFieldOptionsCaptionProvider() instead

Returns:

a property that is used for LookupField option captions generation

setOptionsCaptionProperty

@Deprecated
void setOptionsCaptionProperty(java.lang.String optionsCaptionProperty)

Deprecated. use setLookupFieldOptionsCaptionProvider(Function) instead

Sets a property that will be used for LookupField option captions generation when CaptionMode.PROPERTY is used.

Parameters:

optionsCaptionProperty - property

setRefreshOptionsOnLookupClose

void setRefreshOptionsOnLookupClose(boolean refresh)

Sets whether options should be refreshed after lookup window closing.

isRefreshOptionsOnLookupClose

boolean isRefreshOptionsOnLookupClose()

Returns:

whether options should be refreshed after lookup window closing

getOptionsList

@Deprecated
default java.util.List getOptionsList()

Deprecated. use getOptions() instead

Returns:

options list

setOptionsList

default void setOptionsList(java.util.List optionsList)

Parameters:

optionsList - options list

getOptionsMap

@Deprecated
default java.util.Map<java.lang.String,?> getOptionsMap()

Deprecated. use getOptions() instead

Returns:

options map

setOptionsMap

default void setOptionsMap(java.util.Map<java.lang.String,?> optionsMap)

Parameters:

optionsMap - options map

isLookup

boolean isLookup()

Returns:

whether inner LookupPickerField component has lookup action

setLookup

void setLookup(boolean lookup)

Sets whether inner LookupPickerField component should have lookup action.

Parameters:

lookup - enable lookup action

setLookupProvider

void setLookupProvider(java.util.function.Supplier<Screen> lookupProvider)

Sets a lookup screen provider that is used when isLookup() enabled.

Provided screen should implement LookupScreen interface.

Parameters:

lookupProvider - lookup screen provider

getLookupProvider

java.util.function.Supplier<Screen> getLookupProvider()

Returns:

lookup screen provider

getLookupScreen

@Deprecated
java.lang.String getLookupScreen()

Deprecated.

Returns:

lookup screen alias

setLookupScreen

@Deprecated
void setLookupScreen(java.lang.String lookupScreen)

Deprecated. use setLookupProvider(Supplier) instead

Sets lookup screen alias.

Parameters:

lookupScreen - screen alias

setLookupScreenParams

@Deprecated
void setLookupScreenParams(java.util.Map<java.lang.String,java.lang.Object> params)

Deprecated. use setLookupProvider(Supplier) instead

Sets params that will be passed to lookup screen.

Parameters:

params - params

getLookupScreenParams

@Nullable
 @Deprecated
java.util.Map<java.lang.String,java.lang.Object> getLookupScreenParams()

Deprecated.

Returns:

params that will be passed to lookup screen

getLookupOpenMode

@Deprecated
WindowManager.OpenType getLookupOpenMode()

Deprecated.

Returns:

lookup screen open mode

setLookupOpenMode

@Deprecated
void setLookupOpenMode(WindowManager.OpenType lookupOpenMode)

Deprecated. use setLookupProvider(Supplier) instead

Sets lookup screen open mode.

WindowManager.OpenType.THIS_TAB is the default.

Parameters:

lookupOpenMode - open mode

isClearEnabled

boolean isClearEnabled()

Returns:

clear button is enabled

setClearEnabled

void setClearEnabled(boolean clearEnabled)

Sets whether clear button is enabled or not

Parameters:

clearEnabled - clear button enabled

isMultiSelect

boolean isMultiSelect()

Returns:

whether multiselect mode is enabled

setMultiSelect

void setMultiSelect(boolean multiselect)

Enables multiselect mode. It leads to the passing WindowParams.MULTI_SELECT param to the lookup screen.

Parameters:

multiselect - multiselect

isSimple

boolean isSimple()

Returns:

whether simple mode is used ("Add button" instead of LookupPickerField)

setSimple

void setSimple(boolean simple)

Sets whether simple mode should be used ("Add button" instead of LookupPickerField)

Parameters:

simple - simple

getPosition

TokenList.Position getPosition()

Returns:

component editor (LookupPickerField / "Add" button) position

setPosition

void setPosition(TokenList.Position position)

Sets component editor (LookupPickerField / "Add" button) position.

TokenList.Position.TOP is the default.

Parameters:

position - editor position

isInline

boolean isInline()

Returns:

whether inline tokens mode should be used

setInline

void setInline(boolean inline)

Sets whether inline tokens mode should be used.

Parameters:

inline - inline mode

getAddButtonCaption

java.lang.String getAddButtonCaption()

Returns:

"Add" button caption

setAddButtonCaption

void setAddButtonCaption(java.lang.String caption)

Sets "Add" button caption.

Parameters:

caption - caption

getAddButtonIcon

java.lang.String getAddButtonIcon()

Returns:

"Add" button icon

setAddButtonIcon

void setAddButtonIcon(java.lang.String icon)

Sets "Add" button icon.

Parameters:

icon - icon

getClearButtonCaption

java.lang.String getClearButtonCaption()

Returns:

"Clear" button caption

setClearButtonCaption

void setClearButtonCaption(java.lang.String caption)

Sets "Clear" button caption.

Parameters:

caption - caption

getClearButtonIcon

java.lang.String getClearButtonIcon()

Returns:

"Clear" button icon

setClearButtonIcon

void setClearButtonIcon(java.lang.String icon)

Sets "Clear" button icon.

Parameters:

icon - icon

getItemChangeHandler

TokenList.ItemChangeHandler getItemChangeHandler()

Returns:

selected items change handler

setItemChangeHandler

void setItemChangeHandler(TokenList.ItemChangeHandler handler)

Sets selected items change handler.

Parameters:

handler - items change handler

getItemClickListener

TokenList.ItemClickListener getItemClickListener()

Returns:

selected tokens click listener

setItemClickListener

void setItemClickListener(TokenList.ItemClickListener itemClickListener)

Sets selected tokens click listener.

Parameters:

itemClickListener - items click listener

getAfterLookupCloseHandler

@Deprecated
TokenList.AfterLookupCloseHandler getAfterLookupCloseHandler()

Deprecated. use setLookupProvider(Supplier) instead

Returns:

handler that is invoked after lookup screen closing

setAfterLookupCloseHandler

@Deprecated
void setAfterLookupCloseHandler(TokenList.AfterLookupCloseHandler handler)

Deprecated. use setLookupProvider(Supplier) instead

Sets handler that is invoked after lookup screen closing.

Parameters:

handler - handler

getAfterLookupSelectionHandler

@Deprecated
TokenList.AfterLookupSelectionHandler getAfterLookupSelectionHandler()

Deprecated. use setLookupProvider(Supplier) instead

Returns:

handler that is invoked when an item is selected in lookup screen

setAfterLookupSelectionHandler

@Deprecated
void setAfterLookupSelectionHandler(TokenList.AfterLookupSelectionHandler handler)

Deprecated. use setLookupProvider(Supplier) instead

Sets handler that is invoked when an item is selected in lookup screen.

Parameters:

handler - handler

setTokenStyleGenerator

@Deprecated
void setTokenStyleGenerator(java.util.function.Function<java.lang.Object,java.lang.String> tokenStyleGenerator)

Deprecated.

getTokenStyleGenerator

@Deprecated
java.util.function.Function<java.lang.Object,java.lang.String> getTokenStyleGenerator()

Deprecated.

getLookupInputPrompt

java.lang.String getLookupInputPrompt()

Returns:

input prompt of LookupPickerField

setLookupInputPrompt

void setLookupInputPrompt(java.lang.String inputPrompt)

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

Parameters:

inputPrompt - input prompt