Package com.vaadin.flow.component.checkbox

Class CheckboxGroup<T>

java.lang.Object

com.vaadin.flow.component.Component

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

com.vaadin.flow.component.AbstractSinglePropertyField<R,T>

com.vaadin.flow.component.checkbox.GeneratedVaadinCheckboxGroup<CheckboxGroup<T>,Set<T>>

com.vaadin.flow.component.checkbox.CheckboxGroup<T>

All Implemented Interfaces:

AttachNotifier, DetachNotifier, HasComponents, HasElement, HasEnabled, HasHelper, HasLabel, HasSize, HasStyle, HasTheme, HasValidation, HasValue<AbstractField.ComponentValueChangeEvent<CheckboxGroup<T>,Set<T>>,Set<T>>, HasValueAndElement<AbstractField.ComponentValueChangeEvent<CheckboxGroup<T>,Set<T>>,Set<T>>, HasItemComponents<T>, HasValidator<T>, HasDataView<T,Void,CheckboxGroupDataView<T>>, HasListDataView<T,CheckboxGroupListDataView<T>>, MultiSelect<CheckboxGroup<T>,T>, Serializable

public class CheckboxGroup<T>
extends GeneratedVaadinCheckboxGroup<CheckboxGroup<T>,Set<T>>
implements HasItemComponents<T>, HasSize, HasValidation, MultiSelect<CheckboxGroup<T>,T>, HasListDataView<T,CheckboxGroupListDataView<T>>, HasDataView<T,Void,CheckboxGroupDataView<T>>, HasHelper, HasLabel, HasValidator<T>

CheckBoxGroup is a multi-selection component where items are displayed as check boxes.

Use CheckBoxGroup to group related items. Individual checkboxes should be used for options that are not related to each other in any way.

Author:

Vaadin Ltd

See Also:

Serialized Form

Nested Class Summary

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

GeneratedVaadinCheckboxGroup.InvalidChangeEvent<R extends GeneratedVaadinCheckboxGroup<R,?>>

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

HasItemComponents.ItemComponent<T>

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

HasValue.ValueChangeEvent<V>, HasValue.ValueChangeListener<E extends HasValue.ValueChangeEvent<?>>

Constructor Summary

Constructors

Constructor	Description
CheckboxGroup()	Creates an empty checkbox group
CheckboxGroup(HasValue.ValueChangeListener<AbstractField.ComponentValueChangeEvent<CheckboxGroup<T>,Set<T>>> listener)	Constructs a checkbox group with a value change listener.
CheckboxGroup(String label)	Creates an empty checkbox group with the defined label.
CheckboxGroup(String label, HasValue.ValueChangeListener<AbstractField.ComponentValueChangeEvent<CheckboxGroup<T>,Set<T>>> listener)	Constructs a checkbox group with the defined label and a value change listener.
CheckboxGroup(String label, HasValue.ValueChangeListener<AbstractField.ComponentValueChangeEvent<CheckboxGroup<T>,Set<T>>> listener, T... items)	Constructs a checkbox group with the defined label, a value change listener and populated with the items in the array.
CheckboxGroup(String label, Collection<T> items)	Creates a checkbox group with the defined label and populated with the items in the collection.
CheckboxGroup(String label, T... items)	Creates a checkbox group with the defined label and populated with the items in the array.

Method Summary

