Annotation Interface FieldBuilder.Checkbox

Enclosing class:

FieldBuilder<T>

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

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

See Also:

• FieldBuilder
• Checkbox

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.
CheckboxVariant[]	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.
boolean	autofocus	Get the value desired for the autofocus 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.
Class<? extends Checkbox.CheckboxI18n>	i18n	Get the class to instantiate for the i18n property.
String	id	Get the value desired for the id property.
Class<? extends Checkbox>	implementation	Get the sub-type of Checkbox that will edit the property.
boolean	indeterminate	Get the value desired for the indeterminate property.
String	label	Get the value desired for the label property.
Class<? extends Component>	labelComponent	Get the class to instantiate for the labelComponent 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.
boolean	requiredIndicatorVisible	Get the value desired for the requiredIndicatorVisible property.
String[]	styleProperties	Specify CSS properties to be set via Style.set().
int	tabIndex	Get the value desired for the tabIndex property.
String	testId	Get the value desired for the testId property.
String	tooltipMarkdown	Get the value desired for the tooltipMarkdown property.
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 Checkbox> implementation

Get the sub-type of Checkbox 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.Checkbox.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:

• Checkbox.setAriaLabel(String)

Default:

""

ariaLabelledBy

String ariaLabelledBy

Get the value desired for the ariaLabelledBy property.

Returns:

desired ariaLabelledBy property value

See Also:

• Checkbox.setAriaLabelledBy(String)

Default:

""

autofocus

boolean autofocus

Get the value desired for the autofocus property.

Returns:

desired autofocus property value

See Also:

• Checkbox.setAutofocus(boolean)

Default:

false

addClassNames

String[] addClassNames

Add the specified class names.

Returns:

zero or more class names to add

See Also:

• HasStyle.addClassNames(String[])

Default:

{}

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:

""

i18n

Class<? extends Checkbox.CheckboxI18n> i18n

Get the class to instantiate for the i18n property.

Returns:

desired i18n property value type

See Also:

• Checkbox.setI18n(com.vaadin.flow.component.checkbox.Checkbox.CheckboxI18n)

Default:

com.vaadin.flow.component.checkbox.Checkbox.CheckboxI18n.class

id

String id

Get the value desired for the id property.

Returns:

desired id property value

See Also:

• Component.setId(String)

Default:

""

indeterminate

boolean indeterminate

Get the value desired for the indeterminate property.

Returns:

desired indeterminate property value

See Also:

• Checkbox.setIndeterminate(boolean)

Default:

false

label

String label

Get the value desired for the label property.

Returns:

desired label property value

See Also:

• Checkbox.setLabel(String)

Default:

""

labelComponent

Class<? extends Component> labelComponent

Get the class to instantiate for the labelComponent property.

Returns:

desired labelComponent property value type

See Also:

• Checkbox.setLabelComponent(com.vaadin.flow.component.Component)

Default:

com.vaadin.flow.component.Component.class

manualValidation

boolean manualValidation

Get the value desired for the manualValidation property.

Returns:

desired manualValidation property value

See Also:

• Checkbox.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

requiredIndicatorVisible

boolean requiredIndicatorVisible

Get the value desired for the requiredIndicatorVisible property.

Returns:

desired requiredIndicatorVisible property value

See Also:

• Checkbox.setRequiredIndicatorVisible(boolean)

Default:

false

tabIndex

int tabIndex

Get the value desired for the tabIndex property.

Returns:

desired tabIndex property value

See Also:

• Focusable.setTabIndex(int)

Default:

0

testId

String testId

Get the value desired for the testId property.

Returns:

desired testId property value

See Also:

• Component.setTestId(String)

Default:

""

addThemeNames

String[] addThemeNames

Add the specified theme names.

Returns:

zero or more theme names to add

See Also:

• HasTheme.addThemeNames(String[])

Default:

{}

addThemeVariants

CheckboxVariant[] 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:

{}

tooltipMarkdown

String tooltipMarkdown

Get the value desired for the tooltipMarkdown property.

Returns:

desired tooltipMarkdown property value

See Also:

• HasTooltip.setTooltipMarkdown(String)

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:

""