Package com.storedobject.vaadin

Class ListField<T>

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.AbstractField<com.vaadin.flow.component.select.Select<T>,T>

com.vaadin.flow.component.AbstractSinglePropertyField<com.vaadin.flow.component.select.Select<T>,T>

com.vaadin.flow.component.select.Select<T>

com.storedobject.vaadin.ListField<T>

Type Parameters:

T - Value type of the field

All Implemented Interfaces:

SpellCheck, ValueRequired, com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.BlurNotifier<com.vaadin.flow.component.select.Select<T>>, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.Focusable<com.vaadin.flow.component.select.Select<T>>, com.vaadin.flow.component.FocusNotifier<com.vaadin.flow.component.select.Select<T>>, com.vaadin.flow.component.HasAriaLabel, com.vaadin.flow.component.HasComponents, 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.select.Select<T>,T>,T>, com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.select.Select<T>,T>,T>, com.vaadin.flow.component.shared.HasClientValidation, com.vaadin.flow.component.shared.HasOverlayClassName, com.vaadin.flow.component.shared.HasPrefix, com.vaadin.flow.component.shared.HasThemeVariant<com.vaadin.flow.component.select.SelectVariant>, 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.select.Select<T>,T>,T>, com.vaadin.flow.data.binder.HasItemComponents<T>, com.vaadin.flow.data.binder.HasValidator<T>, com.vaadin.flow.data.provider.HasDataView<T,Void,com.vaadin.flow.component.select.data.SelectDataView<T>>, com.vaadin.flow.data.provider.HasListDataView<T,com.vaadin.flow.component.select.data.SelectListDataView<T>>, com.vaadin.flow.data.selection.SingleSelect<com.vaadin.flow.component.select.Select<T>,T>, Serializable

Direct Known Subclasses:

ObjectListField

public class ListField<T>
extends com.vaadin.flow.component.select.Select<T>
implements SpellCheck, ValueRequired

Slightly enhanced version of Vaadin's Select.

Author:

Syam

See Also:

• Serialized Form

Nested Class Summary

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

com.vaadin.flow.component.select.Select.InvalidChangeEvent, com.vaadin.flow.component.select.Select.OpenedChangeEvent, com.vaadin.flow.component.select.Select.SelectI18n

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.data.binder.HasItemComponents

com.vaadin.flow.data.binder.HasItemComponents.ItemComponent<T>

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<?>>

Field Summary

Fields inherited from class com.vaadin.flow.component.select.Select

LABEL_ATTRIBUTE

Constructor Summary

Constructors

Constructor	Description
ListField(String label, Collection<T> items)	Constructor.
ListField(Collection<T> items)	Constructor.

Method Summary

Modifier and Type	Method	Description
com.vaadin.flow.component.select.data.SelectListDataView<T>	addItems(Collection<T> items)	Adds a collection of items to the view.
com.vaadin.flow.component.select.data.SelectListDataView<T>	addItems(Stream<T> items)	Adds a stream of non-null items to the data view.
final com.vaadin.flow.component.select.data.SelectListDataView<T>	addItems(T... items)	Adds the specified items to the view if they are not null.
int	getIndex(T value)	Get index of an item.
T	getValue(int index)	Get the item for the index passed.
boolean	isRequired()	Get the value required flag.
com.vaadin.flow.component.select.data.SelectListDataView<T>	removeItems(Collection<T> items)	Removes the specified items from the current view.
com.vaadin.flow.component.select.data.SelectListDataView<T>	removeItems(Stream<T> items)	Removes the specified items from the list and updates the view accordingly.
final com.vaadin.flow.component.select.data.SelectListDataView<T>	removeItems(T... items)	Removes the specified items from the list and updates the data view.
void	setIndex(int index)	Set value via index.
void	setItem(int index, T item)	Replace an item at a specified index.
com.vaadin.flow.component.select.data.SelectListDataView<T>	setItems(Iterable<T> items)	Set item list.
com.vaadin.flow.component.select.data.SelectListDataView<T>	setItems(Collection<T> items)	Set item list.
final com.vaadin.flow.component.select.data.SelectListDataView<T>	setItems(T... items)	Set item list.
void	setRequired(boolean required)	Set value required flag.

Methods inherited from class com.vaadin.flow.component.select.Select

