Package org.dellroad.stuff.vaadin24.field

Annotation Interface AbstractFieldBuilder.Binding

Enclosing class:

AbstractFieldBuilder<S extends AbstractFieldBuilder<S,T>,T>

@Retention(RUNTIME)
@Target(METHOD)
@Documented
public static @interface AbstractFieldBuilder.Binding

Specifies properties of the Binder binding itself.

Properties correspond to methods in Binder.BindingBuilder.

Note: When it comes to Converters, Validators, and nullRepresentation(), the order in which these items are added to the binding matters. These items are chained together in sequence between the field and the model.

For example, the standard Binder.BindingBuilder methods such as withConverter() always add new items to the "model" side of the chain, so that (for example) each Converter added will take as its "presentation" value the previous Converter's "model" value.

This annotation builds the binding by applying its configuration in the following order, going from the field's presentation value to the data bean's model value:

1. Implicit validation by ValidatingFields
2. requiredValidator(), requiredProvider(), or required()
3. nullRepresentation()
4. converter()
5. validators() (in the order given)
6. postValidationConverter()

Therefore, each item in the list should assume all previous items in list have already "seen" the field's value. In particular, if both a converter() and one or more validators() are configured, then the Validators will validate the converted model values, not the presentation values.

To get the reverse behavior, i.e., to validate presentation values instead of model values, configure the Converter using postValidationConverter() instead of converter().

See Also:

• FieldBuilder.bindFields()

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
Class<? extends Converter>	converter	Get the converter class to be applied before any validators() are applied.
String	nullRepresentation	Get the null representation.
Class<? extends Converter>	postValidationConverter	Get the converter class to be applied after any validators() are applied.
String	required	Get "as required" error message.
Class<? extends ErrorMessageProvider>	requiredProvider	Get "as required" error message provider class.
Class<? extends Validator>	requiredValidator	Get "as required" validator class.
Class<? extends BindingValidationStatusHandler>	validationStatusHandler	Get the validation status handler class.
Class<? extends Validator>[]	validators	Get the validator class(es).

Element Details

required

String required

Get "as required" error message.

Only one of this property, requiredProvider(), or requiredValidator() should be set.

Returns:

"as required" error message

See Also:

• Binder.BindingBuilder.asRequired(String)

Default:

""

requiredProvider

Class<? extends ErrorMessageProvider> requiredProvider

Get "as required" error message provider class.

Only one of this property, required(), or requiredValidator() should be set.

Returns:

"as required" error message provider class

See Also:

• Binder.BindingBuilder.asRequired(ErrorMessageProvider)

Default:

com.vaadin.flow.data.binder.ErrorMessageProvider.class

requiredValidator

Class<? extends Validator> requiredValidator

Get "as required" validator class.

Only one of this property, required(), or requiredProvider() should be set.

Returns:

"as required" error message provider class

See Also:

• Binder.BindingBuilder.asRequired(Validator)

Default:

com.vaadin.flow.data.binder.Validator.class

converter

Class<? extends Converter> converter

Get the converter class to be applied before any validators() are applied.

Returns:

converter class

See Also:

• Binder.BindingBuilder.withConverter(Converter)

Default:

com.vaadin.flow.data.converter.Converter.class

postValidationConverter

Class<? extends Converter> postValidationConverter

Get the converter class to be applied after any validators() are applied.

Returns:

converter class

See Also:

• Binder.BindingBuilder.withConverter(Converter)

Default:

com.vaadin.flow.data.converter.Converter.class

nullRepresentation

String nullRepresentation

Get the null representation.

This property only works for fields that represent a String value, such as TextField.

Note: Do not combine this with @FieldBuilder.NullifyCheckbox or NullableField. That would mean the NullableField could never be set to null, which defeats its purpose.

Note: the default value is just a placeholder, indicating that no null representation should be configured.

Returns:

null representation

See Also:

• Binder.BindingBuilder.withNullRepresentation(TARGET)

Default:

"<FieldBuilderStringDefault>"

validationStatusHandler

Class<? extends BindingValidationStatusHandler> validationStatusHandler

Get the validation status handler class.

Returns:

validation status handler class

See Also:

• Binder.BindingBuilder.withValidationStatusHandler(com.vaadin.flow.data.binder.BindingValidationStatusHandler)

Default:

com.vaadin.flow.data.binder.BindingValidationStatusHandler.class

validators

Class<? extends Validator>[] validators

Get the validator class(es).

Returns:

zero or more validator classes

See Also:

• Binder.BindingBuilder.withValidator(Validator)

Default:

{}