com.vaadin.flow.data.binder

Annotation Type PropertyId

@Target(value=FIELD)
 @Retention(value=RUNTIME)
public @interface PropertyId

Defines the custom property name to be bound to a field component using Binder.

The automatic data binding in Binder relies on a naming convention by default: properties of an item are bound to similarly named field components in given a editor object. If you want to map a property with a different name (ID) to a HasValue, you can use this annotation for the member fields, with the name (ID) of the desired property as the parameter.

In following usage example, the text field would be bound to property "foo" in the Entity class.

 class Editor extends FormLayout {
     @PropertyId("foo")
     TextField myField = new TextField();
 }

 class Entity {
     String foo;
 }

 {
     Editor editor = new Editor();
     Binder<Entity> binder = new Binder(Entity.class);
     binder.bindInstanceFields(editor);
 }
 

Since:

1.0

Author:

Vaadin Ltd

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value Returns the name of the property.

Element Detail

value

public abstract String value

Returns the name of the property.

Returns:

the proeprty name