Modifier and Type	Method	Description
Registration	addSelectionListener(MultiSelectionListener<CheckboxGroup<T>,T> listener)	Adds a selection listener that will be called when the selection is changed either by the user or programmatically.
DataProvider<T,?>	getDataProvider()	Deprecated. use getListDataView() or getGenericDataView() instead
String	getErrorMessage()	Gets the current error message from the checkbox group.
CheckboxGroupDataView<T>	getGenericDataView()	Gets the generic data view for the checkbox group.
SerializablePredicate<T>	getItemEnabledProvider()	Returns the item enabled predicate.
ItemLabelGenerator<T>	getItemLabelGenerator()	Gets the item label generator that is used to produce the strings shown in the checkbox group for each item.
ComponentRenderer<? extends Component,T>	getItemRenderer()	Returns the item component renderer.
String	getLabel()	Gets the label of the checkbox group.
CheckboxGroupListDataView<T>	getListDataView()	Gets the list data view for the checkbox group.
Set<T>	getSelectedItems()	Returns an immutable set of the currently selected items.
protected boolean	hasValidValue()	Checks whether the element property has a value that can be converted to the model type.
boolean	isInvalid()	Returns true if component input is invalid, false otherwise.
boolean	isReadOnly()	Returns whether this HasValue is in read-only mode or not.
boolean	isRequired()	Determines whether the checkbox group is marked as input required.
protected void	onAttach(AttachEvent attachEvent)	Called when the component is attached to a UI.
void	onEnabledStateChanged(boolean enabled)	Handle component enable state when the enabled state changes.
void	setDataProvider(DataProvider<T,?> dataProvider)	Deprecated. use instead one of the setItems methods which provide access to either CheckboxGroupListDataView or CheckboxGroupDataView
void	setErrorMessage(String errorMessage)	Description copied from corresponding location in WebComponent:
void	setInvalid(boolean invalid)	Description copied from corresponding location in WebComponent:
void	setItemEnabledProvider(SerializablePredicate<T> itemEnabledProvider)	Sets the item enabled predicate for this checkbox group.
void	setItemLabelGenerator(ItemLabelGenerator<T> itemLabelGenerator)	Sets the item label generator that is used to produce the strings shown in the checkbox group for each item.
CheckboxGroupDataView<T>	setItems(DataProvider<T,Void> dataProvider)	Set a generic data provider for the component to use and returns the base DataView that provides API to get information on the items.
CheckboxGroupDataView<T>	setItems(InMemoryDataProvider<T> inMemoryDataProvider)	Sets an in-memory data provider for the component to use
CheckboxGroupListDataView<T>	setItems(ListDataProvider<T> dataProvider)	Sets a ListDataProvider for the component to use and returns a ListDataView that provides information and allows operations on the items.
void	setItems(Stream<T> streamOfItems)	Deprecated. Because the stream is collected to a list anyway, use HasListDataView.setItems(Collection) instead.
void	setLabel(String label)	Sets the label for the checkbox group.
void	setReadOnly(boolean readOnly)	Sets the read-only mode of this HasValue to given mode.
void	setRenderer(ComponentRenderer<? extends Component,T> renderer)	Sets the item renderer for this checkbox group.
void	setRequired(boolean required)	Description copied from corresponding location in WebComponent:
void	setValue(Set<T> value)	Sets the value of this component.
void	updateSelection(Set<T> addedItems, Set<T> removedItems)	Updates the selection by adding and removing the given items from it.
protected boolean	valueEquals(Set<T> value1, Set<T> value2)	Compares to value instances to each other to determine whether they are equal.

Methods inherited from class com.vaadin.flow.component.checkbox.GeneratedVaadinCheckboxGroup

addInvalidChangeListener, addThemeVariants, getErrorMessageString, getLabelString, isDisabledBoolean, isInvalidBoolean, isRequiredBoolean, removeThemeVariants, setDisabled, validate

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

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, onDetach, 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.DetachNotifier

addDetachListener

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

add, add, add, addComponentAsFirst, addComponentAtIndex, remove, remove, removeAll

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

addComponents, getItemPosition, prependComponents

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

setItems, setItems

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

addValidationStatusChangeListener, getDefaultValidator

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

addValueChangeListener, clear, getOptionalValue, isEmpty

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

isRequiredIndicatorVisible, setRequiredIndicatorVisible

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

deselect, deselect, deselectAll, getEmptyValue, getValue, isSelected, select, select

Constructor Detail

CheckboxGroup

public CheckboxGroup()

Creates an empty checkbox group

CheckboxGroup

public CheckboxGroup(String label)

Creates an empty checkbox group with the defined label.

Parameters:

label - the label describing the checkbox group

See Also:

setLabel(String)

CheckboxGroup

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

Creates a checkbox group with the defined label and populated with the items in the collection.

Parameters:

label - the label describing the checkbox group

items - the items to be shown in the list of the checkbox group

See Also:

setLabel(String), HasListDataView.setItems(Collection)

CheckboxGroup

@SafeVarargs
public CheckboxGroup(String label,
                     T... items)

Creates a checkbox group with the defined label and populated with the items in the array.

Parameters:

label - the label describing the checkbox group

