Package org.dellroad.stuff.vaadin24.field

Annotation Interface FieldBuilder.Input

Enclosing class:

FieldBuilder<T>

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

Specifies how a Java bean property should be edited using an Input.

See Also:

• FieldBuilder
• Input

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String[]	addClassNames	Add the specified class names.
String	ariaLabel	Get the value desired for the ariaLabel property.
String	ariaLabelledBy	Get the value desired for the ariaLabelledBy property.
boolean	enabled	Get the value desired for the enabled property.
String	height	Get the value desired for the height property.
String	id	Get the value desired for the id property.
Class<? extends Input>	implementation	Get the sub-type of Input that will edit the 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.
String	placeholder	Get the value desired for the placeholder 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	type	Get the value desired for the type property.
ValueChangeMode	valueChangeMode	Get the value desired for the valueChangeMode property.
int	valueChangeTimeout	Get the value desired for the valueChangeTimeout 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 Input> implementation

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

• HasAriaLabel.setAriaLabel(String)

Default:

""

ariaLabelledBy

String ariaLabelledBy

Get the value desired for the ariaLabelledBy property.

Returns:

desired ariaLabelledBy property value

See Also:

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

{}

enabled

boolean enabled

Get the value desired for the enabled property.

Returns:

desired enabled property value

See Also:

• HasEnabled.setEnabled(boolean)

Default:

true

height

String height

Get the value desired for the height property.

Returns:

desired height property value

See Also:

• HasSize.setHeight(String)

Default:

""

id

String id

Get the value desired for the id property.

Returns:

desired id property value

See Also:

• Component.setId(String)

Default:

""

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:

""

placeholder

String placeholder

Get the value desired for the placeholder property.

Returns:

desired placeholder property value

See Also:

• Input.setPlaceholder(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:

• 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

type

String type

Get the value desired for the type property.

Returns:

desired type property value

See Also:

• Input.setType(String)

Default:

"text"

valueChangeMode

ValueChangeMode valueChangeMode

Get the value desired for the valueChangeMode property.

Returns:

desired valueChangeMode property value

See Also:

• Input.setValueChangeMode(com.vaadin.flow.data.value.ValueChangeMode)

Default:

ON_CHANGE

valueChangeTimeout

int valueChangeTimeout

Get the value desired for the valueChangeTimeout property.

Returns:

desired valueChangeTimeout property value

See Also:

• Input.setValueChangeTimeout(int)

Default:

400

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:

""