Package org.dellroad.stuff.vaadin24.field

Annotation Interface FieldBuilder.CheckboxGroup

Enclosing class:

FieldBuilder<T>

@Retention(RUNTIME)
@Target(METHOD)
@Documented
public static @interface FieldBuilder.CheckboxGroup

Specifies how a Java bean property should be edited using a CheckboxGroup.

See Also:

• FieldBuilder
• CheckboxGroup

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String[]	addClassNames	Add the specified class names.
String[]	addThemeNames	Add the specified theme names.
CheckboxGroupVariant[]	addThemeVariants	Add the specified theme variants.
String	ariaLabel	Get the value desired for the ariaLabel property.
String	ariaLabelledBy	Get the value desired for the ariaLabelledBy property.
Class<? extends DataProvider>	dataProvider	Get the class to instantiate for the dataProvider property.
boolean	enabled	Get the value desired for the enabled property.
String	errorMessage	Get the value desired for the errorMessage property.
String	height	Get the value desired for the height property.
Class<? extends Component>	helperComponent	Get the class to instantiate for the helperComponent property.
String	helperText	Get the value desired for the helperText property.
String	id	Get the value desired for the id property.
Class<? extends CheckboxGroup>	implementation	Get the sub-type of CheckboxGroup that will edit the property.
Class<? extends SerializablePredicate>	itemEnabledProvider	Get the class to instantiate for the itemEnabledProvider property.
Class<? extends CheckboxGroup.ItemHelperGenerator>	itemHelperGenerator	Get the class to instantiate for the itemHelperGenerator property.
Class<? extends ItemLabelGenerator>	itemLabelGenerator	Get the class to instantiate for the itemLabelGenerator property.
Class<? extends DataProvider>	items	Get the class to instantiate for the items property.
String	label	Get the value desired for the label property.
boolean	manualValidation	Get the value desired for the manualValidation property.
String	maxHeight	Get the value desired for the maxHeight property.
String	maxWidth	Get the value desired for the maxWidth property.
String	minHeight	Get the value desired for the minHeight property.
String	minWidth	Get the value desired for the minWidth property.
boolean	readOnly	Get the value desired for the readOnly property.
Class<? extends ComponentRenderer>	renderer	Get the class to instantiate for the renderer property.
boolean	required	Get the value desired for the required property.
boolean	requiredIndicatorVisible	Get the value desired for the requiredIndicatorVisible property.
SelectionPreservationMode	selectionPreservationMode	Get the value desired for the selectionPreservationMode property.
String[]	styleProperties	Specify CSS properties to be set via Style.set().
String	tooltipText	Get the value desired for the tooltipText property.
boolean	visible	Get the value desired for the visible property.
String	width	Get the value desired for the width property.

Element Details

implementation

Class<? extends CheckboxGroup> implementation

Get the sub-type of CheckboxGroup that will edit the property.

This property allows custom widget subclasses to be used.

The specified type must have a public constructor that takes either no arguments, or one FieldBuilderContext.

Returns:

field type

Default:

com.vaadin.flow.component.checkbox.CheckboxGroup.class

styleProperties

String[] styleProperties

Specify CSS properties to be set via Style.set().

The array value consists of name, value pairs. If the array has odd length, the last element is ignored.

Returns:

zero or more style property name, value pairs

See Also:

• Style
• HasStyle

Default:

{}

ariaLabel

String ariaLabel

Get the value desired for the ariaLabel property.

Returns:

desired ariaLabel property value

See Also:

• CheckboxGroup.setAriaLabel(String)

Default:

""

ariaLabelledBy

String ariaLabelledBy

Get the value desired for the ariaLabelledBy property.

Returns:

desired ariaLabelledBy property value

See Also:

• CheckboxGroup.setAriaLabelledBy(String)

Default:

""

addClassNames

String[] addClassNames

Add the specified class names.

Returns:

zero or more class names to add

See Also:

• HasStyle.addClassNames(String[])

Default:

{}

dataProvider

Class<? extends DataProvider> dataProvider

Get the class to instantiate for the dataProvider property.

Returns:

desired dataProvider property value type

See Also:

• CheckboxGroup.setDataProvider(com.vaadin.flow.data.provider.DataProvider)

Default:

com.vaadin.flow.data.provider.DataProvider.class

enabled

boolean enabled

Get the value desired for the enabled property.

Returns:

desired enabled property value

See Also:

• HasEnabled.setEnabled(boolean)

Default:

true

errorMessage

String errorMessage

Get the value desired for the errorMessage property.

Returns:

desired errorMessage property value

See Also:

• HasValidationProperties.setErrorMessage(String)

Default:

""

height

String height

Get the value desired for the height property.

Returns:

desired height property value

See Also:

• HasSize.setHeight(String)

Default:

""

helperComponent

Class<? extends Component> helperComponent

Get the class to instantiate for the helperComponent property.

Returns:

desired helperComponent property value type

See Also:

• HasHelper.setHelperComponent(com.vaadin.flow.component.Component)

Default:

com.vaadin.flow.component.Component.class

helperText