items - the items to be shown in the list of the checkbox group

See Also:

setLabel(String), HasListDataView.setItems(Object...)

CheckboxGroup

public CheckboxGroup(HasValue.ValueChangeListener<AbstractField.ComponentValueChangeEvent<CheckboxGroup<T>,Set<T>>> listener)

Constructs a checkbox group with a value change listener.

Parameters:

listener - the value change listener to add

See Also:

AbstractField.addValueChangeListener(ValueChangeListener)

CheckboxGroup

public CheckboxGroup(String label,
                     HasValue.ValueChangeListener<AbstractField.ComponentValueChangeEvent<CheckboxGroup<T>,Set<T>>> listener)

Constructs a checkbox group with the defined label and a value change listener.

Parameters:

label - the label describing the checkbox group

listener - the value change listener to add

See Also:

setLabel(String), AbstractField.addValueChangeListener(ValueChangeListener)

CheckboxGroup

@SafeVarargs
public CheckboxGroup(String label,
                     HasValue.ValueChangeListener<AbstractField.ComponentValueChangeEvent<CheckboxGroup<T>,Set<T>>> listener,
                     T... items)

Constructs a checkbox group with the defined label, a value change listener and populated with the items in the array.

Parameters:

label - the label describing the checkbox group

listener - the value change listener to add

items - the items to be shown in the list of the checkbox group

See Also:

setLabel(String), AbstractField.addValueChangeListener(ValueChangeListener), HasListDataView.setItems(Object...)

Method Detail

onAttach

protected void onAttach(AttachEvent attachEvent)

Description copied from class: Component

Called when the component is attached to a UI.

The default implementation does nothing.

This method is invoked before the AttachEvent is fired for the component.

Overrides:

onAttach in class Component

Parameters:

attachEvent - the attach event

setItems

public CheckboxGroupDataView<T> setItems(DataProvider<T,Void> dataProvider)

Description copied from interface: HasDataView

Set a generic data provider for the component to use and returns the base DataView that provides API to get information on the items.

This method should be used only when the data provider type is not either ListDataProvider or BackEndDataProvider.

Specified by:

setItems in interface HasDataView<T,Void,CheckboxGroupDataView<T>>

Parameters:

dataProvider - DataProvider instance to use, not null

Returns:

DataView providing information on the data

setItems

public CheckboxGroupDataView<T> setItems(InMemoryDataProvider<T> inMemoryDataProvider)

Description copied from interface: HasDataView

Sets an in-memory data provider for the component to use

Note! Using a ListDataProvider instead of a InMemoryDataProvider is recommended to get access to ListDataView API by using HasListDataView.setItems(ListDataProvider).

Specified by:

setItems in interface HasDataView<T,Void,CheckboxGroupDataView<T>>

Parameters:

inMemoryDataProvider - InMemoryDataProvider to use, not null

Returns:

DataView providing information on the data

setItems

public CheckboxGroupListDataView<T> setItems(ListDataProvider<T> dataProvider)

Description copied from interface: HasListDataView

Sets a ListDataProvider for the component to use and returns a ListDataView that provides information and allows operations on the items.

Specified by:

setItems in interface HasListDataView<T,CheckboxGroupListDataView<T>>

Parameters:

dataProvider - ListDataProvider providing items to the component.

Returns:

ListDataView providing access to the items

getListDataView

public CheckboxGroupListDataView<T> getListDataView()

Gets the list data view for the checkbox group. This data view should only be used when the items are in-memory and set with:

• HasListDataView.setItems(Collection)
• HasListDataView.setItems(Object[])
• setItems(ListDataProvider)

If the items are not in-memory an exception is thrown.

Specified by:

getListDataView in interface HasListDataView<T,CheckboxGroupListDataView<T>>

Returns:

the list data view that provides access to the data bound to the checkbox group

getGenericDataView

public CheckboxGroupDataView<T> getGenericDataView()

Gets the generic data view for the checkbox group. This data view should only be used when getListDataView() is not applicable for the underlying data provider.

Specified by:

getGenericDataView in interface HasDataView<T,Void,CheckboxGroupDataView<T>>

Returns:

the generic DataView instance implementing CheckboxGroupDataView

setItems

@Deprecated
public void setItems(Stream<T> streamOfItems)

Deprecated.

