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:

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.HasHelper, com.vaadin.flow.component.HasLabel, 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<CheckboxGroup<T>,Set<T>>,Set<T>>, com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<CheckboxGroup<T>,Set<T>>,Set<T>>, HasClientValidation, com.vaadin.flow.data.binder.HasDataProvider<T>, com.vaadin.flow.data.binder.HasItems<T>, com.vaadin.flow.data.binder.HasItemsAndComponents<T>, com.vaadin.flow.data.binder.HasValidator<Set<T>>, com.vaadin.flow.data.selection.MultiSelect<CheckboxGroup<T>,T>, Serializable

public class CheckboxGroup<T>
extends GeneratedVaadinCheckboxGroup<CheckboxGroup<T>,Set<T>>
implements com.vaadin.flow.data.binder.HasItemsAndComponents<T>, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasValidation, com.vaadin.flow.data.selection.MultiSelect<CheckboxGroup<T>,T>, com.vaadin.flow.data.binder.HasDataProvider<T>, com.vaadin.flow.component.HasHelper, com.vaadin.flow.component.HasLabel, com.vaadin.flow.data.binder.HasValidator<Set<T>>, HasClientValidation

Server-side component for the vaadin-checkbox-group element.

CheckBoxGroup is a multiselection component where items are displayed as check boxes.

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

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

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

com.vaadin.flow.data.binder.HasItemsAndComponents.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<?>>

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

HasClientValidation.ClientValidatedEvent

Constructor Summary

Constructors

Constructor and Description
CheckboxGroup()

Method Summary

Modifier and Type	Method and Description
com.vaadin.flow.shared.Registration	addSelectionListener(com.vaadin.flow.data.selection.MultiSelectionListener<CheckboxGroup<T>,T> listener)
com.vaadin.flow.shared.Registration	addValidationStatusChangeListener(com.vaadin.flow.data.binder.ValidationStatusChangeListener<Set<T>> listener)
com.vaadin.flow.data.provider.DataProvider<T,?>	getDataProvider() Gets the data provider.
String	getErrorMessage() Gets the current error message from the checkbox group.
com.vaadin.flow.function.SerializablePredicate<T>	getItemEnabledProvider() Returns the item enabled predicate.
com.vaadin.flow.component.ItemLabelGenerator<T>	getItemLabelGenerator() Gets the item label generator that is used to produce the strings shown in the checkbox group for each item.
String	getLabel() Gets the label of the checkbox group.
Set<T>	getSelectedItems()
protected boolean	hasValidValue()
protected boolean	isEnforcedFieldValidationEnabled()
boolean	isInvalid()
boolean	isReadOnly()
boolean	isRequired() Determines whether the checkbox group is marked as input required.
protected void	onAttach(com.vaadin.flow.component.AttachEvent attachEvent)
void	onEnabledStateChanged(boolean enabled)
void	setDataProvider(com.vaadin.flow.data.provider.DataProvider<T,?> dataProvider)
void	setErrorMessage(String errorMessage) Description copied from corresponding location in WebComponent:
void	setInvalid(boolean invalid) Description copied from corresponding location in WebComponent:
void	setItemEnabledProvider(com.vaadin.flow.function.SerializablePredicate<T> itemEnabledProvider) Sets the item enabled predicate for this checkbox group.
void	setItemLabelGenerator(com.vaadin.flow.component.ItemLabelGenerator<T> itemLabelGenerator) Sets the item label generator that is used to produce the strings shown in the checkbox group for each item.
void	setLabel(String label) Sets the label for the checkbox group.
void	setReadOnly(boolean readOnly)
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)
protected void	validate() Description copied from corresponding location in WebComponent:
protected boolean	valueEquals(Set<T> value1, Set<T> value2)

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

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

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, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onDetach, 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.data.binder.HasItemsAndComponents

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, 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.data.selection.MultiSelect

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

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

