Package com.vaadin.flow.component.checkbox

Class GeneratedVaadinCheckboxGroup<R extends GeneratedVaadinCheckboxGroup<R,T>,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<R,T>

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasTheme, com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<R,T>,T>, com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<R,T>,T>, Serializable

Direct Known Subclasses:

CheckboxGroup

@Tag("vaadin-checkbox-group")
@NpmPackage(value="@vaadin/polymer-legacy-adapter",version="23.0.13") @NpmPackage(value="@vaadin/checkbox-group",version="23.0.13") @NpmPackage(value="@vaadin/vaadin-checkbox",version="23.0.13")
@JsModule("@vaadin/polymer-legacy-adapter/style-modules.js") @JsModule("@vaadin/checkbox-group/src/vaadin-checkbox-group.js")
public abstract class GeneratedVaadinCheckboxGroup<R extends GeneratedVaadinCheckboxGroup<R,T>,T>
extends com.vaadin.flow.component.AbstractSinglePropertyField<R,T>
implements com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasTheme

Description copied from corresponding location in WebComponent:

<vaadin-checkbox-group> is a Polymer element for grouping vaadin-checkboxes.

<vaadin-checkbox-group label="Preferred language of contact:"> <vaadin-checkbox value="en">English</vaadin-checkbox> <vaadin-checkbox value="fr">Français</vaadin-checkbox> <vaadin-checkbox value="de">Deutsch</vaadin-checkbox> </vaadin-checkbox-group>

Styling

The following shadow DOM parts are available for styling:

Part name	Description
label	The label element
group-field	The element that wraps checkboxes
error-message	The error message element

The following state attributes are available for styling:

Attribute	Description	Part name
disabled	Set when the checkbox group and its children are disabled.	:host
has-label	Set when the element has a label	:host
has-value	Set when the element has a value	:host
required	Set when the element is required	:host
invalid	Set when the element is invalid	:host

See ThemableMixin – how to apply styles for shadow parts

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	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 extends Object>

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

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

Constructor Summary

Constructors

Constructor	Description
GeneratedVaadinCheckboxGroup()	Default constructor.
GeneratedVaadinCheckboxGroup(T initialValue, T defaultValue, boolean acceptNullValues)	Constructs a new GeneratedVaadinCheckboxGroup component with the given arguments.
GeneratedVaadinCheckboxGroup(T initialValue, T defaultValue, Class<P> elementPropertyType, com.vaadin.flow.function.SerializableBiFunction<R,P,T> presentationToModel, com.vaadin.flow.function.SerializableBiFunction<R,T,P> modelToPresentation)	Constructs a new GeneratedVaadinCheckboxGroup component with the given arguments.
GeneratedVaadinCheckboxGroup(T initialValue, T defaultValue, Class<P> elementPropertyType, com.vaadin.flow.function.SerializableBiFunction<R,P,T> presentationToModel, com.vaadin.flow.function.SerializableBiFunction<R,T,P> modelToPresentation, boolean isInitialValueOptional)	Constructs a new GeneratedVaadinCheckboxGroup component with the given arguments.
GeneratedVaadinCheckboxGroup(T initialValue, T defaultValue, Class<P> elementPropertyType, com.vaadin.flow.function.SerializableFunction<P,T> presentationToModel, com.vaadin.flow.function.SerializableFunction<T,P> modelToPresentation)	Constructs a new GeneratedVaadinCheckboxGroup component with the given arguments.

Method Summary

Modifier and Type	Method	Description
protected com.vaadin.flow.shared.Registration	addInvalidChangeListener(com.vaadin.flow.component.ComponentEventListener<GeneratedVaadinCheckboxGroup.InvalidChangeEvent<R>> listener)	Adds a listener for invalid-changed events fired by the webcomponent.
void	addThemeVariants(CheckboxGroupVariant... variants)	Adds theme variants to the component.
protected String	getErrorMessageString()	Description copied from corresponding location in WebComponent:
protected String	getLabelString()	Description copied from corresponding location in WebComponent:
protected boolean	isDisabledBoolean()	Description copied from corresponding location in WebComponent:
protected boolean	isInvalidBoolean()	Description copied from corresponding location in WebComponent:
protected boolean	isRequiredBoolean()	Description copied from corresponding location in WebComponent:
void	removeThemeVariants(CheckboxGroupVariant... variants)	Removes theme variants from the component.
protected void	setDisabled(boolean disabled)	Description copied from corresponding location in WebComponent:
protected void	setErrorMessage(String errorMessage)	Description copied from corresponding location in WebComponent:
protected void	setInvalid(boolean invalid)	Description copied from corresponding location in WebComponent:
protected void	setLabel(String label)	Description copied from corresponding location in WebComponent:
protected void	setRequired(boolean required)	Description copied from corresponding location in WebComponent:
protected void	validate()	Description copied from corresponding location in WebComponent:

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, valueEquals

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

addListener, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getLocale, getParent, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, 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.HasElement

getElement

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

isEnabled, setEnabled

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

clear, getOptionalValue

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

isReadOnly, isRequiredIndicatorVisible, setReadOnly, setRequiredIndicatorVisible

Constructor Detail

GeneratedVaadinCheckboxGroup

public GeneratedVaadinCheckboxGroup(T initialValue,
                                    T defaultValue,
                                    Class<P> elementPropertyType,
                                    com.vaadin.flow.function.SerializableFunction<P,T> presentationToModel,
                                    com.vaadin.flow.function.SerializableFunction<T,P> modelToPresentation)

