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:
AttachNotifier
,DetachNotifier
,HasElement
,HasEnabled
,HasStyle
,HasTheme
,HasValue<AbstractField.ComponentValueChangeEvent<R,T>,T>
,HasValueAndElement<AbstractField.ComponentValueChangeEvent<R,T>,T>
,Serializable
- Direct Known Subclasses:
CheckboxGroup
@Deprecated @Tag("vaadin-checkbox-group") @NpmPackage(value="@vaadin/polymer-legacy-adapter",version="23.5.12") @NpmPackage(value="@vaadin/checkbox-group",version="23.5.12") @NpmPackage(value="@vaadin/vaadin-checkbox",version="23.5.12") @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 AbstractSinglePropertyField<R,T> implements HasStyle, HasTheme
Deprecated.since v23.3, generated classes will be removed in v24.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 Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
GeneratedVaadinCheckboxGroup.InvalidChangeEvent<R extends GeneratedVaadinCheckboxGroup<R,?>>
Deprecated.since v23.3, generated classes will be removed in v24.-
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.HasValue
HasValue.ValueChangeEvent<V>, HasValue.ValueChangeListener<E extends HasValue.ValueChangeEvent<?>>
-
-
Constructor Summary
Constructors Constructor Description GeneratedVaadinCheckboxGroup()
Deprecated.since v23.3, generated classes will be removed in v24.GeneratedVaadinCheckboxGroup(T initialValue, T defaultValue, boolean acceptNullValues)
Deprecated.since v23.3, generated classes will be removed in v24.GeneratedVaadinCheckboxGroup(T initialValue, T defaultValue, Class<P> elementPropertyType, SerializableBiFunction<R,P,T> presentationToModel, SerializableBiFunction<R,T,P> modelToPresentation)
Deprecated.since v23.3, generated classes will be removed in v24.GeneratedVaadinCheckboxGroup(T initialValue, T defaultValue, Class<P> elementPropertyType, SerializableBiFunction<R,P,T> presentationToModel, SerializableBiFunction<R,T,P> modelToPresentation, boolean isInitialValueOptional)
Deprecated.since v23.3, generated classes will be removed in v24.GeneratedVaadinCheckboxGroup(T initialValue, T defaultValue, Class<P> elementPropertyType, SerializableFunction<P,T> presentationToModel, SerializableFunction<T,P> modelToPresentation)
Deprecated.since v23.3, generated classes will be removed in v24.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected Registration
addInvalidChangeListener(ComponentEventListener<GeneratedVaadinCheckboxGroup.InvalidChangeEvent<R>> listener)
Deprecated.since v23.3, generated classes will be removed in v24.void
addThemeVariants(CheckboxGroupVariant... variants)
Deprecated.since v23.3, generated classes will be removed in v24.protected String
getErrorMessageString()
Deprecated.since v23.3, generated classes will be removed in v24.protected String
getLabelString()
Deprecated.since v23.3, generated classes will be removed in v24.protected boolean
isDisabledBoolean()
Deprecated.since v23.3, generated classes will be removed in v24.protected boolean
isInvalidBoolean()
Deprecated.since v23.3, generated classes will be removed in v24.protected boolean
isRequiredBoolean()
Deprecated.since v23.3, generated classes will be removed in v24.void
removeThemeVariants(CheckboxGroupVariant... variants)
Deprecated.since v23.3, generated classes will be removed in v24.protected void
setDisabled(boolean disabled)
Deprecated.since v23.3, generated classes will be removed in v24.protected void
setErrorMessage(String errorMessage)
Deprecated.since v23.3, generated classes will be removed in v24.protected void
setInvalid(boolean invalid)
Deprecated.since v23.3, generated classes will be removed in v24.protected void
setLabel(String label)
Deprecated.since v23.3, generated classes will be removed in v24.protected void
setRequired(boolean required)
Deprecated.since v23.3, generated classes will be removed in v24.protected void
validate()
Deprecated.since v23.3, generated classes will be removed in v24.-
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, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, 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.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
@Deprecated public GeneratedVaadinCheckboxGroup(T initialValue, T defaultValue, Class<P> elementPropertyType, SerializableFunction<P,T> presentationToModel, SerializableFunction<T,P> modelToPresentation)
Deprecated.since v23.3, generated classes will be removed in v24.Constructs a new GeneratedVaadinCheckboxGroup component with the given arguments.- Type Parameters:
P
- the property type- Parameters:
initialValue
- the initial value to set to the valuedefaultValue
- the default value to use if the value isn't definedelementPropertyType
- the type of the element propertypresentationToModel
- a function that converts a string value to a model valuemodelToPresentation
- a function that converts a model value to a string value
-
GeneratedVaadinCheckboxGroup
@Deprecated public GeneratedVaadinCheckboxGroup(T initialValue, T defaultValue, boolean acceptNullValues)
Deprecated.since v23.3, generated classes will be removed in v24.Constructs a new GeneratedVaadinCheckboxGroup component with the given arguments.- Parameters:
initialValue
- the initial value to set to the valuedefaultValue
- the default value to use if the value isn't definedacceptNullValues
- whethernull
is accepted as a model value
-
GeneratedVaadinCheckboxGroup
@Deprecated public GeneratedVaadinCheckboxGroup(T initialValue, T defaultValue, Class<P> elementPropertyType, SerializableBiFunction<R,P,T> presentationToModel, SerializableBiFunction<R,T,P> modelToPresentation, boolean isInitialValueOptional)
Deprecated.since v23.3, generated classes will be removed in v24.Constructs a new GeneratedVaadinCheckboxGroup component with the given arguments.If
isInitialValueOptional
istrue
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 valuedefaultValue
- the default value to use if the value isn't definedelementPropertyType
- the type of the element propertypresentationToModel
- a function that accepts this component and a property value and returns a model valuemodelToPresentation
- a function that accepts this component and a model value and returns a property valueisInitialValueOptional
- ifisInitialValueOptional
istrue
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
@Deprecated public GeneratedVaadinCheckboxGroup(T initialValue, T defaultValue, Class<P> elementPropertyType, SerializableBiFunction<R,P,T> presentationToModel, SerializableBiFunction<R,T,P> modelToPresentation)
Deprecated.since v23.3, generated classes will be removed in v24.Constructs a new GeneratedVaadinCheckboxGroup component with the given arguments.If
isInitialValueOptional
istrue
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 valuedefaultValue
- the default value to use if the value isn't definedelementPropertyType
- the type of the element propertypresentationToModel
- a function that accepts this component and a property value and returns a model valuemodelToPresentation
- a function that accepts this component and a model value and returns a property value
-
GeneratedVaadinCheckboxGroup
@Deprecated public GeneratedVaadinCheckboxGroup()
Deprecated.since v23.3, generated classes will be removed in v24.Default constructor.
-
-
Method Detail
-
addThemeVariants
@Deprecated public void addThemeVariants(CheckboxGroupVariant... variants)
Deprecated.since v23.3, generated classes will be removed in v24. UseCheckboxGroup.addThemeVariants(com.vaadin.flow.component.checkbox.CheckboxGroupVariant...)
instead.Adds theme variants to the component.- Parameters:
variants
- theme variants to add
-
removeThemeVariants
@Deprecated public void removeThemeVariants(CheckboxGroupVariant... variants)
Deprecated.since v23.3, generated classes will be removed in v24. UseCheckboxGroup.removeThemeVariants(com.vaadin.flow.component.checkbox.CheckboxGroupVariant...)
instead.Removes theme variants from the component.- Parameters:
variants
- theme variants to remove
-
isDisabledBoolean
@Deprecated protected boolean isDisabledBoolean()
Deprecated.since v23.3, generated classes will be removed in v24.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
@Deprecated protected void setDisabled(boolean disabled)
Deprecated.since v23.3, generated classes will be removed in v24.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
@Deprecated protected String getLabelString()
Deprecated.since v23.3, generated classes will be removed in v24.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
@Deprecated protected void setLabel(String label)
Deprecated.since v23.3, generated classes will be removed in v24.Description copied from corresponding location in WebComponent:
String used for the label element.
- Parameters:
label
- the String value to set
-
getErrorMessageString
@Deprecated protected String getErrorMessageString()
Deprecated.since v23.3, generated classes will be removed in v24.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
@Deprecated protected void setErrorMessage(String errorMessage)
Deprecated.since v23.3, generated classes will be removed in v24.Description copied from corresponding location in WebComponent:
Error to show when the input value is invalid.
- Parameters:
errorMessage
- the String value to set
-
isRequiredBoolean
@Deprecated protected boolean isRequiredBoolean()
Deprecated.since v23.3, generated classes will be removed in v24.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
@Deprecated protected void setRequired(boolean required)
Deprecated.since v23.3, generated classes will be removed in v24.Description copied from corresponding location in WebComponent:
Specifies that the user must fill in a value.
- Parameters:
required
- the boolean value to set
-
isInvalidBoolean
@Deprecated protected boolean isInvalidBoolean()
Deprecated.since v23.3, generated classes will be removed in v24.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
@Deprecated protected void setInvalid(boolean invalid)
Deprecated.since v23.3, generated classes will be removed in v24.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
@Deprecated @NotSupported protected void validate()
Deprecated.since v23.3, generated classes will be removed in v24.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
@Deprecated protected Registration addInvalidChangeListener(ComponentEventListener<GeneratedVaadinCheckboxGroup.InvalidChangeEvent<R>> listener)
Deprecated.since v23.3, generated classes will be removed in v24.Adds a listener forinvalid-changed
events fired by the webcomponent.- Parameters:
listener
- the listener- Returns:
- a
Registration
for removing the event listener
-
-