Because the stream is collected to a list anyway, use HasListDataView.setItems(Collection) instead.

setDataProvider

@Deprecated
public void setDataProvider(DataProvider<T,?> dataProvider)

Deprecated.

use instead one of the setItems methods which provide access to either CheckboxGroupListDataView or CheckboxGroupDataView

updateSelection

public void updateSelection(Set<T> addedItems,
                            Set<T> removedItems)

Description copied from interface: MultiSelect

Updates 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:

updateSelection in interface MultiSelect<CheckboxGroup<T>,T>

Parameters:

addedItems - the items to add, not null

removedItems - the items to remove, not null

setValue

public void setValue(Set<T> value)

Sets the value of this component. If the new value is not equal to the previous value, fires a value change event.

The component doesn't accept null values. The value of a checkbox group without any selected items is an empty set. You can use the HasValue.clear() method to set the empty value.

Specified by:

setValue in interface HasValue<AbstractField.ComponentValueChangeEvent<CheckboxGroup<T>,Set<T>>,Set<T>>

Specified by:

setValue in interface MultiSelect<CheckboxGroup<T>,T>

Overrides:

setValue in class AbstractField<CheckboxGroup<T>,Set<T>>

Parameters:

value - the new value to set, not null

Throws:

NullPointerException - if value is null

getSelectedItems

public Set<T> getSelectedItems()

Description copied from interface: MultiSelect

Returns an immutable set of the currently selected items. It is safe to invoke other SelectionModel methods 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:

getSelectedItems in interface MultiSelect<CheckboxGroup<T>,T>

Returns:

the items in the current selection, not null

addSelectionListener

public Registration addSelectionListener(MultiSelectionListener<CheckboxGroup<T>,T> listener)

Description copied from interface: MultiSelect

Adds a selection listener that will be called when the selection is changed either by the user or programmatically.

Specified by:

addSelectionListener in interface MultiSelect<CheckboxGroup<T>,T>

Parameters:

listener - the value change listener, not null

Returns:

a registration for the listener

getDataProvider

@Deprecated
public DataProvider<T,?> getDataProvider()

Deprecated.

use getListDataView() or getGenericDataView() instead

Gets the data provider.

Returns:

the data provider, not null

onEnabledStateChanged

public void onEnabledStateChanged(boolean enabled)

Description copied from class: Component

Handle component enable state when the enabled state changes.

By default this sets or removes the 'disabled' attribute from the element. This can be overridden to have custom handling.

Overrides:

onEnabledStateChanged in class Component

Parameters:

enabled - the new enabled state of the component

setReadOnly

public void setReadOnly(boolean readOnly)

Description copied from interface: HasValue

Sets the read-only mode of this HasValue to given mode. The user can't change the value when in read-only mode.

A HasValue with a visual component in read-only mode typically looks visually different to signal to the user that the value cannot be edited.

Specified by:

setReadOnly in interface HasValue<AbstractField.ComponentValueChangeEvent<CheckboxGroup<T>,Set<T>>,Set<T>>

Specified by:

setReadOnly in interface HasValueAndElement<AbstractField.ComponentValueChangeEvent<CheckboxGroup<T>,Set<T>>,Set<T>>

Parameters:

readOnly - a boolean value specifying whether the component is put read-only mode or not

isReadOnly

public boolean isReadOnly()

Description copied from interface: HasValue

Returns whether this HasValue is in read-only mode or not.

Specified by:

isReadOnly in interface HasValue<AbstractField.ComponentValueChangeEvent<CheckboxGroup<T>,Set<T>>,Set<T>>

Specified by:

isReadOnly in interface HasValueAndElement<AbstractField.ComponentValueChangeEvent<CheckboxGroup<T>,Set<T>>,Set<T>>

Returns:

false if the user can modify the value, true if not.

getItemEnabledProvider

public SerializablePredicate<T> getItemEnabledProvider()

Returns the item enabled predicate.

Returns:

the item enabled predicate

See Also:

setItemEnabledProvider(com.vaadin.flow.function.SerializablePredicate<T>)

setItemEnabledProvider

public void setItemEnabledProvider(SerializablePredicate<T> itemEnabledProvider)

