Package com.storedobject.vaadin

Class TokensField<T>

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.AbstractField<com.vaadin.flow.component.combobox.MultiSelectComboBox<T>,Set<T>>

com.vaadin.flow.component.AbstractSinglePropertyField<com.vaadin.flow.component.combobox.MultiSelectComboBox<T>,Set<T>>

com.vaadin.flow.component.combobox.ComboBoxBase<com.vaadin.flow.component.combobox.MultiSelectComboBox<T>,T,Set<T>>

com.vaadin.flow.component.combobox.MultiSelectComboBox<T>

com.storedobject.vaadin.TokensField<T>

Type Parameters:

T - The type of items in the selection.

All Implemented Interfaces:

RequiredField, com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.BlurNotifier<com.vaadin.flow.component.combobox.MultiSelectComboBox<T>>, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.Focusable<com.vaadin.flow.component.combobox.MultiSelectComboBox<T>>, com.vaadin.flow.component.FocusNotifier<com.vaadin.flow.component.combobox.MultiSelectComboBox<T>>, com.vaadin.flow.component.HasAriaLabel, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasHelper, com.vaadin.flow.component.HasLabel, com.vaadin.flow.component.HasPlaceholder, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasTheme, com.vaadin.flow.component.HasValidation, com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.combobox.MultiSelectComboBox<T>,Set<T>>,Set<T>>, com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.combobox.MultiSelectComboBox<T>,Set<T>>,Set<T>>, com.vaadin.flow.component.shared.HasAllowedCharPattern, com.vaadin.flow.component.shared.HasAutoOpen, com.vaadin.flow.component.shared.HasClearButton, com.vaadin.flow.component.shared.HasClientValidation, com.vaadin.flow.component.shared.HasOverlayClassName, com.vaadin.flow.component.shared.HasThemeVariant<com.vaadin.flow.component.combobox.MultiSelectComboBoxVariant>, com.vaadin.flow.component.shared.HasTooltip, com.vaadin.flow.component.shared.HasValidationProperties, com.vaadin.flow.component.shared.InputField<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.combobox.MultiSelectComboBox<T>,Set<T>>,Set<T>>, com.vaadin.flow.data.binder.HasValidator<Set<T>>, com.vaadin.flow.data.provider.HasDataView<T,String,com.vaadin.flow.component.combobox.dataview.ComboBoxDataView<T>>, com.vaadin.flow.data.provider.HasLazyDataView<T,String,com.vaadin.flow.component.combobox.dataview.ComboBoxLazyDataView<T>>, com.vaadin.flow.data.provider.HasListDataView<T,com.vaadin.flow.component.combobox.dataview.ComboBoxListDataView<T>>, com.vaadin.flow.data.selection.MultiSelect<com.vaadin.flow.component.combobox.MultiSelectComboBox<T>,T>, Serializable

public class TokensField<T>
extends com.vaadin.flow.component.combobox.MultiSelectComboBox<T>
implements RequiredField

A custom field extending MultiSelectComboBox to support token-based multi-selection of items. This class provides various utility methods to manipulate and manage the selected values and items available for selection. It also implements the RequiredField interface to allow marking the field as required.

Author:

Syam

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.flow.component.combobox.MultiSelectComboBox

com.vaadin.flow.component.combobox.MultiSelectComboBox.AutoExpandMode

Nested classes/interfaces inherited from class com.vaadin.flow.component.combobox.ComboBoxBase

com.vaadin.flow.component.combobox.ComboBoxBase.CustomValueSetEvent<TComponent extends com.vaadin.flow.component.combobox.ComboBoxBase<TComponent,?,?>>, com.vaadin.flow.component.combobox.ComboBoxBase.SpringData

Nested classes/interfaces inherited from class com.vaadin.flow.component.AbstractField

com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<C extends com.vaadin.flow.component.Component,V>

Nested classes/interfaces inherited from interface com.vaadin.flow.component.BlurNotifier

com.vaadin.flow.component.BlurNotifier.BlurEvent<C extends com.vaadin.flow.component.Component>

Nested classes/interfaces inherited from interface com.vaadin.flow.component.FocusNotifier

com.vaadin.flow.component.FocusNotifier.FocusEvent<C extends com.vaadin.flow.component.Component>

Nested classes/interfaces inherited from interface com.vaadin.flow.component.shared.HasClientValidation

com.vaadin.flow.component.shared.HasClientValidation.ClientValidatedEvent

Nested classes/interfaces inherited from interface com.vaadin.flow.component.HasValue