add, addComponentAsFirst, addComponentAtIndex, addComponents, addInvalidChangeListener, addOpenedChangeListener, getAriaLabel, getAriaLabelledBy, getChildren, getDataProvider, getDefaultValidator, getEmptySelectionCaption, getGenericDataView, getI18n, getItemEnabledProvider, getItemLabelGenerator, getItemPosition, getItemRenderer, getLabel, getListDataView, hasValidValue, isAutofocus, isEmptySelectionAllowed, isNoVerticalOverlap, isOpened, isRequiredIndicatorVisible, onAttach, onEnabledStateChanged, prependComponents, remove, removeAll, setAriaLabel, setAriaLabelledBy, setAutofocus, setDataProvider, setEmptySelectionAllowed, setEmptySelectionCaption, setI18n, setItemEnabledProvider, setItemLabelGenerator, setItems, setItems, setItems, setLabel, setManualValidation, setNoVerticalOverlap, setOpened, setOverlayWidth, setOverlayWidth, setPlaceholder, setRenderer, setRequiredIndicatorVisible, setTextRenderer, validate, valueEquals

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

getSynchronizationRegistration, setPresentationValue, setSynchronizedEvent

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

addValueChangeListener, getEmptyValue, getValue, isEmpty, setModelValue, setValue

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

addListener, findAncestor, fireEvent, from, get, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onDetach, 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.HasClientValidation

addClientValidatedEventListener

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

add, add, remove

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.shared.HasOverlayClassName

getOverlayClassName, setOverlayClassName

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

getPlaceholder

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

getPrefixComponent, setPrefixComponent

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, getEmptyValue, getOptionalValue, getValue, isEmpty, setValue

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

isReadOnly, setReadOnly

Methods inherited from interface com.storedobject.vaadin.SpellCheck

setSpellCheck

Constructor Details

ListField

public ListField(Collection<T> items)

Constructor.

Parameters:

items - List items

ListField

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

Constructor.

Parameters:

label - Label

items - List items

Method Details

getIndex

public int getIndex(T value)

Get index of an item.

Parameters:

value - Item for which index needs to determined

Returns:

Index of the item.

setIndex

public void setIndex(int index)

Set value via index. If the index is out of range, no value will be set.

Parameters:

index - Index.

getValue

public T getValue(int index)

Get the item for the index passed.

Parameters:

index - Index

Returns:

Item at the index.

setItems

public com.vaadin.flow.component.select.data.SelectListDataView<T> setItems(Collection<T> items)

Set item list.

Specified by:

setItems in interface com.vaadin.flow.data.provider.HasListDataView<T,com.vaadin.flow.component.select.data.SelectListDataView<T>>

Parameters:

items - Item list

Returns:

Data view

setItems

public com.vaadin.flow.component.select.data.SelectListDataView<T> setItems(Iterable<T> items)

Set item list.

Parameters:

items - Item list

Returns:

Data view

setItems

@SafeVarargs
public final com.vaadin.flow.component.select.data.SelectListDataView<T> setItems(T... items)

Set item list.

Specified by:

setItems in interface com.vaadin.flow.data.provider.HasListDataView<T,com.vaadin.flow.component.select.data.SelectListDataView<T>>

Parameters:

items - Item list

Returns:

Data view

setItem

public void setItem(int index,
 T item)

Replace an item at a specified index. (If the index is outside the range, it will not be replaced).

Parameters:

index - Index

item - New item

removeItems

public com.vaadin.flow.component.select.data.SelectListDataView<T> removeItems(Collection<T> items)

Removes the specified items from the current view.

Parameters:

items - The collection of items to be removed from the view.

Returns:

The updated data view after removing the specified items.

removeItems

@SafeVarargs
public final com.vaadin.flow.component.select.data.SelectListDataView<T> removeItems(T... items)

Removes the specified items from the list and updates the data view.

Parameters:

items - Items to be removed.

Returns:

The updated data view after removing the items.

removeItems

public com.vaadin.flow.component.select.data.SelectListDataView<T> removeItems(Stream<T> items)

Removes the specified items from the list and updates the view accordingly.

Parameters:

items - Stream of items to be removed from the list.

Returns:

Updated data view after the removal of items.

addItems

public com.vaadin.flow.component.select.data.SelectListDataView<T> addItems(Collection<T> items)

Adds a collection of items to the view.

Parameters:

items - The collection of items to be added.

Returns:

The view representing the updated list of items.

addItems

@SafeVarargs
public final com.vaadin.flow.component.select.data.SelectListDataView<T> addItems(T... items)

Adds the specified items to the view if they are not null.

Parameters:

items - Items to be added to the view. Items that are null will be ignored.

Returns:

The updated data view after adding the items.

addItems

public com.vaadin.flow.component.select.data.SelectListDataView<T> addItems(Stream<T> items)

Adds a stream of non-null items to the data view.

Parameters:

items - A stream of items to be added. Null items in the stream will be filtered out.

Returns:

The updated data view after adding the items.

setRequired

public void setRequired(boolean required)

Description copied from interface: ValueRequired

Set value required flag.

Specified by:

setRequired in interface ValueRequired

Parameters:

required - Required or not

isRequired

public boolean isRequired()

Description copied from interface: ValueRequired

Get the value required flag.

Specified by:

isRequired in interface ValueRequired

Returns:

Whether required or not.