com.vaadin.flow.component.listbox

Class ListBox<T>

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.AbstractField<C,T>

com.vaadin.flow.component.AbstractSinglePropertyField<C,VALUE>

com.vaadin.flow.component.listbox.ListBoxBase<ListBox<T>,T,T>

com.vaadin.flow.component.listbox.ListBox<T>

Type Parameters:

T - the type of the items contained by this component

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasComponents, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<ListBox<T>,T>,T>, com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<ListBox<T>,T>,T>, com.vaadin.flow.data.binder.HasItemComponents<T>, com.vaadin.flow.data.provider.HasDataView<T,Void,ListBoxDataView<T>>, com.vaadin.flow.data.provider.HasListDataView<T,ListBoxListDataView<T>>, com.vaadin.flow.data.selection.SingleSelect<ListBox<T>,T>, Serializable

public class ListBox<T>
extends ListBoxBase<ListBox<T>,T,T>
implements com.vaadin.flow.data.selection.SingleSelect<ListBox<T>,T>

Server-side component for the vaadin-list-box element.

Author:

Vaadin Ltd

See Also:

MultiSelectListBox, Serialized Form

Nested Class Summary

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

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

Nested classes/interfaces inherited from interface com.vaadin.flow.data.binder.HasItemComponents

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

Constructor Summary

Constructors

Constructor and Description
ListBox() Creates a new list box component.

Method Summary

Modifier and Type	Method and Description
protected boolean	valueEquals(T value1, T value2) Compares two value instances to each other to determine whether they are equal.

Methods inherited from class com.vaadin.flow.component.listbox.ListBoxBase

getDataProvider, getGenericDataView, getItemEnabledProvider, getItemId, getItemRenderer, getListDataView, onAttach, onDetach, onEnabledStateChanged, setDataProvider, setItemEnabledProvider, setItems, setItems, setItems, setItems, setRenderer, setRequiredIndicatorVisible

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

getSynchronizationRegistration, hasValidValue, 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, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getLocale, getParent, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, 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.HasValueAndElement

isReadOnly, isRequiredIndicatorVisible, setReadOnly, setRequiredIndicatorVisible

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

addValueChangeListener, clear, getEmptyValue, getOptionalValue, getValue, isEmpty, setValue

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

isEnabled, setEnabled

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

getElement

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

addComponents, getItemPosition, prependComponents

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

add, add, addComponentAsFirst, addComponentAtIndex, remove, removeAll

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

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

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

setItems, setItems

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

addAttachListener

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

addDetachListener

Constructor Detail

ListBox

public ListBox()

Creates a new list box component.

Method Detail

valueEquals

protected boolean valueEquals(T value1,
                              T value2)

Compares two value instances to each other to determine whether they are equal. Equality is used to determine whether to update internal state and fire an event when AbstractField.setValue(Object) or AbstractField.setModelValue(Object, boolean) is called. Subclasses can override this method to define an alternative comparison method instead of Object.equals(Object).

Overrides:

valueEquals in class com.vaadin.flow.component.AbstractField<ListBox<T>,T>

Parameters:

value1 - the first instance

value2 - the second instance

Returns:

true if the instances are equal; otherwise false