com.vaadin.flow.component.HasValue.ValueChangeEvent<V>, com.vaadin.flow.component.HasValue.ValueChangeListener<E extends com.vaadin.flow.component.HasValue.ValueChangeEvent<?>>

Constructor Summary

Constructors

Constructor	Description
TokensField()	Constructor.
TokensField(com.vaadin.flow.component.ItemLabelGenerator<T> itemLabelGenerator)	Constructor.
TokensField(String label)	Constructor.
TokensField(String label, com.vaadin.flow.component.ItemLabelGenerator<T> itemLabelGenerator)	Constructor.
TokensField(String label, Collection<T> items)	Constructor.
TokensField(String label, Collection<T> items, com.vaadin.flow.component.ItemLabelGenerator<T> itemLabelGenerator)	Constructor.
TokensField(Collection<T> items)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addItems(Collection<T> items)	Add more items to the selection list.
void	addItems(Stream<T> streamOfItems)	Add more items to the selection list.
final void	addItems(T... items)	Add more items to the selection list.
void	addValue(Set<T> value)	Add tokens to the existing set.
void	deselectAll()	Deselect all items.
void	selectAll()	Select all items.
void	setValue(Collection<T> value)	Sets the value by converting the provided collection into a set and passing it to the setValue method of the parent class.
void	setValue(Set<T> value)
protected boolean	valueEquals(Set<T> value1, Set<T> value2)

Methods inherited from class com.vaadin.flow.component.combobox.MultiSelectComboBox

addSelectionListener, getAutoExpand, getI18n, getSelectedItems, getValue, isKeepFilter, isRequiredIndicatorVisible, isSelected, isSelectedItemsOnTop, onAttach, refreshValue, setAutoExpand, setI18n, setKeepFilter, setOverlayWidth, setOverlayWidth, setRequiredIndicatorVisible, setSelectedItemsOnTop, setValue, updateSelection

Methods inherited from class com.vaadin.flow.component.combobox.ComboBoxBase

addCustomValueSetListener, generateClassName, generateLabel, getAriaLabel, getAriaLabelledBy, getDataCommunicator, getDataController, getDataGenerator, getDataProvider, getDefaultValidator, getFilter, getGenericDataView, getItemClassNameGenerator, getItemLabelGenerator, getKeyMapper, getLazyDataView, getListDataView, getPageSize, getRenderManager, isAllowCustomValue, isAutofocus, isOpened, isRequired, onDetach, runBeforeClientResponse, setAllowCustomValue, setAriaLabel, setAriaLabelledBy, setAutofocus, setClassNameGenerator, setDataProvider, setDataProvider, setFilter, setI18n, setItemLabelGenerator, setItems, setItems, setItems, setItems, setItems, setItems, setItems, setItems, setItems, setItems, setItems, setItemsPageable, setItemsPageable, setItemsWithFilterConverter, setItemsWithFilterConverter, setManualValidation, setOpened, setPageSize, setRenderer, setRequired, validate

Methods inherited from class com.vaadin.flow.component.AbstractSinglePropertyField

getSynchronizationRegistration, hasValidValue, setPresentationValue, setSynchronizedEvent

Methods inherited from class com.vaadin.flow.component.AbstractField

addValueChangeListener, getEmptyValue, isEmpty, setModelValue

Methods inherited from class com.vaadin.flow.component.Component

addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisible

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

addAttachListener

Methods inherited from interface com.vaadin.flow.component.BlurNotifier

addBlurListener

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

addDetachListener

Methods inherited from interface com.vaadin.flow.component.Focusable

addFocusShortcut, blur, focus, getTabIndex, setTabIndex

Methods inherited from interface com.vaadin.flow.component.FocusNotifier

addFocusListener

Methods inherited from interface com.vaadin.flow.component.shared.HasAllowedCharPattern

getAllowedCharPattern, setAllowedCharPattern

Methods inherited from interface com.vaadin.flow.component.shared.HasAutoOpen

isAutoOpen, setAutoOpen

Methods inherited from interface com.vaadin.flow.component.shared.HasClearButton

isClearButtonVisible, setClearButtonVisible

Methods inherited from interface com.vaadin.flow.component.shared.HasClientValidation

addClientValidatedEventListener

Methods inherited from interface com.vaadin.flow.component.HasElement

getElement

Methods inherited from interface com.vaadin.flow.component.HasEnabled

isEnabled, setEnabled

Methods inherited from interface com.vaadin.flow.component.HasHelper

getHelperComponent, getHelperText, setHelperComponent, setHelperText

Methods inherited from interface com.vaadin.flow.component.HasLabel

getLabel, setLabel