String helperText

Get the value desired for the helperText property.

Returns:

desired helperText property value

See Also:

• HasHelper.setHelperText(String)

Default:

""

id

String id

Get the value desired for the id property.

Returns:

desired id property value

See Also:

• Component.setId(String)

Default:

""

itemEnabledProvider

Class<? extends SerializablePredicate> itemEnabledProvider

Get the class to instantiate for the itemEnabledProvider property.

Returns:

desired itemEnabledProvider property value type

See Also:

• CheckboxGroup.setItemEnabledProvider(com.vaadin.flow.function.SerializablePredicate)

Default:

com.vaadin.flow.function.SerializablePredicate.class

itemHelperGenerator

Class<? extends CheckboxGroup.ItemHelperGenerator> itemHelperGenerator

Get the class to instantiate for the itemHelperGenerator property.

Returns:

desired itemHelperGenerator property value type

See Also:

• CheckboxGroup.setItemHelperGenerator(com.vaadin.flow.component.checkbox.CheckboxGroup.ItemHelperGenerator)

Default:

com.vaadin.flow.component.checkbox.CheckboxGroup.ItemHelperGenerator.class

itemLabelGenerator

Class<? extends ItemLabelGenerator> itemLabelGenerator

Get the class to instantiate for the itemLabelGenerator property.

Returns:

desired itemLabelGenerator property value type

See Also:

• CheckboxGroup.setItemLabelGenerator(com.vaadin.flow.component.ItemLabelGenerator)

Default:

com.vaadin.flow.component.ItemLabelGenerator.class

items

Class<? extends DataProvider> items

Get the class to instantiate for the items property.

Returns:

desired items property value type

See Also:

• CheckboxGroup.setItems(com.vaadin.flow.data.provider.DataProvider)

Default:

com.vaadin.flow.data.provider.DataProvider.class

label

String label

Get the value desired for the label property.

Returns:

desired label property value

See Also:

• CheckboxGroup.setLabel(String)

Default:

""

manualValidation

boolean manualValidation

Get the value desired for the manualValidation property.

Returns:

desired manualValidation property value

See Also:

• CheckboxGroup.setManualValidation(boolean)

Default:

false

maxHeight

String maxHeight

Get the value desired for the maxHeight property.

Returns:

desired maxHeight property value

See Also:

• HasSize.setMaxHeight(String)

Default:

""

maxWidth

String maxWidth

Get the value desired for the maxWidth property.

Returns:

desired maxWidth property value

See Also:

• HasSize.setMaxWidth(String)

Default:

""

minHeight

String minHeight

Get the value desired for the minHeight property.

Returns:

desired minHeight property value

See Also:

• HasSize.setMinHeight(String)

Default:

""

minWidth

String minWidth

Get the value desired for the minWidth property.

Returns:

desired minWidth property value

See Also:

• HasSize.setMinWidth(String)

Default:

""

readOnly

boolean readOnly

Get the value desired for the readOnly property.

Returns:

desired readOnly property value

See Also:

• HasValueAndElement.setReadOnly(boolean)

Default:

false

renderer

Class<? extends ComponentRenderer> renderer

Get the class to instantiate for the renderer property.

Returns:

desired renderer property value type

See Also:

• CheckboxGroup.setRenderer(com.vaadin.flow.data.renderer.ComponentRenderer)

Default:

com.vaadin.flow.data.renderer.ComponentRenderer.class

required

boolean required

Get the value desired for the required property.

Returns:

desired required property value

See Also:

• CheckboxGroup.setRequired(boolean)

Default:

false

requiredIndicatorVisible

boolean requiredIndicatorVisible

Get the value desired for the requiredIndicatorVisible property.

Returns:

desired requiredIndicatorVisible property value

See Also:

• HasValueAndElement.setRequiredIndicatorVisible(boolean)

Default:

false

selectionPreservationMode

SelectionPreservationMode selectionPreservationMode

Get the value desired for the selectionPreservationMode property.

Returns:

desired selectionPreservationMode property value

See Also:

• CheckboxGroup.setSelectionPreservationMode(com.vaadin.flow.component.shared.SelectionPreservationMode)

Default:

DISCARD

addThemeNames

String[] addThemeNames

Add the specified theme names.

Returns:

zero or more theme names to add

See Also:

• HasTheme.addThemeNames(String[])

Default:

{}

addThemeVariants

CheckboxGroupVariant[] addThemeVariants

Add the specified theme variants.

Returns:

zero or more theme variants to add

See Also:

• HasThemeVariant.addThemeVariants(com.vaadin.flow.component.shared.ThemeVariant[])

Default:

{}

tooltipText

String tooltipText

Get the value desired for the tooltipText property.

Returns:

desired tooltipText property value

See Also:

• HasTooltip.setTooltipText(String)

Default:

""

visible

boolean visible

Get the value desired for the visible property.

Returns:

desired visible property value

See Also:

• Component.setVisible(boolean)

Default:

true

width

String width

Get the value desired for the width property.

Returns:

desired width property value

See Also:

• HasSize.setWidth(String)

Default:

""