Sets the item enabled predicate for this checkbox group. The predicate is applied to each item to determine whether the item should be enabled (true) or disabled (false). Disabled items are displayed as grayed out and the user cannot select them. The default predicate always returns true (all the items are enabled).

Parameters:

itemEnabledProvider - the item enable predicate, not null

setItemLabelGenerator

public void setItemLabelGenerator(ItemLabelGenerator<T> itemLabelGenerator)

Sets the item label generator that is used to produce the strings shown in the checkbox group for each item. By default, String.valueOf(Object) is used.

Parameters:

itemLabelGenerator - the item label provider to use, not null

getItemLabelGenerator

public ItemLabelGenerator<T> getItemLabelGenerator()

Gets the item label generator that is used to produce the strings shown in the checkbox group for each item.

Returns:

the item label generator used, not null

setLabel

public void setLabel(String label)

Sets the label for the checkbox group.

Specified by:

setLabel in interface HasLabel

Overrides:

setLabel in class GeneratedVaadinCheckboxGroup<CheckboxGroup<T>,Set<T>>

Parameters:

label - value for the label property in the checkbox group

getLabel

public String getLabel()

Gets the label of the checkbox group.

Specified by:

getLabel in interface HasLabel

Returns:

the label property of the checkbox group

setErrorMessage

public void setErrorMessage(String errorMessage)

Description copied from class: GeneratedVaadinCheckboxGroup

Description copied from corresponding location in WebComponent:

Error to show when the input value is invalid.

Specified by:

setErrorMessage in interface HasValidation

Overrides:

setErrorMessage in class GeneratedVaadinCheckboxGroup<CheckboxGroup<T>,Set<T>>

Parameters:

errorMessage - the String value to set

getErrorMessage

public String getErrorMessage()

Gets the current error message from the checkbox group.

Specified by:

getErrorMessage in interface HasValidation

Returns:

the current error message

setRequired

public void setRequired(boolean required)

Description copied from class: GeneratedVaadinCheckboxGroup

Description copied from corresponding location in WebComponent:

Specifies that the user must fill in a value.

Overrides:

setRequired in class GeneratedVaadinCheckboxGroup<CheckboxGroup<T>,Set<T>>

Parameters:

required - the boolean value to set

isRequired

public boolean isRequired()

Determines whether the checkbox group is marked as input required.

This property is not synchronized automatically from the client side, so the returned value may not be the same as in client side.

Returns:

true if the input is required, false otherwise

isInvalid

public boolean isInvalid()

Description copied from interface: HasValidation

Returns true if component input is invalid, false otherwise.

Specified by:

isInvalid in interface HasValidation

Returns:

whether the component input is valid

setInvalid

public void setInvalid(boolean invalid)

Description copied from class: GeneratedVaadinCheckboxGroup

Description copied from corresponding location in WebComponent:

This property is set to true when the control value is invalid.

Specified by:

setInvalid in interface HasValidation

Overrides:

setInvalid in class GeneratedVaadinCheckboxGroup<CheckboxGroup<T>,Set<T>>

Parameters:

invalid - the boolean value to set

valueEquals

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

Description copied from class: AbstractField

Compares to 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 AbstractField<CheckboxGroup<T>,Set<T>>

Parameters:

value1 - the first instance

value2 - the second instance

Returns:

true if the instances are equal; otherwise false

hasValidValue

protected boolean hasValidValue()

Description copied from class: AbstractSinglePropertyField

Checks whether the element property has a value that can be converted to the model type. Property changes from the element will be ignored if this method returns false. The default implementation always return true.

Overrides:

hasValidValue in class AbstractSinglePropertyField<CheckboxGroup<T>,Set<T>>

Returns:

true if the element property value can be converted to the model type; otherwise false

getItemRenderer

public ComponentRenderer<? extends Component,T> getItemRenderer()

Returns the item component renderer.

Returns:

the item renderer

Since:

23.1

See Also:

setRenderer(ComponentRenderer)

setRenderer

public void setRenderer(ComponentRenderer<? extends Component,T> renderer)

Sets the item renderer for this checkbox group. The renderer is applied to each item to create a component which represents the item.

Note: Component acts as a label to the checkbox and clicks on it trigger the checkbox. Hence interactive components like DatePicker or ComboBox cannot be used.

Parameters:

renderer - the item renderer, not null

Since:

23.1