Methods inherited from interface com.vaadin.flow.data.provider.HasListDataView

setItems

Methods inherited from interface com.vaadin.flow.component.shared.HasOverlayClassName

getOverlayClassName, setOverlayClassName

Methods inherited from interface com.vaadin.flow.component.HasPlaceholder

getPlaceholder, setPlaceholder

Methods inherited from interface com.vaadin.flow.component.HasSize

getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull

Methods inherited from interface com.vaadin.flow.component.HasStyle

addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

Methods inherited from interface com.vaadin.flow.component.HasTheme

addThemeName, addThemeNames, getThemeName, getThemeNames, hasThemeName, removeThemeName, removeThemeNames, setThemeName, setThemeName

Methods inherited from interface com.vaadin.flow.component.shared.HasThemeVariant

addThemeVariants, removeThemeVariants

Methods inherited from interface com.vaadin.flow.component.shared.HasTooltip

getTooltip, setTooltipText

Methods inherited from interface com.vaadin.flow.component.shared.HasValidationProperties

getErrorMessage, isInvalid, setErrorMessage, setInvalid

Methods inherited from interface com.vaadin.flow.data.binder.HasValidator

addValidationStatusChangeListener

Methods inherited from interface com.vaadin.flow.component.HasValue

addValueChangeListener, clear, getOptionalValue, isEmpty

Methods inherited from interface com.vaadin.flow.component.HasValueAndElement

isReadOnly, setReadOnly

Methods inherited from interface com.vaadin.flow.data.selection.MultiSelect

deselect, deselect, getEmptyValue, select, select

Methods inherited from interface com.storedobject.vaadin.RequiredField

setRequired

Constructor Details

TokensField

public TokensField()

Constructor.

TokensField

public TokensField(String label)

Constructor.

Parameters:

label - Label

TokensField

public TokensField(Collection<T> items)

Constructor.

Parameters:

items - Items

TokensField

public TokensField(String label,
 Collection<T> items)

Constructor.

Parameters:

label - Label

items - Items

TokensField

public TokensField(com.vaadin.flow.component.ItemLabelGenerator<T> itemLabelGenerator)

Constructor.

Parameters:

itemLabelGenerator - Label generator

TokensField

public TokensField(String label,
 com.vaadin.flow.component.ItemLabelGenerator<T> itemLabelGenerator)

Constructor.

Parameters:

label - Label

itemLabelGenerator - Label generator

TokensField

public TokensField(String label,
 Collection<T> items,
 com.vaadin.flow.component.ItemLabelGenerator<T> itemLabelGenerator)

Constructor.

Parameters:

label - Label

items - Items

itemLabelGenerator - Label generator

Method Details

valueEquals

protected boolean valueEquals(Set<T> value1,
 Set<T> value2)

Overrides:

valueEquals in class com.vaadin.flow.component.AbstractField<com.vaadin.flow.component.combobox.MultiSelectComboBox<T>,Set<T>>

addValue

public void addValue(Set<T> value)

Add tokens to the existing set.

Parameters:

value - Tokens to be added

addItems

public void addItems(Collection<T> items)

Add more items to the selection list.

Parameters:

items - Items to be added

addItems

@SafeVarargs
public final void addItems(T... items)

Add more items to the selection list.

Parameters:

items - Items to be added

addItems

public void addItems(Stream<T> streamOfItems)

Add more items to the selection list.

Parameters:

streamOfItems - Items to be added

setValue

public void setValue(Set<T> value)

Specified by:

setValue in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.combobox.MultiSelectComboBox<T>,Set<T>>,Set<T>>

Specified by:

setValue in interface com.vaadin.flow.data.selection.MultiSelect<com.vaadin.flow.component.combobox.MultiSelectComboBox<T>,T>

Overrides:

setValue in class com.vaadin.flow.component.combobox.MultiSelectComboBox<T>

setValue

public void setValue(Collection<T> value)

Sets the value by converting the provided collection into a set and passing it to the setValue method of the parent class.

Overrides:

setValue in class com.vaadin.flow.component.combobox.MultiSelectComboBox<T>

Parameters:

value - The collection of elements to set as the value.

selectAll

public void selectAll()

Select all items. The MultiSelectComboBox.getValue() will return all the items after invoking this method.

deselectAll

public void deselectAll()

Deselect all items. This is equivalent to setValue(null). The MultiSelectComboBox.getValue() will return an empty set after invoking this method.

Specified by:

deselectAll in interface com.vaadin.flow.data.selection.MultiSelect<com.vaadin.flow.component.combobox.MultiSelectComboBox<T>,T>