isRequiredIndicatorVisible, setRequiredIndicatorVisible

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

addValueChangeListener, clear, getOptionalValue, isEmpty

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

isEnabled, setEnabled

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

setItems

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

setItems, setItems

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

getHelperComponent, getHelperText, setHelperComponent, setHelperText

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

getDefaultValidator

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

addClientValidatedEventListener

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

addAttachListener

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

addDetachListener

Constructor Detail

CheckboxGroup

public CheckboxGroup()

Method Detail

onAttach

protected void onAttach(com.vaadin.flow.component.AttachEvent attachEvent)

Overrides:

onAttach in class com.vaadin.flow.component.Component

setDataProvider

public void setDataProvider(com.vaadin.flow.data.provider.DataProvider<T,?> dataProvider)

Specified by:

setDataProvider in interface com.vaadin.flow.data.binder.HasDataProvider<T>

updateSelection

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

Specified by:

updateSelection in interface com.vaadin.flow.data.selection.MultiSelect<CheckboxGroup<T>,T>

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 com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<CheckboxGroup<T>,Set<T>>,Set<T>>

Specified by:

setValue in interface com.vaadin.flow.data.selection.MultiSelect<CheckboxGroup<T>,T>

Overrides:

setValue in class com.vaadin.flow.component.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()

Specified by:

getSelectedItems in interface com.vaadin.flow.data.selection.MultiSelect<CheckboxGroup<T>,T>

addSelectionListener

public com.vaadin.flow.shared.Registration addSelectionListener(com.vaadin.flow.data.selection.MultiSelectionListener<CheckboxGroup<T>,T> listener)

Specified by:

addSelectionListener in interface com.vaadin.flow.data.selection.MultiSelect<CheckboxGroup<T>,T>

getDataProvider

public com.vaadin.flow.data.provider.DataProvider<T,?> getDataProvider()

Gets the data provider.

Returns:

the data provider, not null

onEnabledStateChanged

public void onEnabledStateChanged(boolean enabled)

Overrides:

onEnabledStateChanged in class com.vaadin.flow.component.Component

setReadOnly

public void setReadOnly(boolean readOnly)

Specified by:

setReadOnly in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<CheckboxGroup<T>,Set<T>>,Set<T>>

Specified by:

setReadOnly in interface com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<CheckboxGroup<T>,Set<T>>,Set<T>>

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<CheckboxGroup<T>,Set<T>>,Set<T>>

Specified by:

isReadOnly in interface com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<CheckboxGroup<T>,Set<T>>,Set<T>>

getItemEnabledProvider

public com.vaadin.flow.function.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(com.vaadin.flow.function.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(com.vaadin.flow.component.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 com.vaadin.flow.component.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 com.vaadin.flow.component.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 com.vaadin.flow.component.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 com.vaadin.flow.component.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 com.vaadin.flow.component.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()

Specified by:

isInvalid in interface com.vaadin.flow.component.HasValidation

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 com.vaadin.flow.component.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)

Overrides:

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

hasValidValue

protected boolean hasValidValue()

Overrides:

hasValidValue in class com.vaadin.flow.component.AbstractSinglePropertyField<CheckboxGroup<T>,Set<T>>

validate

protected void validate()

Description copied from class: GeneratedVaadinCheckboxGroup

Description copied from corresponding location in WebComponent:

Returns true if value is valid. <iron-form> uses this to check the validity or all its elements.

This function is not supported by Flow because it returns a boolean. Functions with return types different than void are not supported at this moment.

Overrides:

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

addValidationStatusChangeListener

public com.vaadin.flow.shared.Registration addValidationStatusChangeListener(com.vaadin.flow.data.binder.ValidationStatusChangeListener<Set<T>> listener)

Specified by:

addValidationStatusChangeListener in interface com.vaadin.flow.data.binder.HasValidator<Set<T>>

isEnforcedFieldValidationEnabled

protected boolean isEnforcedFieldValidationEnabled()