Package org.dellroad.stuff.vaadin24.field

Annotation Interface FieldBuilder.TextField

Enclosing class:

FieldBuilder<T>

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

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

See Also:

• FieldBuilder
• TextField

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.
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.
Autocapitalize	autocapitalize	Get the value desired for the autocapitalize property.
Autocomplete	autocomplete	Get the value desired for the autocomplete property.
boolean	autocorrect	Get the value desired for the autocorrect property.
boolean	autofocus	Get the value desired for the autofocus property.
boolean	autoselect	Get the value desired for the autoselect 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 TextField>	implementation	Get the sub-type of TextField that will edit the 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.
int	maxLength	Get the value desired for the maxLength property.
String	maxWidth	Get the value desired for the maxWidth property.
String	minHeight	Get the value desired for the minHeight property.
int	minLength	Get the value desired for the minLength property.
String	minWidth	Get the value desired for the minWidth 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.
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().
Class<? extends Component>	suffixComponent	Get the class to instantiate for the suffixComponent property.
int	tabIndex	Get the value desired for the tabIndex property.
String	title	Get the value desired for the title property.
String	tooltipText	Get the value desired for the tooltipText 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 TextField> implementation

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

{}

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:

• TextFieldBase.setAriaLabel(String)

Default:

""

ariaLabelledBy

String ariaLabelledBy

Get the value desired for the ariaLabelledBy property.

Returns:

desired ariaLabelledBy property value

See Also:

• TextFieldBase.setAriaLabelledBy(String)

Default:

""

autocapitalize

Autocapitalize autocapitalize

Get the value desired for the autocapitalize property.

Returns:

desired autocapitalize property value

See Also:

• HasAutocapitalize.setAutocapitalize(com.vaadin.flow.component.textfield.Autocapitalize)

Default:

NONE

autocomplete

Autocomplete autocomplete

Get the value desired for the autocomplete property.

Returns:

desired autocomplete property value

See Also:

• HasAutocomplete.setAutocomplete(com.vaadin.flow.component.textfield.Autocomplete)

Default:

ON

autocorrect

boolean autocorrect

Get the value desired for the autocorrect property.

Returns:

desired autocorrect property value

See Also:

• HasAutocorrect.setAutocorrect(boolean)

Default:

false

autofocus

boolean autofocus

Get the value desired for the autofocus property.

Returns:

desired autofocus property value

See Also:

• TextFieldBase.setAutofocus(boolean)

Default:

false

autoselect

boolean autoselect

Get the value desired for the autoselect property.

Returns:

desired autoselect property value

See Also:

• TextFieldBase.setAutoselect(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:

""

label

String label

Get the value desired for the label property.

Returns:

desired label property value

See Also:

• TextFieldBase.setLabel(String)

Default:

""

manualValidation

boolean manualValidation

Get the value desired for the manualValidation property.

Returns:

desired manualValidation property value

See Also:

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

""

maxLength

int maxLength

Get the value desired for the maxLength property.

Returns:

desired maxLength property value

See Also:

• TextField.setMaxLength(int)

Default:

0

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:

""

minLength

int minLength

Get the value desired for the minLength property.

Returns:

desired minLength property value

See Also:

• TextField.setMinLength(int)

Default:

0

minWidth

String minWidth

Get the value desired for the minWidth property.

Returns:

desired minWidth property value

See Also:

• HasSize.setMinWidth(String)

Default:

""

pattern

String pattern

Get the value desired for the pattern property.

Returns:

desired pattern property value

See Also:

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

required

boolean required

Get the value desired for the required property.

Returns:

desired required property value

See Also:

• TextField.setRequired(boolean)

Default:

false

requiredIndicatorVisible

boolean requiredIndicatorVisible

Get the value desired for the requiredIndicatorVisible property.

Returns:

desired requiredIndicatorVisible property value

See Also:

• TextField.setRequiredIndicatorVisible(boolean)

Default:

false

suffixComponent

Class<? extends Component> suffixComponent

Get the class to instantiate for the suffixComponent property.

Returns:

desired suffixComponent property value type

See Also:

• HasSuffix.setSuffixComponent(com.vaadin.flow.component.Component)

Default:

com.vaadin.flow.component.Component.class

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:

{}

title

String title

Get the value desired for the title property.

Returns:

desired title property value

See Also:

• TextFieldBase.setTitle(String)

Default:

""

tooltipText

String tooltipText

Get the value desired for the tooltipText property.

Returns:

desired tooltipText property value

See Also:

• HasTooltip.setTooltipText(String)

Default:

""

valueChangeMode

ValueChangeMode valueChangeMode

Get the value desired for the valueChangeMode property.

Returns:

desired valueChangeMode property value

See Also:

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

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

""