Package org.dellroad.stuff.vaadin24.field

Annotation Interface FieldBuilder.ComboBox

Enclosing class:

FieldBuilder<T>

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

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

See Also:

• FieldBuilder
• ComboBox

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.
ComboBoxVariant[]	addThemeVariants	Add the specified theme variants.
boolean	allowCustomValue	Get the value desired for the allowCustomValue property.
String	allowedCharPattern	Get the value desired for the allowedCharPattern property.
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	autoOpen	Get the value desired for the autoOpen property.
boolean	clearButtonVisible	Get the value desired for the clearButtonVisible 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 ComboBox>	implementation	Get the sub-type of ComboBox that will edit the 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	opened	Get the value desired for the opened property.
String	overlayClassName	Get the value desired for the overlayClassName property.
String	overlayWidth	Get the value desired for the overlayWidth property.
int	pageSize	Get the value desired for the pageSize property.
String	pattern	Get the value desired for the pattern property.
String	placeholder	Get the value desired for the placeholder property.
Class<? extends Component>	prefixComponent	Get the class to instantiate for the prefixComponent property.
boolean	readOnly	Get the value desired for the readOnly property.
Class<? extends Renderer>	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.
String[]	styleProperties	Specify CSS properties to be set via Style.set().
int	tabIndex	Get the value desired for the tabIndex 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 ComboBox> implementation

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

{}

allowCustomValue

boolean allowCustomValue

Get the value desired for the allowCustomValue property.

Returns:

desired allowCustomValue property value

See Also:

• ComboBoxBase.setAllowCustomValue(boolean)

Default:

false

allowedCharPattern

String allowedCharPattern

Get the value desired for the allowedCharPattern property.

Returns:

desired allowedCharPattern property value

See Also:

• HasAllowedCharPattern.setAllowedCharPattern(String)

Default:

""

ariaLabel

String ariaLabel

Get the value desired for the ariaLabel property.

Returns:

desired ariaLabel property value

See Also:

• ComboBoxBase.setAriaLabel(String)

Default:

""

ariaLabelledBy

String ariaLabelledBy

Get the value desired for the ariaLabelledBy property.

Returns:

desired ariaLabelledBy property value

See Also:

• ComboBoxBase.setAriaLabelledBy(String)

Default:

""

autoOpen

boolean autoOpen

Get the value desired for the autoOpen property.

Returns:

desired autoOpen property value

See Also:

• HasAutoOpen.setAutoOpen(boolean)

Default:

true

autofocus

boolean autofocus

Get the value desired for the autofocus property.

Returns:

desired autofocus property value

See Also:

• ComboBoxBase.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:

{}

clearButtonVisible

boolean clearButtonVisible

Get the value desired for the clearButtonVisible property.

Returns:

desired clearButtonVisible property value

See Also:

• HasClearButton.setClearButtonVisible(boolean)

Default:

false

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:

""

itemLabelGenerator

Class<? extends ItemLabelGenerator> itemLabelGenerator

Get the class to instantiate for the itemLabelGenerator property.

Returns:

desired itemLabelGenerator property value type

See Also:

• ComboBoxBase.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:

• ComboBoxBase.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:

• HasLabel.setLabel(String)

Default:

""

manualValidation

boolean manualValidation

Get the value desired for the manualValidation property.

Returns:

desired manualValidation property value

See Also:

• ComboBoxBase.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:

""

opened

boolean opened

Get the value desired for the opened property.

Returns:

desired opened property value

See Also:

• ComboBoxBase.setOpened(boolean)

Default:

false

overlayClassName

String overlayClassName

Get the value desired for the overlayClassName property.

Returns:

desired overlayClassName property value

See Also:

• HasOverlayClassName.setOverlayClassName(String)

Default:

""

overlayWidth

String overlayWidth

Get the value desired for the overlayWidth property.

Returns:

desired overlayWidth property value

See Also:

• ComboBox.setOverlayWidth(String)

Default:

""

pageSize

int pageSize

Get the value desired for the pageSize property.

Returns:

desired pageSize property value

See Also:

• ComboBoxBase.setPageSize(int)

Default:

50

pattern

String pattern

Get the value desired for the pattern property.

Returns:

desired pattern property value

See Also:

• ComboBox.setPattern(String)

Default:

""

placeholder

String placeholder

Get the value desired for the placeholder property.

Returns:

desired placeholder property value

See Also:

• HasPlaceholder.setPlaceholder(String)

Default:

""

prefixComponent

Class<? extends Component> prefixComponent

Get the class to instantiate for the prefixComponent property.

Returns:

desired prefixComponent property value type

See Also:

• HasPrefix.setPrefixComponent(com.vaadin.flow.component.Component)

Default:

com.vaadin.flow.component.Component.class

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 Renderer> renderer

Get the class to instantiate for the renderer property.

Returns:

desired renderer property value type

See Also:

• ComboBoxBase.setRenderer(com.vaadin.flow.data.renderer.Renderer)

Default:

com.vaadin.flow.data.renderer.Renderer.class

required

boolean required

Get the value desired for the required property.

Returns:

desired required property value

See Also:

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

tabIndex

int tabIndex

Get the value desired for the tabIndex property.

Returns:

desired tabIndex property value

See Also:

• Focusable.setTabIndex(int)

Default:

0

addThemeNames

String[] addThemeNames

Add the specified theme names.

Returns:

zero or more theme names to add

See Also:

• HasTheme.addThemeNames(String[])

Default:

{}

addThemeVariants

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

""