public interface TokenList<V extends Entity> extends Field<java.util.Collection<V>>, Component.BelongToFrame, Component.HasCaption, Component.Editable, Component.Focusable, HasCaptionMode, HasOptionCaptionProvider<V>
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.
|
Field.Validator<T>
HasValue.ValueChangeEvent<V>
Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.OptionsStyleProvider, Component.Wrapper
HasContextHelp.ContextHelpIconClickEvent
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
NAME |
AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE, UNITS_PERCENTAGE, UNITS_PIXELS
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.
|
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 |
setNewOptionHandler(java.util.function.Consumer<java.lang.String> newOptionHandler)
Sets the handler that is called when user types a new item.
|
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.
|
addValidator, addValidators, getRequiredMessage, getValidators, isRequired, removeValidator, setRequired, setRequiredMessage
getMetaProperty, getMetaPropertyPath, setDatasource
addValueChangeListener, clear, getEmptyValue, getValue, isEmpty, removeValueChangeListener, setValue
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
getValueSource, setValueSource
isEditable, isEditableWithParent, setEditable
getFrame, setFrame
isValid, isValidateOnCommit, validate
getIcon, setIcon, setIconFromSet
getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled
isCaptionAsHtml, setCaptionAsHtml
getCaption, setCaption
getDescription, setDescription
isDescriptionAsHtml, setDescriptionAsHtml
isHtmlSanitizerEnabled, setHtmlSanitizerEnabled
focus, getTabIndex, isFocusable, setFocusable, setTabIndex
getCaptionMode, getCaptionProperty, setCaptionMode, setCaptionProperty
getOptionCaptionProvider, setOptionCaptionProvider
static final java.lang.String NAME
@Deprecated default void setDatasource(CollectionDatasource datasource)
HasValueSource.setValueSource(ValueSource)
insteaddatasource
with field.datasource
- CollectionDatasource
instance@Deprecated default CollectionDatasource getDatasource()
HasValueSource.getValueSource()
insteadgetDatasource
in interface DatasourceComponent<java.util.Collection<V extends Entity>>
CollectionDatasource
instancevoid setOptions(@Nullable Options<V> options)
options
- field options@Deprecated default void setOptionsDatasource(@Nullable CollectionDatasource datasource)
setOptions(Options)
insteaddatasource
as options datasource.datasource
- options datasource@Deprecated @Nullable default CollectionDatasource getOptionsDatasource()
getOptions()
insteadCollectionDatasource
instance that stores field optionsLookupField.FilterMode getFilterMode()
void setFilterMode(LookupField.FilterMode mode)
mode
to manage how options should be filtered.mode
- options filter modevoid setLookupFieldOptionsCaptionProvider(java.util.function.Function<? super V,java.lang.String> optionsCaptionProvider)
optionsCaptionProvider
- caption provider for optionsjava.util.function.Function<? super V,java.lang.String> getLookupFieldOptionsCaptionProvider()
@Deprecated CaptionMode getOptionsCaptionMode()
getLookupFieldOptionsCaptionProvider()
@Deprecated void setOptionsCaptionMode(CaptionMode optionsCaptionMode)
setLookupFieldOptionsCaptionProvider(Function)
insteadoptionsCaptionMode
- mode@Deprecated java.lang.String getOptionsCaptionProperty()
getLookupFieldOptionsCaptionProvider()
instead@Deprecated void setOptionsCaptionProperty(java.lang.String optionsCaptionProperty)
setLookupFieldOptionsCaptionProvider(Function)
insteadCaptionMode.PROPERTY
is used.optionsCaptionProperty
- propertyvoid setRefreshOptionsOnLookupClose(boolean refresh)
boolean isRefreshOptionsOnLookupClose()
@Deprecated @Nullable default java.util.List getOptionsList()
getOptions()
insteaddefault void setOptionsList(java.util.List optionsList)
optionsList
- options list@Deprecated @Nullable default java.util.Map<java.lang.String,?> getOptionsMap()
getOptions()
insteaddefault void setOptionsMap(java.util.Map<java.lang.String,?> optionsMap)
optionsMap
- options mapboolean isLookup()
void setLookup(boolean lookup)
lookup
- enable lookup actionvoid setLookupProvider(java.util.function.Supplier<Screen> lookupProvider)
isLookup()
enabled.
Provided screen should implement LookupScreen
interface.
lookupProvider
- lookup screen providerjava.util.function.Supplier<Screen> getLookupProvider()
@Deprecated java.lang.String getLookupScreen()
@Deprecated void setLookupScreen(java.lang.String lookupScreen)
setLookupProvider(Supplier)
insteadlookupScreen
- screen alias@Deprecated void setLookupScreenParams(java.util.Map<java.lang.String,java.lang.Object> params)
setLookupProvider(Supplier)
insteadparams
- params@Nullable @Deprecated java.util.Map<java.lang.String,java.lang.Object> getLookupScreenParams()
@Deprecated WindowManager.OpenType getLookupOpenMode()
@Deprecated void setLookupOpenMode(WindowManager.OpenType lookupOpenMode)
setLookupProvider(Supplier)
instead
WindowManager.OpenType.THIS_TAB
is the default.
lookupOpenMode
- open modeboolean isClearEnabled()
void setClearEnabled(boolean clearEnabled)
clearEnabled
- clear button enabledboolean isMultiSelect()
void setMultiSelect(boolean multiselect)
WindowParams.MULTI_SELECT
param
to the lookup screen.multiselect
- multiselectboolean isSimple()
void setSimple(boolean simple)
simple
- simpleTokenList.Position getPosition()
void setPosition(TokenList.Position position)
TokenList.Position.TOP
is the default.
position
- editor positionboolean isInline()
void setInline(boolean inline)
inline
- inline modejava.lang.String getAddButtonCaption()
void setAddButtonCaption(java.lang.String caption)
caption
- captionjava.lang.String getAddButtonIcon()
void setAddButtonIcon(java.lang.String icon)
icon
- iconjava.lang.String getClearButtonCaption()
void setClearButtonCaption(java.lang.String caption)
caption
- captionjava.lang.String getClearButtonIcon()
void setClearButtonIcon(java.lang.String icon)
icon
- iconTokenList.ItemChangeHandler getItemChangeHandler()
void setItemChangeHandler(TokenList.ItemChangeHandler handler)
handler
- items change handlerTokenList.ItemClickListener getItemClickListener()
void setItemClickListener(TokenList.ItemClickListener itemClickListener)
itemClickListener
- items click listener@Deprecated TokenList.AfterLookupCloseHandler getAfterLookupCloseHandler()
setLookupProvider(Supplier)
instead@Deprecated void setAfterLookupCloseHandler(TokenList.AfterLookupCloseHandler handler)
setLookupProvider(Supplier)
insteadhandler
- handler@Deprecated TokenList.AfterLookupSelectionHandler getAfterLookupSelectionHandler()
setLookupProvider(Supplier)
instead@Deprecated void setAfterLookupSelectionHandler(TokenList.AfterLookupSelectionHandler handler)
setLookupProvider(Supplier)
insteadhandler
- handler@Deprecated void setTokenStyleGenerator(java.util.function.Function<java.lang.Object,java.lang.String> tokenStyleGenerator)
@Deprecated java.util.function.Function<java.lang.Object,java.lang.String> getTokenStyleGenerator()
java.lang.String getLookupInputPrompt()
void setLookupInputPrompt(java.lang.String inputPrompt)
inputPrompt
- input promptvoid setNewOptionHandler(java.util.function.Consumer<java.lang.String> newOptionHandler)
newOptionHandler
- a handler to set, null
to remove.