We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.flow.component.combobox.
Class MultiSelectComboBox<TItem>
java.lang.Object
com.vaadin.flow.component.Component
com.vaadin.flow.component.AbstractField<C,T>
com.vaadin.flow.component.AbstractSinglePropertyField<TComponent,TValue>
com.vaadin.flow.component.combobox.ComboBoxBase<MultiSelectComboBox<TItem>,TItem,Set<TItem>>
com.vaadin.flow.component.combobox.MultiSelectComboBox<TItem>
Type Parameters:
TItem - the type of the items to be selectable from the combo box
All Implemented Interfaces:
AttachNotifier, BlurNotifier<MultiSelectComboBox<TItem>>, DetachNotifier, Focusable<MultiSelectComboBox<TItem>>, FocusNotifier<MultiSelectComboBox<TItem>>, HasElement, HasEnabled, HasHelper, HasLabel, HasSize, HasStyle, HasTheme, HasValidation, HasValue<AbstractField.ComponentValueChangeEvent<MultiSelectComboBox<TItem>,, HasValueAndElement<AbstractField.ComponentValueChangeEvent<MultiSelectComboBox<TItem>,, HasAllowedCharPattern, HasAutoOpen, HasClearButton, HasClientValidation, HasOverlayClassName, HasThemeVariant<MultiSelectComboBoxVariant>, HasTooltip, HasValidationProperties, HasValidator<Set<TItem>>, HasDataView<TItem,, HasLazyDataView<TItem,, HasListDataView<TItem,, MultiSelect<MultiSelectComboBox<TItem>,, Serializable
@Tag("vaadin-multi-select-combo-box")
@NpmPackage(value="@vaadin/polymer-legacy-adapter",version="24.0.2") @NpmPackage(value="@vaadin/multi-select-combo-box",version="24.0.2")
@JsModule("@vaadin/polymer-legacy-adapter/style-modules.js") @JsModule("@vaadin/multi-select-combo-box/src/vaadin-multi-select-combo-box.js") @JsModule("./flow-component-renderer.js") @JsModule("./comboBoxConnector.js")
public class MultiSelectComboBox<TItem>
extends ComboBoxBase<MultiSelectComboBox<TItem>,TItem,Set<TItem>>
implements MultiSelect<MultiSelectComboBox<TItem>,TItem>, HasThemeVariant<MultiSelectComboBoxVariant>
MultiSelectComboBox allows the user to select one or more values from a
filterable list of options presented in an overlay. Compared to
ComboBox, MultiSelectComboBox allows to select multiple values.
MultiSelectComboBox supports lazy loading. This means that when using large
data sets, items are requested from the server one "page" at a time when the
user scrolls down the overlay. The number of items in one page is by default
50, and can be changed with ComboBoxBase.setPageSize(int).
MultiSelectComboBox can do filtering either in the browser or in the server.
When MultiSelectComboBox has only a relatively small set of items, the
filtering will happen in the browser, allowing smooth user-experience. When
the size of the data set is larger than the pageSize, the
webcomponent doesn't necessarily have all the data available, and it will
make requests to the server to handle the filtering. Also, if you have
defined custom filtering logic, with eg.
ComboBoxBase.setItems(ComboBox.ItemFilter, Collection), filtering will happen in
the server. To enable client-side filtering with larger data sets, you can
override the pageSize to be bigger than the size of your data set.
However, then the full data set will be sent to the client immediately, and
you will lose the benefits of lazy loading.
Author:
Vaadin Ltd
See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class com.vaadin.flow.component.combobox.ComboBoxBase
ComboBoxBase.CustomValueSetEvent<TComponent extends ComboBoxBase<TComponent,?, ?>> Nested classes/interfaces inherited from class com.vaadin.flow.component.AbstractField
AbstractField.ComponentValueChangeEvent<C extends Component,V> Nested classes/interfaces inherited from interface com.vaadin.flow.component.BlurNotifier
BlurNotifier.BlurEvent<C extends Component>Nested classes/interfaces inherited from interface com.vaadin.flow.component.FocusNotifier
FocusNotifier.FocusEvent<C extends Component>Nested classes/interfaces inherited from interface com.vaadin.flow.component.shared.HasClientValidation
HasClientValidation.ClientValidatedEventNested classes/interfaces inherited from interface com.vaadin.flow.component.HasValue
HasValue.ValueChangeEvent<V>, HasValue.ValueChangeListener<E extends HasValue.ValueChangeEvent<?>> -
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor.
MultiSelectComboBox(int pageSize) Creates an empty combo box with the defined page size for lazy loading.
MultiSelectComboBox(HasValue.ValueChangeListener<AbstractField.ComponentValueChangeEvent<MultiSelectComboBox<TItem>, Set<TItem>>> listener) Constructs a combo box with a value change listener.
MultiSelectComboBox(String label) Creates an empty combo box with the defined label.
MultiSelectComboBox(String label, HasValue.ValueChangeListener<AbstractField.ComponentValueChangeEvent<MultiSelectComboBox<TItem>, Set<TItem>>> listener) Constructs a combo box with the defined label and a value change listener.
MultiSelectComboBox(String label, HasValue.ValueChangeListener<AbstractField.ComponentValueChangeEvent<MultiSelectComboBox<TItem>, Set<TItem>>> listener, TItem... items) Constructs a combo box with the defined label, a value change listener and populated with the items in the array.
MultiSelectComboBox(String label, Collection<TItem> items) Creates a combo box with the defined label and populated with the items in the collection.
MultiSelectComboBox(String label, TItem... items) Creates a combo box with the defined label and populated with the items in the array.
-
Method Summary
Modifier and TypeMethodDescriptionAdds a selection listener that will be called when the selection is changed either by the user or programmatically.
getI18n()Gets the internationalization object previously set for this component.
Returns an immutable set of the currently selected items.
getValue()Gets the value of the component, which is a set of selected items.
booleanisSelected(TItem item) Whether the item is currently selected in the combo box.
protected voidonAttach(AttachEvent attachEvent) Called when the component is attached to a UI.
protected voidRefresh value / selection of the web component after changes that might affect the presentation / rendering of items
voidSets the internationalization properties for this component.
voidsetValue(Collection<TItem> items) Sets the value of the component, which is a set of selected items.
voidSets the value of the component, which is a set of selected items.
final voidSets the value of the component, which is a set of selected items.
voidupdateSelection(Set<TItem> addedItems, Set<TItem> removedItems) Updates the selection by adding and removing the given items from it.
Methods inherited from class com.vaadin.flow.component.combobox.ComboBoxBase
addCustomValueSetListener, addValidationStatusChangeListener, generateLabel, getDataCommunicator, getDataController, getDataGenerator, getDataProvider, getFilter, getGenericDataView, getItemLabelGenerator, getKeyMapper, getLazyDataView, getListDataView, getPageSize, getPlaceholder, getRenderManager, isAllowCustomValue, isAutofocus, isOpened, isRequired, onDetach, runBeforeClientResponse, setAllowCustomValue, setAutofocus, setFilter, setItemLabelGenerator, setItems, setItems, setItems, setItems, setItems, setItems, setItems, setItems, setItems, setItems, setItems, setItemsWithFilterConverter, setItemsWithFilterConverter, setOpened, setPageSize, setPlaceholder, setRenderer, setRequired, validateMethods inherited from class com.vaadin.flow.component.AbstractSinglePropertyField
getSynchronizationRegistration, hasValidValue, setPresentationValue, setSynchronizedEventMethods inherited from class com.vaadin.flow.component.AbstractField
addValueChangeListener, getEmptyValue, isEmpty, setModelValue, valueEqualsMethods 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, setVisibleMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.vaadin.flow.component.AttachNotifier
addAttachListenerMethods inherited from interface com.vaadin.flow.component.BlurNotifier
addBlurListenerMethods inherited from interface com.vaadin.flow.component.DetachNotifier
addDetachListenerMethods inherited from interface com.vaadin.flow.component.Focusable
addFocusShortcut, blur, focus, getTabIndex, setTabIndexMethods inherited from interface com.vaadin.flow.component.FocusNotifier
addFocusListenerMethods inherited from interface com.vaadin.flow.component.shared.HasAllowedCharPattern
getAllowedCharPattern, setAllowedCharPatternMethods inherited from interface com.vaadin.flow.component.shared.HasAutoOpen
isAutoOpen, setAutoOpenMethods inherited from interface com.vaadin.flow.component.shared.HasClearButton
isClearButtonVisible, setClearButtonVisibleMethods inherited from interface com.vaadin.flow.component.shared.HasClientValidation
addClientValidatedEventListenerMethods inherited from interface com.vaadin.flow.component.HasElement
getElementMethods inherited from interface com.vaadin.flow.component.HasEnabled
isEnabled, setEnabledMethods inherited from interface com.vaadin.flow.component.HasHelper
getHelperComponent, getHelperText, setHelperComponent, setHelperTextMethods inherited from interface com.vaadin.flow.data.provider.HasListDataView
setItemsMethods inherited from interface com.vaadin.flow.component.shared.HasOverlayClassName
getOverlayClassName, setOverlayClassNameMethods 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, setWidthFullMethods inherited from interface com.vaadin.flow.component.HasStyle
addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassNameMethods inherited from interface com.vaadin.flow.component.HasTheme
addThemeName, addThemeNames, getThemeName, getThemeNames, hasThemeName, removeThemeName, removeThemeNames, setThemeName, setThemeNameMethods inherited from interface com.vaadin.flow.component.shared.HasThemeVariant
addThemeVariants, removeThemeVariantsMethods inherited from interface com.vaadin.flow.component.shared.HasTooltip
getTooltip, setTooltipTextMethods inherited from interface com.vaadin.flow.component.shared.HasValidationProperties
getErrorMessage, isInvalid, setErrorMessage, setInvalidMethods inherited from interface com.vaadin.flow.data.binder.HasValidator
getDefaultValidatorMethods inherited from interface com.vaadin.flow.component.HasValue
addValueChangeListener, clear, getOptionalValue, isEmptyMethods inherited from interface com.vaadin.flow.component.HasValueAndElement
isReadOnly, isRequiredIndicatorVisible, setReadOnly, setRequiredIndicatorVisibleMethods inherited from interface com.vaadin.flow.data.selection.MultiSelect
deselect, deselect, deselectAll, getEmptyValue, select, select
-
Constructor Details
-
MultiSelectComboBox
public MultiSelectComboBox()Default constructor. Creates an empty combo box.
-
MultiSelectComboBox
public MultiSelectComboBox(int pageSize) Creates an empty combo box with the defined page size for lazy loading.
The default page size is 50.
The page size is also the largest number of items that can support client-side filtering. If you provide more items than the page size, the component has to fall back to server-side filtering.
Parameters:
pageSize- the amount of items to request at a time for lazy loadingSee Also:
-
MultiSelectComboBox
Creates an empty combo box with the defined label.
Parameters:
label- the label describing the combo boxSee Also:
-
MultiSelectComboBox
Creates a combo box with the defined label and populated with the items in the collection.
Parameters:
label- the label describing the combo boxitems- the items to be shown in the list of the combo boxSee Also:
-
MultiSelectComboBox
Creates a combo box with the defined label and populated with the items in the array.
Parameters:
label- the label describing the combo boxitems- the items to be shown in the list of the combo boxSee Also:
-
MultiSelectComboBox
public MultiSelectComboBox(HasValue.ValueChangeListener<AbstractField.ComponentValueChangeEvent<MultiSelectComboBox<TItem>, Set<TItem>>> listener) Constructs a combo box with a value change listener.
Parameters:
listener- the value change listener to addSee Also:
-
MultiSelectComboBox
public MultiSelectComboBox(String label, HasValue.ValueChangeListener<AbstractField.ComponentValueChangeEvent<MultiSelectComboBox<TItem>, Set<TItem>>> listener) Constructs a combo box with the defined label and a value change listener.
Parameters:
label- the label describing the combo boxlistener- the value change listener to addSee Also:
-
MultiSelectComboBox
@SafeVarargs public MultiSelectComboBox(String label, HasValue.ValueChangeListener<AbstractField.ComponentValueChangeEvent<MultiSelectComboBox<TItem>, Set<TItem>>> listener, TItem... items) Constructs a combo box with the defined label, a value change listener and populated with the items in the array.
Parameters:
label- the label describing the combo boxlistener- the value change listener to additems- the items to be shown in the list of the combo boxSee Also:
-
-
Method Details
-
onAttach
Description copied from class:
ComponentCalled when the component is attached to a UI.
The default implementation does nothing.
This method is invoked before the
AttachEventis fired for the component.Overrides:
onAttachin classComboBoxBase<MultiSelectComboBox<TItem>,TItem, Set<TItem>> Parameters:
attachEvent- the attach event -
getValue
Gets the value of the component, which is a set of selected items.
The returned set is immutable and can not be modified. Use
MultiSelect.select(Object[])orMultiSelect.deselect(Object[])to add or remove individual items.Specified by:
getValuein interfaceHasValue<AbstractField.ComponentValueChangeEvent<MultiSelectComboBox<TItem>,Set<TItem>>, Set<TItem>> Specified by:
getValuein interfaceMultiSelect<MultiSelectComboBox<TItem>,TItem> Overrides:
getValuein classAbstractField<MultiSelectComboBox<TItem>,Set<TItem>> Returns:
an unmodifiable set of selected items
-
setValue
Sets the value of the component, which is a set of selected items.
Note that it is allowed to pass
nullas value to clear the selection, but that an empty set will be stored as value instead.Specified by:
setValuein interfaceHasValue<AbstractField.ComponentValueChangeEvent<MultiSelectComboBox<TItem>,Set<TItem>>, Set<TItem>> Specified by:
setValuein interfaceMultiSelect<MultiSelectComboBox<TItem>,TItem> Overrides:
setValuein classComboBoxBase<MultiSelectComboBox<TItem>,TItem, Set<TItem>> Parameters:
value- the new value -
setValue
Sets the value of the component, which is a set of selected items. As each item can only be selected once, duplicates in the provided items will be removed. Passing no items will result in an empty selection.
Parameters:
items- the new value -
setValue
Sets the value of the component, which is a set of selected items. As each item can only be selected once, duplicates in the provided items will be removed. Passing no items will result in an empty selection.
Parameters:
items- the new value -
refreshValue
protected void refreshValue()Description copied from class:
ComboBoxBaseRefresh value / selection of the web component after changes that might affect the presentation / rendering of items
Specified by:
refreshValuein classComboBoxBase<MultiSelectComboBox<TItem>,TItem, Set<TItem>> -
isSelected
Description copied from class:
ComboBoxBaseWhether the item is currently selected in the combo box.
Specified by:
isSelectedin interfaceMultiSelect<MultiSelectComboBox<TItem>,TItem> Specified by:
isSelectedin classComboBoxBase<MultiSelectComboBox<TItem>,TItem, Set<TItem>> Parameters:
item- the item to checkReturns:
trueif the item is selected,falseotherwise -
getSelectedItems
Description copied from interface:
MultiSelectReturns an immutable set of the currently selected items. It is safe to invoke other
SelectionModelmethods while iterating over the set.Implementation note: the iteration order of the items in the returned set should be well-defined and documented by the implementing class.
Specified by:
getSelectedItemsin interfaceMultiSelect<MultiSelectComboBox<TItem>,TItem> Returns:
the items in the current selection, not
null -
addSelectionListener
public Registration addSelectionListener(MultiSelectionListener<MultiSelectComboBox<TItem>, TItem> listener) Description copied from interface:
MultiSelectAdds a selection listener that will be called when the selection is changed either by the user or programmatically.
Specified by:
addSelectionListenerin interfaceMultiSelect<MultiSelectComboBox<TItem>,TItem> Parameters:
listener- the value change listener, notnullReturns:
a registration for the listener
-
updateSelection
Description copied from interface:
MultiSelectUpdates the selection by adding and removing the given items from it.
If all the added items were already selected and the removed items were not selected, this is a NO-OP.
Duplicate items (in both add and remove sets) are ignored.
Specified by:
updateSelectionin interfaceMultiSelect<MultiSelectComboBox<TItem>,TItem> Parameters:
addedItems- the items to add, notnullremovedItems- the items to remove, notnull -
getI18n
Gets the internationalization object previously set for this component.
Note: updating the i18n object that is returned from this method will not update the component, unless it is set again using
setI18n(MultiSelectComboBoxI18n)Returns:
the i18n object. It will be
null, if it has not been set previously -
setI18n
Sets the internationalization properties for this component.
Parameters:
i18n- the internationalized properties, notnull
-