com.vaadin.flow.component.radiobutton

Class RadioButtonGroup<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.radiobutton.GeneratedVaadinRadioGroup<RadioButtonGroup<T>,T>

com.vaadin.flow.component.radiobutton.RadioButtonGroup<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.HasStyle, com.vaadin.flow.component.HasTheme, com.vaadin.flow.component.HasValidation, com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<RadioButtonGroup<T>,T>,T>, com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<RadioButtonGroup<T>,T>,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<T>, com.vaadin.flow.data.selection.SingleSelect<RadioButtonGroup<T>,T>, Serializable

@NpmPackage(value="@vaadin/vaadin-radio-button",
            version="1.6.3")
public class RadioButtonGroup<T>
extends GeneratedVaadinRadioGroup<RadioButtonGroup<T>,T>
implements com.vaadin.flow.data.binder.HasItemsAndComponents<T>, com.vaadin.flow.data.selection.SingleSelect<RadioButtonGroup<T>,T>, com.vaadin.flow.data.binder.HasDataProvider<T>, com.vaadin.flow.component.HasValidation, com.vaadin.flow.component.HasHelper, com.vaadin.flow.component.HasLabel, com.vaadin.flow.data.binder.HasValidator<T>, HasClientValidation

A single select component using radio buttons as options.

This is a server side Java integration for the vaadin-radio-group element.

Usage examples, see the demo in vaadin.com.

Author:

Vaadin Ltd.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.flow.component.radiobutton.GeneratedVaadinRadioGroup

GeneratedVaadinRadioGroup.InvalidChangeEvent<R extends GeneratedVaadinRadioGroup<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
RadioButtonGroup()

Method Summary

Modifier and Type	Method and Description
com.vaadin.flow.shared.Registration	addValidationStatusChangeListener(com.vaadin.flow.data.binder.ValidationStatusChangeListener<T> listener)
com.vaadin.flow.data.provider.DataProvider<T,?>	getDataProvider() Gets the data provider.
String	getErrorMessage() Gets the current error message from the radio button group.
com.vaadin.flow.function.SerializablePredicate<T>	getItemEnabledProvider() Returns the item enabled predicate.
com.vaadin.flow.data.renderer.ComponentRenderer<? extends com.vaadin.flow.component.Component,T>	getItemRenderer() Returns the item component renderer.
String	getLabel() String used for the label element.
protected boolean	hasValidValue()
protected boolean	isEnforcedFieldValidationEnabled()
boolean	isInvalid()
boolean	isReadOnly()
boolean	isRequired() Specifies that the user must select a value
protected void	onAttach(com.vaadin.flow.component.AttachEvent attachEvent)
protected void	onDetach(com.vaadin.flow.component.DetachEvent detachEvent)
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 radio button group.
void	setLabel(String label) Sets the label for the field.
void	setReadOnly(boolean readOnly)
void	setRenderer(com.vaadin.flow.data.renderer.ComponentRenderer<? extends com.vaadin.flow.component.Component,T> renderer) Sets the item renderer for this radio button group.
void	setRequired(boolean required) Specifies that the user must select in a value.
void	setValue(T value)
protected void	validate() Description copied from corresponding location in WebComponent:

Methods inherited from class com.vaadin.flow.component.radiobutton.GeneratedVaadinRadioGroup

addInvalidChangeListener, addThemeVariants, checkValidity, getErrorMessageString, getLabelString, isDisabledBoolean, isInvalidBoolean, isReadonlyBoolean, isRequiredBoolean, removeThemeVariants, setDisabled, setReadonly

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

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, 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.HasValueAndElement

isRequiredIndicatorVisible, setRequiredIndicatorVisible

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

addValueChangeListener, clear, getEmptyValue, getOptionalValue, getValue, 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

RadioButtonGroup

public RadioButtonGroup()

Method Detail

hasValidValue

protected boolean hasValidValue()

Overrides:

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

setDataProvider

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

Specified by:

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

setValue

public void setValue(T value)

Specified by:

setValue in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<RadioButtonGroup<T>,T>,T>

Overrides:

setValue in class com.vaadin.flow.component.AbstractField<RadioButtonGroup<T>,T>

onAttach

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

Overrides:

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

onDetach

protected void onDetach(com.vaadin.flow.component.DetachEvent detachEvent)

Overrides:

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

getDataProvider

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

Gets the data provider.

Returns:

the data provider, not null

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 radio button 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

getItemRenderer

public com.vaadin.flow.data.renderer.ComponentRenderer<? extends com.vaadin.flow.component.Component,T> getItemRenderer()

Returns the item component renderer.

Returns:

the item renderer

See Also:

setRenderer(ComponentRenderer)

setRenderer

public void setRenderer(com.vaadin.flow.data.renderer.ComponentRenderer<? extends com.vaadin.flow.component.Component,T> renderer)

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

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

Parameters:

renderer - the item renderer, 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<RadioButtonGroup<T>,T>,T>

Specified by:

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

isReadOnly

public boolean isReadOnly()

Specified by:

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

Specified by:

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

setRequired

public void setRequired(boolean required)

Specifies that the user must select in a value.

NOTE: The required indicator will not be visible, if there is no label property set for the radiobutton group.

Overrides:

setRequired in class GeneratedVaadinRadioGroup<RadioButtonGroup<T>,T>

Parameters:

required - the boolean value to set

isRequired

public boolean isRequired()

Specifies that the user must select 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

setErrorMessage

public void setErrorMessage(String errorMessage)

Description copied from class: GeneratedVaadinRadioGroup

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 GeneratedVaadinRadioGroup<RadioButtonGroup<T>,T>

Parameters:

errorMessage - the String value to set

getErrorMessage

public String getErrorMessage()

Gets the current error message from the radio button group.

Specified by:

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

Returns:

the current error message

setLabel

public void setLabel(String label)

Sets the label for the field.

Specified by:

setLabel in interface com.vaadin.flow.component.HasLabel

Overrides:

setLabel in class GeneratedVaadinRadioGroup<RadioButtonGroup<T>,T>

Parameters:

label - value for the label property in the webcomponent

getLabel

public String getLabel()

String used for the label element.

Specified by:

getLabel in interface com.vaadin.flow.component.HasLabel

Returns:

the label property from the webcomponent

isInvalid

public boolean isInvalid()

Specified by:

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

setInvalid

public void setInvalid(boolean invalid)

Description copied from class: GeneratedVaadinRadioGroup

Description copied from corresponding location in WebComponent:

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

Specified by:

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

Overrides:

setInvalid in class GeneratedVaadinRadioGroup<RadioButtonGroup<T>,T>

Parameters:

invalid - the boolean value to set

validate

protected void validate()

Description copied from class: GeneratedVaadinRadioGroup

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 GeneratedVaadinRadioGroup<RadioButtonGroup<T>,T>

addValidationStatusChangeListener

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

Specified by:

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

isEnforcedFieldValidationEnabled

protected boolean isEnforcedFieldValidationEnabled()