Constructs a new GeneratedVaadinCheckboxGroup component with the given arguments.

Type Parameters:

P - the property type

Parameters:

initialValue - the initial value to set to the value

defaultValue - the default value to use if the value isn't defined

elementPropertyType - the type of the element property

presentationToModel - a function that converts a string value to a model value

modelToPresentation - a function that converts a model value to a string value

GeneratedVaadinCheckboxGroup

public GeneratedVaadinCheckboxGroup(T initialValue,
                                    T defaultValue,
                                    boolean acceptNullValues)

Constructs a new GeneratedVaadinCheckboxGroup component with the given arguments.

Parameters:

initialValue - the initial value to set to the value

defaultValue - the default value to use if the value isn't defined

acceptNullValues - whether null is accepted as a model value

GeneratedVaadinCheckboxGroup

public GeneratedVaadinCheckboxGroup(T initialValue,
                                    T defaultValue,
                                    Class<P> elementPropertyType,
                                    com.vaadin.flow.function.SerializableBiFunction<R,P,T> presentationToModel,
                                    com.vaadin.flow.function.SerializableBiFunction<R,T,P> modelToPresentation,
                                    boolean isInitialValueOptional)

Constructs a new GeneratedVaadinCheckboxGroup component with the given arguments.

If isInitialValueOptional is true then the initial value is used only if element has no "value" property value, otherwise element "value" property is ignored and the initial value is set.

Type Parameters:

P - the property type

Parameters:

initialValue - the initial value to set to the value

defaultValue - the default value to use if the value isn't defined

elementPropertyType - the type of the element property

presentationToModel - a function that accepts this component and a property value and returns a model value

modelToPresentation - a function that accepts this component and a model value and returns a property value

isInitialValueOptional - if isInitialValueOptional is true then the initial value is used only if element has no "value" property value, otherwise element "value" property is ignored and the initial value is set

GeneratedVaadinCheckboxGroup

public GeneratedVaadinCheckboxGroup(T initialValue,
                                    T defaultValue,
                                    Class<P> elementPropertyType,
                                    com.vaadin.flow.function.SerializableBiFunction<R,P,T> presentationToModel,
                                    com.vaadin.flow.function.SerializableBiFunction<R,T,P> modelToPresentation)

Constructs a new GeneratedVaadinCheckboxGroup component with the given arguments.

If isInitialValueOptional is true then the initial value is used only if element has no "value" property value, otherwise element "value" property is ignored and the initial value is set.

Type Parameters:

P - the property type

Parameters:

initialValue - the initial value to set to the value

defaultValue - the default value to use if the value isn't defined

elementPropertyType - the type of the element property

presentationToModel - a function that accepts this component and a property value and returns a model value

modelToPresentation - a function that accepts this component and a model value and returns a property value

GeneratedVaadinCheckboxGroup

public GeneratedVaadinCheckboxGroup()

Default constructor.

Method Detail

addThemeVariants

public void addThemeVariants(CheckboxGroupVariant... variants)

Adds theme variants to the component.

Parameters:

variants - theme variants to add

removeThemeVariants

public void removeThemeVariants(CheckboxGroupVariant... variants)

Removes theme variants from the component.

Parameters:

variants - theme variants to remove

isDisabledBoolean

protected boolean isDisabledBoolean()

Description copied from corresponding location in WebComponent:

The current disabled state of the checkbox group. True if group and all internal checkboxes are disabled.

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

Returns:

the disabled property from the webcomponent

setDisabled

protected void setDisabled(boolean disabled)

Description copied from corresponding location in WebComponent:

The current disabled state of the checkbox group. True if group and all internal checkboxes are disabled.

Parameters:

disabled - the boolean value to set

getLabelString

protected String getLabelString()

Description copied from corresponding location in WebComponent:

String used for the label element.

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

Returns:

the label property from the webcomponent

setLabel

protected void setLabel(String label)

Description copied from corresponding location in WebComponent:

String used for the label element.

Parameters:

label - the String value to set

getErrorMessageString

protected String getErrorMessageString()

Description copied from corresponding location in WebComponent:

Error to show when the input value is invalid.

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

Returns:

the errorMessage property from the webcomponent

setErrorMessage

protected void setErrorMessage(String errorMessage)

Description copied from corresponding location in WebComponent:

Error to show when the input value is invalid.

Parameters:

errorMessage - the String value to set

isRequiredBoolean

protected boolean isRequiredBoolean()

Description copied from corresponding location in WebComponent:

Specifies that the user must fill in a value.

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

Returns:

the required property from the webcomponent

setRequired

protected void setRequired(boolean required)

Description copied from corresponding location in WebComponent:

Specifies that the user must fill in a value.

Parameters:

required - the boolean value to set

isInvalidBoolean

protected boolean isInvalidBoolean()

Description copied from corresponding location in WebComponent:

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

Returns:

the invalid property from the webcomponent

setInvalid

protected void setInvalid(boolean invalid)

Description copied from corresponding location in WebComponent:

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

Parameters:

invalid - the boolean value to set

validate

@NotSupported
protected void validate()

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.

addInvalidChangeListener

protected com.vaadin.flow.shared.Registration addInvalidChangeListener(com.vaadin.flow.component.ComponentEventListener<GeneratedVaadinCheckboxGroup.InvalidChangeEvent<R>> listener)

Adds a listener for invalid-changed events fired by the webcomponent.

Parameters:

listener - the listener

Returns:

a Registration for removing the event listener