org.dellroad.stuff.vaadin8.FieldBuilder Maven / Gradle / Ivy
Show all versions of dellroad-stuff-vaadin8 Show documentation
/*
* Copyright (C) 2022 Archie L. Cobbs. All rights reserved.
*/
package org.dellroad.stuff.vaadin8;
import com.vaadin.data.Binder;
import com.vaadin.data.BindingValidationStatusHandler;
import com.vaadin.data.Converter;
import com.vaadin.data.ErrorMessageProvider;
import com.vaadin.data.HasValue;
import com.vaadin.data.Validator;
import com.vaadin.data.provider.DataProvider;
import com.vaadin.data.provider.ListDataProvider;
import com.vaadin.server.SerializablePredicate;
import com.vaadin.shared.ui.ValueChangeMode;
import com.vaadin.shared.ui.datefield.DateResolution;
import com.vaadin.shared.ui.slider.SliderOrientation;
import com.vaadin.ui.Component;
import com.vaadin.ui.DescriptionGenerator;
import com.vaadin.ui.Grid;
import com.vaadin.ui.IconGenerator;
import com.vaadin.ui.ItemCaptionGenerator;
import java.beans.BeanInfo;
import java.beans.IntrospectionException;
import java.beans.Introspector;
import java.beans.PropertyDescriptor;
import java.io.Serializable;
import java.lang.annotation.Annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.lang.reflect.Method;
import java.lang.reflect.Modifier;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.HashMap;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.function.Predicate;
import org.dellroad.stuff.java.AnnotationUtil;
import org.dellroad.stuff.java.MethodAnnotationScanner;
import org.dellroad.stuff.java.ReflectUtil;
/**
* Automatically builds a {@link Binder} and configures and binds fields based on method annotations.
*
*
*
*
*
*
* {@link FieldBuilder} annotations allow for the automatic construction of forms for editing the annotated bean type.
* Annotations specify how bean properties should be edited in a form. As a result, all information about how to edit a Java
* type, including field customization such as captions, widths, etc., can be specified declaratively.
*
*
{@code @ProvidesField} vs. {@code @FieldBuilder.Foo}
*
* {@link FieldBuilder} supports two types of annotations that can tell it how to construct fields:
* the {@link ProvidesField @ProvidesField} annotates a method that knows how to build a {@link HasValue}
* widget suitable for editing the named bean property. This is the most general approach, but it requires adding code.
*
*
* The {@code @FieldBuilder.Foo} annotations are the purely declarative way to specify how to construct a field.
* These annotations annotate Java bean property getter methods, and specify how to configure a
* {@link HasValue} widget that will edit the annotated property. The annotations
* {@link FieldBuilder.AbstractComponent @FieldBuilder.AbstractComponent},
* {@link FieldBuilder.AbstractField @FieldBuilder.AbstractField}, {@link ComboBox @FieldBuilder.ComboBox}, etc.
* mirror to the Vaadin widget class hierarchy and configure the corresponding widget properties (separate annotations were
* used for each class in the hierarchy because Java doesn't allow annotation inheritance).
*
*
*
Configuring the Binding
*
* In addition to configuring the fields associated with each bean property in the {@link Binder}, you may also
* want to configure the bindings themselves, for example, to specify a {@link Converter} or {@link Validator}.
* The {@link FieldBuilder.Binding @FieldBuilder.Binding} annotation allows you to configure the
* binding, using properties relevant to {@link Binder.BindingBuilder}.
*
*
* {@link FieldBuilder.Binding @FieldBuilder.Binding} also allows you to specify the order in which
* the fields should appear in the form.
*
*
Example
*
* A simple example shows how these annotations are used:
*
* // Use a 10 row TextArea to edit the "description" property
* @FieldBuilder.AbstractComponent(caption = "Description:")
* @FieldBuilder.TextArea(rows = 10)
* @FieldBuilder.Binding(required = "Description is mandatory", validator = MyValidator.class)
* public String getDescription() {
* return this.description;
* }
*
* // Use an enum combo box to edit the gender property
* @FieldBuilder.EnumComboBox(caption = "Gender:")
* @FieldBuilder.Binding(required = "Gender is mandatory", order = 3.0)
* public Gender getGender() {
* return this.gender;
* }
*
* // Use my own custom field to edit the "foobar" property
* public Foobar getFoobar() { ... }
* public void setFoobar(Foobar foobar) { ... }
*
* @FieldBuilder.ProvidesField("foobar")
* private static MyCustomField createFoobarField() {
* ...
* }
*
*
* Building the Form
*
* Use {@link #buildAndBind FieldBuilder.buildAndBind()} to setup the {@link Binder}, and then add the bound
* fields to your form:
*
* // Create fields based on FieldBuilder.* annotations
* Binder<Person> binder = new FieldBuilder(Person.class).buildAndBind().getBinder();
*
* // Layout the fields in a form
* FormLayout layout = new FormLayout();
* layout.add((Component)binder.getBinding("description").get().getField());
* layout.add((Component)binder.getBinding("gender").get().getField());
* layout.add((Component)binder.getBinding("foobar").get().getField());
*
* // Bind a value
* Person person = new Person("Joe Smith", 100);
* binder.setBean(person);
*
*
*
*
* To use the generated fields as editor bindings for a {@link Grid}, see {@link #setEditorBindings}.
* For declarative configuration of {@link Grid} columns, see {@link GridColumn @GridColumn}.
*
* @param backing object type
* @see AbstractDateField
* @see AbstractTextField
* @see CheckBox
* @see CheckBoxGroup
* @see ComboBox
* @see DateField
* @see DateTimeField
* @see EnumComboBox
* @see InlineDateField
* @see ListSelect
* @see PasswordField
* @see RadioButtonGroup
* @see RichTextArea
* @see Slider
* @see TextArea
* @see TextField
* @see GridColumn
*/
public class FieldBuilder implements Serializable {
private static final String STRING_DEFAULT = "";
private static final long serialVersionUID = -4876472481099484174L;
private final Class type;
private final LinkedHashSet propertyNames = new LinkedHashSet<>();
private Binder binder;
/**
* Constructor.
*
* @param type backing object type
*/
public FieldBuilder(Class type) {
if (type == null)
throw new IllegalArgumentException("null type");
this.type = type;
}
/**
* Get the type associated with this instance.
*
* @return configured type
*/
public Class getType() {
return this.type;
}
/**
* Get the binder associated with this instance.
*
* @return binder
* @throws IllegalStateException if {@link #buildAndBind buildAndBind()} has not yet been invoked
*/
public Binder getBinder() {
if (this.binder == null)
throw new IllegalStateException("buildAndBind() not invoked yet");
return this.binder;
}
/**
* Get the names of all properties discovered and bound by the most recent invocation of {@link #buildAndBind buildAndBind()}.
*
*
* This will be the subset of all of the {@link Binder}'s properties containing those for which the getter method
* had {@link FieldBuilder @FieldBuilder} annotations.
*
*
* The returned {@link Set} will iterate fields in order by {@link Binding#order @FieldBuilder.Binding.order()} values,
* then by name.
*
* @return field names
* @throws IllegalStateException if {@link #buildAndBind buildAndBind()} has not yet been invoked
*/
public Set getPropertyNames() {
if (this.binder == null)
throw new IllegalStateException("buildAndBind() not invoked yet");
return Collections.unmodifiableSet(this.propertyNames);
}
/**
* Introspect for {@link FieldBuilder} annotations on getter methods of the configured class,
* and create and bind the corresponding fields.
*
*
* Note that non-static {@link ProvidesField @ProvidesField} annotations on instance methods are ignored, because
* there is no bean instance provided; use {@link #buildAndBind(Object)} instead of this method to include them.
*
* @return this instance
*/
public FieldBuilder buildAndBind() {
this.doBuildAndBind(null);
return this;
}
/**
* Introspect for {@link FieldBuilder} annotations on getter methods of the configured class,
* create and bind the corresponding fields, and set the given bean in the {@link Binder}.
*
* @param bean bean to introspect and bind
* @return this instance
* @throws IllegalArgumentException if {@code bean} is null
*/
public FieldBuilder buildAndBind(T bean) {
if (bean == null)
throw new IllegalArgumentException("null bean");
this.doBuildAndBind(bean);
binder.setBean(bean);
return this;
}
/**
* Set this instance's field bindings as the editor bindings for the corresponding columns in the given {@link Grid}.
*
*
* This method invokes {@link Grid.Column#setEditorBinding(Binder.Binding)} for each binding for which the {@link Grid}
* has a column whose column ID matches the binding property name.
*
* @param grid {@link Grid} for editor bindings
* @return this instance
* @throws IllegalStateException if {@link #buildAndBind buildAndBind()} has not yet been invoked
* @throws IllegalArgumentException if {@code grid} is null
* @see Grid.Column#setEditorBinding(Binder.Binding)
*/
public FieldBuilder setEditorBindings(Grid grid) {
if (this.binder == null)
throw new IllegalStateException("buildAndBind() not invoked yet");
if (grid == null)
throw new IllegalArgumentException("null grid");
for (String propertyName : this.propertyNames) {
final Grid.Column gridColumn = grid.getColumn(propertyName);
if (gridColumn == null)
continue;
this.binder.getBinding(propertyName).ifPresent(b -> gridColumn.setEditorBinding(b));
}
return this;
}
protected void doBuildAndBind(T bean) {
// Reset
this.binder = new Binder<>(this.type);
// Look for all bean property getter methods
BeanInfo beanInfo;
try {
beanInfo = Introspector.getBeanInfo(this.type);
} catch (IntrospectionException e) {
throw new RuntimeException("unexpected exception", e);
}
final HashMap getterMap = new HashMap<>(); // mapping from property name -> method
final HashMap inverseGetterMap = new HashMap<>(); // mapping from getter name -> property name
for (PropertyDescriptor propertyDescriptor : beanInfo.getPropertyDescriptors()) {
final Method method = this.workAroundIntrospectorBug(propertyDescriptor.getReadMethod());
// Add getter, if appropriate
if (method != null && method.getReturnType() != void.class && method.getParameterTypes().length == 0) {
getterMap.put(propertyDescriptor.getName(), method);
inverseGetterMap.put(method.getName(), propertyDescriptor.getName());
}
}
// Scan getters for FieldBuilder.* annotations other than FieldBuilder.ProvidesField and FieldBuilder.Binding
final HashMap> bindingBuilderMap = new HashMap<>(); // contains @FieldBuilder.* fields
for (Map.Entry entry : getterMap.entrySet()) {
final String propertyName = entry.getKey();
final Method method = entry.getValue();
// Get annotations, if any
final List> applierList = this.buildApplierList(method);
if (applierList.isEmpty())
continue;
// Build field
final HasValue field = this.buildField(applierList, "method " + method);
// Add binding builder
bindingBuilderMap.put(propertyName, this.binder.forField(field));
}
// Scan all methods for @FieldBuilder.ProvidesField annotations
final HashMap providerMap = new HashMap<>(); // contains @FieldBuilder.ProvidesField methods
this.buildProviderMap(providerMap);
// Check for conflicts between @FieldBuilder.ProvidesField and other annotations and add fields to map
for (Map.Entry entry : providerMap.entrySet()) {
final String propertyName = entry.getKey();
final Method method = entry.getValue();
// Verify field is not already defined
if (bindingBuilderMap.containsKey(propertyName)) {
throw new IllegalArgumentException("conflicting annotations exist for property `" + propertyName + "': annotation @"
+ ProvidesField.class.getName() + " on method " + method
+ " cannot be combined with other @FieldBuilder.* annotation types");
}
// Invoke method to create field, if possible
if ((method.getModifiers() & Modifier.STATIC) != 0 && bean == null)
continue;
HasValue field;
try {
method.setAccessible(true);
} catch (RuntimeException e) {
// ignore
}
try {
field = (HasValue)method.invoke(bean);
} catch (Exception e) {
throw new RuntimeException("error invoking @" + ProvidesField.class.getName()
+ " annotation on method " + method, e);
}
// Save field
bindingBuilderMap.put(propertyName, this.binder.forField(field));
}
// Scan getters for FieldBuilder.Binding annotations
final HashMap bindingAnnotationMap = new HashMap<>(); // contains @FieldBuilder.Binding's
final MethodAnnotationScanner bindingAnnotationScanner
= new MethodAnnotationScanner<>(this.type, Binding.class);
for (MethodAnnotationScanner.MethodInfo methodInfo : bindingAnnotationScanner.findAnnotatedMethods()) {
final String propertyName = inverseGetterMap.get(methodInfo.getMethod().getName());
bindingAnnotationMap.put(propertyName, methodInfo.getAnnotation());
}
// Get all binding builders
final List>> builderList = new ArrayList<>(bindingBuilderMap.entrySet());
// Collect corresponding ordering values
final HashMap orderMap = new HashMap<>(builderList.size());
// Apply @FieldBuilder.Binding annotations (if any) and bind fields
for (int i = 0; i < builderList.size(); i++) {
final Map.Entry> entry = builderList.get(i);
final String propertyName = entry.getKey();
Binder.BindingBuilder bindingBuilder = entry.getValue();
// Apply @FieldBuilder.Binding annotation, if any
final Binding bindingAnnotation = bindingAnnotationMap.get(propertyName);
if (bindingAnnotation != null) {
bindingBuilder = this.applyBindingAnnotation(bindingBuilder, bindingAnnotation);
entry.setValue(bindingBuilder);
orderMap.put(propertyName, bindingAnnotation.order());
}
// Bind field
bindingBuilder.bind(propertyName);
}
// Sort builders
builderList.sort(Comparator
.>>comparingDouble(e -> orderMap.getOrDefault(e.getKey(), 0.0))
.thenComparing(Map.Entry::getKey));
// Rebuild property names set
this.propertyNames.clear();
for (Map.Entry> entry : builderList)
this.propertyNames.add(entry.getKey());
}
private void buildProviderMap(Map providerMap) {
final MethodAnnotationScanner scanner = new MethodAnnotationScanner<>(this.type, ProvidesField.class);
for (MethodAnnotationScanner.MethodInfo methodInfo : scanner.findAnnotatedMethods())
this.buildProviderMap(providerMap, methodInfo.getMethod().getDeclaringClass(), methodInfo.getMethod().getName());
}
private Method workAroundIntrospectorBug(Method method) {
if (method == null)
return method;
for (Class c = this.type; c != null && c != method.getClass(); c = c.getSuperclass()) {
try {
method = c.getDeclaredMethod(method.getName(), method.getParameterTypes());
} catch (Exception e) {
continue;
}
break;
}
return method;
}
@SuppressWarnings("unchecked")
private Binder.BindingBuilder applyBindingAnnotation(
Binder.BindingBuilder bindingBuilder, Binding bindingAnnotation) {
if (bindingAnnotation.required().length() > 0)
bindingBuilder = bindingBuilder.asRequired(bindingAnnotation.required());
if (bindingAnnotation.requiredProvider() != ErrorMessageProvider.class)
bindingBuilder = bindingBuilder.asRequired(ReflectUtil.instantiate(bindingAnnotation.requiredProvider()));
if (bindingAnnotation.converter() != Converter.class)
bindingBuilder = bindingBuilder.withConverter(ReflectUtil.instantiate(bindingAnnotation.converter()));
if (bindingAnnotation.validationStatusHandler() != BindingValidationStatusHandler.class) {
bindingBuilder = bindingBuilder.withValidationStatusHandler(
ReflectUtil.instantiate(bindingAnnotation.validationStatusHandler()));
}
if (bindingAnnotation.validator() != Validator.class)
bindingBuilder = bindingBuilder.withValidator(ReflectUtil.instantiate(bindingAnnotation.validator()));
if (!bindingAnnotation.nullRepresentation().equals(STRING_DEFAULT)) {
try {
bindingBuilder = ((Binder.BindingBuilder)bindingBuilder).withNullRepresentation(
bindingAnnotation.nullRepresentation());
} catch (ClassCastException e) {
// ignore
}
}
return bindingBuilder;
}
// Used by buildBeanPropertyFields() to validate @FieldBuilder.ProvidesField annotations
private void buildProviderMap(Map providerMap, Class type, String methodName) {
// Terminate recursion
if (type == null)
return;
// Check the method in this class
do {
// Get method
Method method;
try {
method = type.getDeclaredMethod(methodName);
} catch (NoSuchMethodException e) {
break;
}
// Get annotation
final ProvidesField providesField = method.getAnnotation(ProvidesField.class);
if (providesField == null)
break;
// Validate method return type is compatible with Field
if (!HasValue.class.isAssignableFrom(method.getReturnType())) {
throw new IllegalArgumentException("invalid @" + ProvidesField.class.getName() + " annotation on method " + method
+ ": return type " + method.getReturnType().getName() + " is not a subtype of " + HasValue.class.getName());
}
// Check for two methods declaring fields for the same property
final String propertyName = providesField.value();
final Method otherMethod = providerMap.get(propertyName);
if (otherMethod != null && !otherMethod.getName().equals(methodName)) {
throw new IllegalArgumentException("conflicting @" + ProvidesField.class.getName()
+ " annotations exist for property `" + propertyName + "': both method "
+ otherMethod + " and method " + method + " are specified");
}
// Save method
if (otherMethod == null)
providerMap.put(propertyName, method);
} while (false);
// Recurse on interfaces
for (Class iface : type.getInterfaces())
this.buildProviderMap(providerMap, iface, methodName);
// Recurse on superclass
this.buildProviderMap(providerMap, type.getSuperclass(), methodName);
}
/**
* Instantiate and configure an {@link HasValue} according to the given scanned annotations.
*
* @param appliers annotation appliers
* @param description description of the field (used for exception messages)
* @return new field
*/
protected HasValue buildField(Collection> appliers, String description) {
// Get comparator that sorts by class hierarchy, narrower types first; note List.sort() is stable,
// so for any specific annotation type, that annotation on subtype appears before that annotation on supertype.
final Comparator> comparator = Comparator.comparing(
a -> FieldBuilder.getVaadinWidgetType(a.getAnnotation()), ReflectUtil.getClassComparator());
// Sanity check for duplicates and conflicts
final ArrayList> applierList = new ArrayList<>(appliers);
applierList.sort(comparator);
for (int i = 0; i < applierList.size() - 1; ) {
final AnnotationApplier a1 = applierList.get(i);
final AnnotationApplier a2 = applierList.get(i + 1);
// Let annotations on subclass override annotations on superclass
if (a1.getAnnotation().annotationType() == a2.getAnnotation().annotationType()) {
applierList.remove(i + 1);
continue;
}
// Check for conflicting annotation types (e.g., both FieldBuilder.TextField and FieldBuilder.DateField)
if (comparator.compare(a1, a2) == 0) {
throw new IllegalArgumentException("conflicting annotations of type "
+ a1.getAnnotation().annotationType().getName() + " and " + a2.getAnnotation().annotationType().getName()
+ " for " + description);
}
i++;
}
// Determine field type
Class> fieldType = null;
AnnotationApplier typeApplier = null;
for (AnnotationApplier applier : applierList) {
// Pick up type() if specified
if (applier.getActualFieldType() == null)
continue;
if (fieldType == null) {
fieldType = applier.getActualFieldType();
typeApplier = applier;
continue;
}
// Verify the field type specified by a narrower annotation has compatible narrower field type
if (!applier.getActualFieldType().isAssignableFrom(fieldType) && typeApplier != null) {
throw new IllegalArgumentException("conflicting field types specified by annotations of type "
+ typeApplier.getAnnotation().annotationType().getName() + " (type() = " + fieldType.getName() + ") and "
+ applier.getAnnotation().annotationType().getName() + " (type() = " + applier.getActualFieldType().getName()
+ ") for " + description);
}
}
if (fieldType == null)
throw new IllegalArgumentException("cannot determine field type; no type() specified for " + description);
// Instantiate field
final HasValue field = typeApplier.instantiate(fieldType);
// Configure the field
for (AnnotationApplier applier : applierList)
applier.applyTo(field);
// Done
return field;
}
/**
* Find all relevant annotations on the given method as well as on any supertype methods it overrides.
* The method must be a getter method taking no arguments. Annotations are ordered so that annotations
* on a method in type X appear before annotations on an overridden method in type Y, a supertype of X.
*
* @param method annotated getter method
* @return appliers for annotations found
* @throws IllegalArgumentException if {@code method} is null
* @throws IllegalArgumentException if {@code method} has parameters
*/
protected List> buildApplierList(Method method) {
// Sanity check
if (method == null)
throw new IllegalArgumentException("null method");
if (method.getParameterTypes().length > 0)
throw new IllegalArgumentException("method takes parameters");
// Recurse
final ArrayList> list = new ArrayList<>();
this.buildApplierList(method.getDeclaringClass(), method.getName(), list);
return list;
}
private void buildApplierList(Class type, String methodName, List> list) {
// Terminate recursion
if (type == null)
return;
// Check class
Method method;
try {
method = type.getMethod(methodName);
} catch (NoSuchMethodException e) {
method = null;
}
if (method != null)
list.addAll(this.buildDirectApplierList(method));
// Recurse on interfaces
for (Class iface : type.getInterfaces())
this.buildApplierList(iface, methodName, list);
// Recurse on superclass
this.buildApplierList(type.getSuperclass(), methodName, list);
}
/**
* Find all relevant annotations declared directly on the given {@link Method}.
*
* @param method method to inspect
* @return annotations found
* @throws IllegalArgumentException if {@code method} is null
*/
protected List> buildDirectApplierList(Method method) {
// Sanity check
if (method == null)
throw new IllegalArgumentException("null method");
// Build list
final ArrayList> list = new ArrayList<>();
for (Annotation annotation : method.getDeclaredAnnotations()) {
final AnnotationApplier applier = this.getAnnotationApplier(method, annotation);
if (applier != null)
list.add(applier);
}
return list;
}
/**
* Get the {@link AnnotationApplier} that applies the given annotation.
* Subclasses can add support for additional annotation types by overriding this method.
*
* @param method method to inspect
* @param annotation method annotation to inspect
* @param annotation type
* @return corresponding {@link AnnotationApplier}, or null if annotation is unknown
*/
protected AnnotationApplier getAnnotationApplier(Method method, A annotation) {
return this.isFieldBuilderFieldAnnotation(annotation) ? new AnnotationApplier<>(method, annotation) : null;
}
// AnnotationApplier
/**
* Class that knows how to apply annotation properties to a corresponding component.
*/
static class AnnotationApplier {
protected final Method method;
protected final A annotation;
AnnotationApplier(A annotation) {
this(null, annotation);
}
AnnotationApplier(Method method, A annotation) {
if (annotation == null)
throw new IllegalArgumentException("null annotation");
this.method = method;
this.annotation = annotation;
}
public final Method getMethod() {
return this.method;
}
public final A getAnnotation() {
return this.annotation;
}
@SuppressWarnings("unchecked")
public Class> getActualFieldType() {
try {
final Class defaultType = FieldBuilder.getVaadinWidgetType(this.annotation);
final Class actualType = (Class)this.annotation.getClass().getMethod("type").invoke(this.annotation);
if ((actualType.getModifiers() & Modifier.ABSTRACT) != 0 && actualType == defaultType)
return null;
return (Class>)actualType.asSubclass(HasValue.class);
} catch (Exception e) {
throw new RuntimeException("unexpected exception", e);
}
}
public HasValue instantiate(Class> fieldType) {
// Special case EnumComboBox takes a Class parameter
if (org.dellroad.stuff.vaadin8.EnumComboBox.class.isAssignableFrom(fieldType)
&& this.method != null
&& Enum.class.isAssignableFrom(this.method.getReturnType())) {
try {
return ReflectUtil.instantiate(fieldType.getDeclaredConstructor(Class.class), this.method.getReturnType());
} catch (NoSuchMethodException | RuntimeException e) {
// ignore
}
}
// Instantiate using zero-arg constructor
return ReflectUtil.instantiate(fieldType);
}
@SuppressWarnings("unchecked")
public void applyTo(HasValue field) {
// Get annotation defaults so we can see what properties are changed
final A defaults = FieldBuilder.getDefaults(this.annotation);
// Apply non-default annotation values
AnnotationUtil.applyAnnotationValues(field, "set", this.annotation, defaults, (methodList, propertyName) -> {
// Special handling for EnumComboBox
if (field instanceof org.dellroad.stuff.vaadin8.EnumComboBox
&& this.method != null
&& propertyName.equals("enumClass")
&& Enum.class.isAssignableFrom(this.method.getReturnType())) {
((org.dellroad.stuff.vaadin8.EnumComboBox)field).setEnumClass(
this.method.getReturnType().asSubclass(Enum.class));
return null;
}
// Proceed
return propertyName;
}, ReflectUtil::instantiate);
// Special handling for "styleNames" property
final Method styleNamesGetter;
try {
styleNamesGetter = this.annotation.getClass().getMethod("styleNames");
} catch (NoSuchMethodException e) {
return;
}
try {
final Method addStyleNameMethod = field.getClass().getMethod("addStyleName", String.class);
for (String styleName : (String[])styleNamesGetter.invoke(this.annotation))
addStyleNameMethod.invoke(field, styleName);
} catch (Exception e) {
throw new RuntimeException("unexpected exception", e);
}
}
}
static A getDefaults(A annotation) {
return FieldBuilder.getDefaults(FieldBuilder.getFieldBuilderAnnotationType(annotation));
}
@AbstractComponent
@AbstractDateField
@AbstractField
@AbstractListing
@AbstractMultiSelect
@AbstractSingleSelect
@AbstractTextField
@CheckBox
@CheckBoxGroup
@ComboBox
@DateField
@DateTimeField
@EnumComboBox
@InlineDateField
@ListSelect
@PasswordField
@RadioButtonGroup
@RichTextArea
@Slider
@TextArea
@TextField
static A getDefaults(Class annotationType) {
return AnnotationUtil.getAnnotation(annotationType, FieldBuilder.class, "getDefaults", Class.class);
}
/**
* Get the Vaadin {@link Component} widget type {@code Foo} that corresponds to the given {@code FieldBuilder.Foo} annotation.
*/
private static Class getVaadinWidgetType(A annotation) {
try {
final Method typeMethod = FieldBuilder.getFieldBuilderAnnotationType(annotation).getMethod("type");
final Class defaultFieldType = (Class)typeMethod.invoke(FieldBuilder.getDefaults(annotation));
return defaultFieldType.asSubclass(Component.class);
} catch (Exception e) {
throw new RuntimeException("unexpected exception", e);
}
}
/**
* Is the given annotation an instance of {@code FieldBuilder.Foo} for some Vaadin {@link Component} widget type {@code Foo}?
*/
private boolean isFieldBuilderFieldAnnotation(Annotation annotation) {
return FieldBuilder.getFieldBuilderAnnotationType(annotation) != null;
}
/**
* Get the original {@code FieldBuilder.Foo} annotation type that corresponds to the given {@code FieldBuilder.Foo} annotation.
*/
private static Class getFieldBuilderAnnotationType(A annotation) {
return FieldBuilder.getAnnotationType(annotation, type -> type.getDeclaringClass() == FieldBuilder.class
&& !ProvidesField.class.isAssignableFrom(type)
&& !Binding.class.isAssignableFrom(type));
}
/**
* Determine the original annotation type that the given annotation (which is likely a proxy object) implements.
*
* @param annotation the annotation
* @param filter additional predicat the annotation type must match
*/
@SuppressWarnings("unchecked")
private static Class getAnnotationType(A annotation,
Predicate> filter) {
for (Class iface : annotation.getClass().getInterfaces()) {
if (iface.isAnnotation() && filter.test((Class)iface))
return (Class)iface;
}
return null;
}
// Annotations
/**
* Specifies that the annotated method will return a {@link HasValue} suitable for editing the specified property.
*
*
* Annotated methods must take zero arguments and return a type compatible with {@link HasValue}.
* To be included when used with {@link #buildAndBind()} (taking no bean parameter), the annotated method must be
* {@code static}.
*
* @see FieldBuilder
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface ProvidesField {
/**
* The name of the property that the annotated method's return value edits.
*
* @return property name
*/
String value();
}
/**
* Specifies properties of the {@link Binder} binding itself.
*
*
* Properties correspond to methods in {@link Binder.BindingBuilder}.
*
* @see FieldBuilder
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface Binding {
/**
* Get the ordering value for this field.
*
* @return field order value
* @see FieldBuilder#getPropertyNames
*/
double order() default 0;
/**
* Get "as required" error message.
*
*
* Either this or {@link #requiredProvider} should be set, but not both.
*
* @return "as required" error message
* @see Binder.BindingBuilder#asRequired(String)
*/
String required() default "";
/**
* Get the null representation.
*
*
* This property only works for fields that present a {@link String} value, such as {@link com.vaadin.ui.TextField}.
*
*
* Note: the default value is just a placeholder, indicating that no null representation should be configured.
*
* @return null representation
* @see Binder.BindingBuilder#withNullRepresentation
*/
String nullRepresentation() default STRING_DEFAULT;
/**
* Get "as required" error message provider class.
*
*
* Either this or {@link #required} should be set, but not both.
*
* @return "as required" error message provider class
* @see Binder.BindingBuilder#asRequired(ErrorMessageProvider)
*/
Class requiredProvider() default ErrorMessageProvider.class;
/**
* Get the converter class.
*
* @return converter class
* @see Binder.BindingBuilder#withConverter(Converter)
*/
@SuppressWarnings("rawtypes")
Class converter() default Converter.class;
/**
* Get the validation status handler class.
*
* @return validation status handler class
* @see Binder.BindingBuilder#withValidationStatusHandler
*/
Class validationStatusHandler() default BindingValidationStatusHandler.class;
/**
* Get the validator class.
*
* @return validator class
* @see Binder.BindingBuilder#withValidator
*/
@SuppressWarnings("rawtypes")
Class validator() default Validator.class;
}
/**
* Specifies how a Java property should be edited using an {@link com.vaadin.ui.AbstractComponent}.
*
* @see FieldBuilder
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface AbstractComponent {
/**
* Get the {@link com.vaadin.ui.AbstractComponent} type that will edit the property.
*
*
* Although this property has a default value, it must be overridden either in this annotation, or
* by also including a more specific annotation such as {@link TextField}.
*
* @return field type
*/
@SuppressWarnings("rawtypes")
Class type() default com.vaadin.ui.AbstractComponent.class;
/**
* Get style names.
*
* @return style names
* @see com.vaadin.ui.AbstractComponent#addStyleName
*/
String[] styleNames() default {};
/**
* Get primary style name.
*
* @return primary style name
* @see com.vaadin.ui.AbstractComponent#setPrimaryStyleName
*/
String primaryStyleName() default "";
/**
* Get width.
*
* @return field width
* @see com.vaadin.ui.AbstractComponent#setWidth(String)
*/
String width() default "";
/**
* Get height.
*
* @return field height
* @see com.vaadin.ui.AbstractComponent#setHeight(String)
*/
String height() default "";
/**
* Get the caption associated with this field.
*
* @return field caption
* @see com.vaadin.ui.AbstractComponent#setCaption
*/
String caption() default "";
/**
* Get whether caption is HTML.
*
* @return true for HTML caption
* @see com.vaadin.ui.AbstractComponent#setCaptionAsHtml
*/
boolean captionAsHtml() default false;
/**
* Get the description associated with this field.
*
* @return field description
* @see com.vaadin.ui.AbstractComponent#setDescription
*/
String description() default "";
/**
* Get the unique ID for this field used for testing purposes.
*
* @return field id
* @see com.vaadin.ui.AbstractComponent#setId
*/
String id() default "";
/**
* Get whether this field is enabled.
*
* @return true to enable field
* @see com.vaadin.ui.AbstractComponent#setEnabled
*/
boolean enabled() default true;
/**
* Get whether field is responsive.
*
* @return true if value is responsive
* @see com.vaadin.ui.AbstractComponent#setResponsive
*/
boolean responsive() default false;
/**
* Get whether field is visible.
*
* @return true if value is visible
* @see com.vaadin.ui.AbstractComponent#setVisible
*/
boolean visible() default true;
}
/**
* Specifies how a Java property should be edited using an {@link com.vaadin.ui.AbstractField}.
*
* @see FieldBuilder.AbstractComponent
* @see FieldBuilder
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface AbstractField {
/**
* Get the {@link com.vaadin.ui.AbstractField} type that will edit the property.
*
*
* Although this property has a default value, it must be overridden either in this annotation, or
* by also including a more specific annotation such as {@link ComboBox}.
*
* @return field type
*/
@SuppressWarnings("rawtypes")
Class type() default com.vaadin.ui.AbstractField.class;
/**
* Get whether this field is read-only.
*
* @return true for read-only
* @see com.vaadin.ui.AbstractField#setReadOnly
*/
boolean readOnly() default false;
/**
* Get whether the required indicator is visible.
*
* @return true for visible
* @see com.vaadin.ui.AbstractField#setRequiredIndicatorVisible
*/
boolean requiredIndicatorVisible() default false;
/**
* Get this field's tab index.
*
* @return tab index
* @see com.vaadin.ui.AbstractField#setTabIndex
*/
int tabIndex() default -1;
}
/**
* Specifies how a Java property should be edited using an {@link com.vaadin.ui.AbstractListing}.
*
* @see FieldBuilder.AbstractComponent
* @see FieldBuilder
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface AbstractListing {
/**
* Get the {@link com.vaadin.ui.AbstractListing} type that will edit the property.
*
*
* Although this property has a default value, it must be overridden either in this annotation, or
* by also including a more specific annotation such as {@link ComboBox}.
*
* @return field type
*/
@SuppressWarnings("rawtypes")
Class type() default com.vaadin.ui.AbstractListing.class;
/**
* Get this field's tab index.
*
* @return tab index
* @see com.vaadin.ui.AbstractListing#setTabIndex
*/
int tabIndex() default -1;
}
/**
* Specifies how a Java property should be edited using an {@link com.vaadin.ui.AbstractMultiSelect}.
*
* @see FieldBuilder.AbstractListing
* @see FieldBuilder
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface AbstractMultiSelect {
/**
* Get the {@link com.vaadin.ui.AbstractMultiSelect} type that will edit the property.
*
*
* Although this property has a default value, it must be overridden either in this annotation, or
* by also including a more specific annotation such as {@link ListSelect} or {@link CheckBoxGroup}.
*
* @return field type
*/
@SuppressWarnings("rawtypes")
Class type() default com.vaadin.ui.AbstractMultiSelect.class;
/**
* Get the item caption generator class.
*
* @return caption generator
* @see com.vaadin.ui.AbstractListing#setItemCaptionGenerator
*/
@SuppressWarnings("rawtypes")
Class itemCaptionGenerator() default ItemCaptionGenerator.class;
/**
* Get whether this field is read-only.
*
* @return true for read-only
* @see com.vaadin.ui.AbstractMultiSelect#setReadOnly
*/
boolean readOnly() default false;
/**
* Get whether the required indicator is visible.
*
* @return true for visible
* @see com.vaadin.ui.AbstractMultiSelect#setRequiredIndicatorVisible
*/
boolean requiredIndicatorVisible() default false;
}
/**
* Specifies how a Java property should be edited using an {@link com.vaadin.ui.AbstractSingleSelect}.
*
* @see FieldBuilder.AbstractListing
* @see FieldBuilder
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface AbstractSingleSelect {
/**
* Get the {@link com.vaadin.ui.AbstractSingleSelect} type that will edit the property.
*
*
* Although this property has a default value, it must be overridden either in this annotation, or
* by also including a more specific annotation such as {@link ComboBox}.
*
* @return field type
*/
@SuppressWarnings("rawtypes")
Class type() default com.vaadin.ui.AbstractSingleSelect.class;
/**
* Get whether this field is read-only.
*
* @return true for read-only
* @see com.vaadin.ui.AbstractSingleSelect#setReadOnly
*/
boolean readOnly() default false;
/**
* Get whether the required indicator is visible.
*
* @return true for visible
* @see com.vaadin.ui.AbstractSingleSelect#setRequiredIndicatorVisible
*/
boolean requiredIndicatorVisible() default false;
}
/**
* Specifies how a Java property should be edited using an {@link com.vaadin.ui.CheckBox}.
*
* @see FieldBuilder.AbstractField
* @see FieldBuilder
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface CheckBox {
/**
* Get the {@link com.vaadin.ui.CheckBox} type that will edit the property. Type must have a no-arg constructor.
*
* @return field type
*/
Class type() default com.vaadin.ui.CheckBox.class;
}
/**
* Specifies how a Java property should be edited using an {@link com.vaadin.ui.ComboBox}.
*
* @see FieldBuilder.AbstractSingleSelect
* @see FieldBuilder
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface ComboBox {
/**
* Get the {@link com.vaadin.ui.ComboBox} type that will edit the property. Type must have a no-arg constructor.
*
* @return field type
*/
@SuppressWarnings("rawtypes")
Class type() default com.vaadin.ui.ComboBox.class;
/**
* Get the item icon generator class.
*
* @return icon generator
* @see com.vaadin.ui.ComboBox#setItemIconGenerator
*/
@SuppressWarnings("rawtypes")
Class itemIconGenerator() default IconGenerator.class;
/**
* Get the item caption generator class.
*
* @return caption generator
* @see com.vaadin.ui.ComboBox#setItemCaptionGenerator
*/
@SuppressWarnings("rawtypes")
Class itemCaptionGenerator() default ItemCaptionGenerator.class;
/**
* Get the {@link ListDataProvider} data provider class.
*
* @return data provider class
* @see com.vaadin.ui.ComboBox#setDataProvider
*/
@SuppressWarnings("rawtypes")
Class dataProvider() default ListDataProvider.class;
/**
* Get the new item provider class.
*
* @return new item provider
* @see com.vaadin.ui.ComboBox#setNewItemProvider
*/
@SuppressWarnings("rawtypes")
Class newItemProvider()
default com.vaadin.ui.ComboBox.NewItemProvider.class;
/**
* Get whether empty selection is allowed.
*
* @return true to allow empty selection
* @see com.vaadin.ui.ComboBox#setEmptySelectionAllowed
*/
boolean emptySelectionAllowed() default true;
/**
* Get the input prompt.
*
* @return input prompt
* @see com.vaadin.ui.ComboBox#setEmptySelectionCaption
*/
String emptySelectionCaption() default "";
/**
* Get the placeholder.
*
* @return placeholder
* @see com.vaadin.ui.ComboBox#setPlaceholder
*/
String placeholder() default "";
/**
* Get the popup width.
*
* @return popup width
* @see com.vaadin.ui.ComboBox#setPopupWidth
*/
String popupWidth() default "";
/**
* Get the page length.
*
* @return page length, or -1 for none
* @see com.vaadin.ui.ComboBox#setPageLength
*/
int pageLength() default -1;
/**
* Get whether to scroll to the selected item.
*
* @return true to scroll to the selected item
* @see com.vaadin.ui.ComboBox#setScrollToSelectedItem
*/
boolean scrollToSelectedItem() default true;
/**
* Get whether text input is allowed.
*
* @return true to allow text input
* @see com.vaadin.ui.ComboBox#setTextInputAllowed
*/
boolean textInputAllowed() default true;
}
/**
* Specifies how a Java property should be edited using an {@link com.vaadin.ui.CheckBoxGroup}.
*
* @see FieldBuilder.AbstractMultiSelect
* @see FieldBuilder
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface CheckBoxGroup {
/**
* Get the {@link com.vaadin.ui.CheckBoxGroup} type that will edit the property. Type must have a no-arg constructor.
*
* @return field type
*/
@SuppressWarnings("rawtypes")
Class type() default com.vaadin.ui.CheckBoxGroup.class;
/**
* Get the {@link DataProvider} class.
*
* @return data provider class
* @see com.vaadin.ui.CheckBoxGroup#setDataProvider
*/
@SuppressWarnings("rawtypes")
Class dataProvider() default DataProvider.class;
/**
* Get HTML content allowed.
*
* @return true for HTML content allowed
* @see com.vaadin.ui.CheckBoxGroup#setHtmlContentAllowed
*/
boolean htmlContentAllowed() default false;
/**
* Get the description generator class.
*
* @return description generator
* @see com.vaadin.ui.CheckBoxGroup#setItemDescriptionGenerator
*/
@SuppressWarnings("rawtypes")
Class itemDescriptionGenerator() default DescriptionGenerator.class;
/**
* Get the item enabled provider class.
*
* @return enabled provider
* @see com.vaadin.ui.CheckBoxGroup#setItemEnabledProvider
*/
@SuppressWarnings("rawtypes")
Class itemEnabledProvider() default SerializablePredicate.class;
/**
* Get the item icon generator class.
*
* @return icon generator
* @see com.vaadin.ui.CheckBoxGroup#setItemIconGenerator
*/
@SuppressWarnings("rawtypes")
Class itemIconGenerator() default IconGenerator.class;
}
/**
* Specifies how a Java property should be edited using an {@link org.dellroad.stuff.vaadin8.EnumComboBox}.
*
* @see FieldBuilder.ComboBox
* @see FieldBuilder
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface EnumComboBox {
/**
* Get the {@link org.dellroad.stuff.vaadin8.EnumComboBox} type that will edit the property.
*
*
* The type may have either a no-arg constructor or a single-arg constructor taking the {@link Enum} type.
*
* @return field type
*/
@SuppressWarnings("rawtypes")
Class type() default org.dellroad.stuff.vaadin8.EnumComboBox.class;
}
/**
* Specifies how a Java property should be edited using an {@link com.vaadin.ui.RadioButtonGroup}.
*
* @see FieldBuilder.AbstractSingleSelect
* @see FieldBuilder
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface RadioButtonGroup {
/**
* Get the {@link com.vaadin.ui.RadioButtonGroup} type that will edit the property. Type must have a no-arg constructor.
*
* @return field type
*/
@SuppressWarnings("rawtypes")
Class type() default com.vaadin.ui.RadioButtonGroup.class;
/**
* Get the item caption generator class.
*
* @return caption generator
* @see com.vaadin.ui.RadioButtonGroup#setItemCaptionGenerator
*/
@SuppressWarnings("rawtypes")
Class itemCaptionGenerator() default ItemCaptionGenerator.class;
/**
* Get the item icon generator class.
*
* @return icon generator
* @see com.vaadin.ui.RadioButtonGroup#setItemIconGenerator
*/
@SuppressWarnings("rawtypes")
Class itemIconGenerator() default IconGenerator.class;
/**
* Get the item enabled provider class.
*
* @return enabled provider
* @see com.vaadin.ui.RadioButtonGroup#setItemEnabledProvider
*/
@SuppressWarnings("rawtypes")
Class itemEnabledProvider() default SerializablePredicate.class;
/**
* Get the {@link DataProvider} class.
*
* @return data provider class
* @see com.vaadin.ui.RadioButtonGroup#setDataProvider
*/
@SuppressWarnings("rawtypes")
Class dataProvider() default DataProvider.class;
/**
* Get HTML content allowed.
*
* @return true for HTML content allowed
* @see com.vaadin.ui.RadioButtonGroup#setHtmlContentAllowed
*/
boolean htmlContentAllowed() default false;
}
/**
* Specifies how a Java property should be edited using an {@link com.vaadin.ui.ListSelect}.
*
* @see FieldBuilder.AbstractMultiSelect
* @see FieldBuilder
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface ListSelect {
/**
* Get the {@link com.vaadin.ui.ListSelect} type that will edit the property. Type must have a no-arg constructor.
*
* @return field type
*/
@SuppressWarnings("rawtypes")
Class type() default com.vaadin.ui.ListSelect.class;
/**
* Get the {@link DataProvider} class.
*
* @return data provider class
* @see com.vaadin.ui.ListSelect#setDataProvider
*/
@SuppressWarnings("rawtypes")
Class dataProvider() default DataProvider.class;
/**
* Get the number of rows in the editor.
*
* @return number of rows, or -1 for none
* @see com.vaadin.ui.ListSelect#setRows
*/
int rows() default -1;
}
/**
* Specifies how a Java property should be edited using an {@link com.vaadin.ui.AbstractDateField}.
*
* @see FieldBuilder.AbstractField
* @see FieldBuilder
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface AbstractDateField {
/**
* Get the {@link com.vaadin.ui.AbstractDateField} type that will edit the property. Type must have a no-arg constructor.
*
* @return field type
*/
@SuppressWarnings("rawtypes")
Class type() default com.vaadin.ui.AbstractDateField.class;
/**
* Get the format string.
*
* @return format string
* @see com.vaadin.ui.AbstractDateField#setDateFormat
*/
String dateFormat() default "";
/**
* Get the date out of range error message.
*
* @return date out of range error message
* @see com.vaadin.ui.AbstractDateField#setDateOutOfRangeMessage
*/
String dateOutOfRangeMessage() default "";
/**
* Get lenient mode.
*
* @return true for lenient mode
* @see com.vaadin.ui.AbstractDateField#setLenient
*/
boolean lenient() default false;
/**
* Get the date parse error message.
*
* @return date parse error message
* @see com.vaadin.ui.AbstractDateField#setParseErrorMessage
*/
String parseErrorMessage() default "";
/**
* Get the date resolution.
*
* @return date resolution
* @see com.vaadin.ui.AbstractDateField#setResolution
*/
DateResolution resolution() default DateResolution.DAY;
/**
* Get whether to show ISO week numbers.
*
* @return whether to show ISO week numbers
* @see com.vaadin.ui.AbstractDateField#setShowISOWeekNumbers
*/
boolean showISOWeekNumbers() default false;
}
/**
* Specifies how a Java property should be edited using a {@link com.vaadin.ui.DateField}.
*
* @see FieldBuilder.AbstractDateField
* @see FieldBuilder
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface DateField {
/**
* Get the {@link com.vaadin.ui.DateField} type that will edit the property. Type must have a no-arg constructor.
*
* @return field type
*/
Class type() default com.vaadin.ui.DateField.class;
/**
* Get whether text field is enabled.
*
* @return true for text field enabled
* @see com.vaadin.ui.DateField#setTextFieldEnabled
*/
boolean textFieldEnabled() default true;
/**
* Get the placeholder.
*
* @return placeholder
* @see com.vaadin.ui.DateField#setPlaceholder
*/
String placeholder() default "";
/**
* Get the assistive text.
*
* @return assistive text
* @see com.vaadin.ui.DateField#setAssistiveText
*/
String assistiveText() default "";
}
/**
* Specifies how a Java property should be edited using an {@link com.vaadin.ui.DateTimeField}.
*
* @see FieldBuilder.AbstractDateField
* @see FieldBuilder
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface DateTimeField {
/**
* Get the {@link com.vaadin.ui.DateTimeField} type that will edit the property. Type must have a no-arg constructor.
*
* @return field type
*/
Class type() default com.vaadin.ui.DateTimeField.class;
/**
* Get whether text field is enabled.
*
* @return true for text field enabled
* @see com.vaadin.ui.DateTimeField#setTextFieldEnabled
*/
boolean textFieldEnabled() default true;
/**
* Get the placeholder.
*
* @return placeholder
* @see com.vaadin.ui.DateTimeField#setPlaceholder
*/
String placeholder() default "";
/**
* Get the assistive text.
*
* @return assistive text
* @see com.vaadin.ui.DateTimeField#setAssistiveText
*/
String assistiveText() default "";
}
/**
* Specifies how a Java property should be edited using an {@link com.vaadin.ui.InlineDateField}.
*
* @see FieldBuilder.AbstractDateField
* @see FieldBuilder
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface InlineDateField {
/**
* Get the {@link com.vaadin.ui.InlineDateField} type that will edit the property. Type must have a no-arg constructor.
*
* @return field type
*/
Class type() default com.vaadin.ui.InlineDateField.class;
}
/**
* Specifies how a Java property should be edited using a {@link com.vaadin.ui.AbstractTextField}.
*
* @see FieldBuilder.AbstractField
* @see FieldBuilder
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface AbstractTextField {
/**
* Get the {@link com.vaadin.ui.AbstractTextField} type that will edit the property.
*
* @return field type
*/
Class type() default com.vaadin.ui.AbstractTextField.class;
/**
* Get the placeholder.
*
* @return placeholder
* @see com.vaadin.ui.AbstractTextField#setPlaceholder
*/
String placeholder() default "";
/**
* Get text change event mode.
*
* @return text change event mode
* @see com.vaadin.ui.AbstractTextField#setValueChangeMode
*/
ValueChangeMode valueChangeMode() default ValueChangeMode.LAZY;
/**
* Get text change event timeout.
*
* @return text change event timeout in seconds, or -1 to not override
* @see com.vaadin.ui.AbstractTextField#setValueChangeTimeout
*/
int valueChangeTimeout() default -1;
/**
* Get the maximum length.
*
* @return maximum length, or -1 to not override
* @see com.vaadin.ui.AbstractTextField#setMaxLength
*/
int maxLength() default -1;
}
/**
* Specifies how a Java property should be edited using a {@link com.vaadin.ui.TextField}.
*
* @see FieldBuilder.AbstractTextField
* @see FieldBuilder
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface TextField {
/**
* Get the {@link com.vaadin.ui.TextField} type that will edit the property.
*
* @return field type
*/
Class type() default com.vaadin.ui.TextField.class;
}
/**
* Specifies how a Java property should be edited using a {@link com.vaadin.ui.TextArea}.
*
* @see FieldBuilder.AbstractTextField
* @see FieldBuilder
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface TextArea {
/**
* Get the {@link com.vaadin.ui.TextArea} type that will edit the property.
*
* @return field type
*/
Class type() default com.vaadin.ui.TextArea.class;
/**
* Set the number of rows.
*
* @return number of rows, or -1 for none
* @see com.vaadin.ui.TextArea#setRows
*/
int rows() default -1;
/**
* Set wordwrap mode.
*
* @return word wrap mode
* @see com.vaadin.ui.TextArea#setWordWrap
*/
boolean wordWrap() default true;
}
/**
* Specifies how a Java property should be edited using a {@link com.vaadin.ui.PasswordField}.
*
* @see FieldBuilder.TextField
* @see FieldBuilder
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface PasswordField {
/**
* Get the {@link com.vaadin.ui.PasswordField} type that will edit the property.
*
* @return field type
*/
Class type() default com.vaadin.ui.PasswordField.class;
}
/**
* Specifies how a Java property should be edited using a {@link com.vaadin.ui.Slider}.
*
* @see FieldBuilder.AbstractField
* @see FieldBuilder
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface Slider {
/**
* Get the {@link com.vaadin.ui.Slider} type that will edit the property.
*
* @return field type
*/
Class type() default com.vaadin.ui.Slider.class;
/**
* Get the minimum value.
*
* @return minimum value
* @see com.vaadin.ui.Slider#setMin
*/
double min() default Double.NaN;
/**
* Get the maximum value.
*
* @return maximum value
* @see com.vaadin.ui.Slider#setMax
*/
double max() default Double.NaN;
/**
* Get the resolution.
*
* @return resolution
* @see com.vaadin.ui.Slider#setResolution
*/
int resolution() default -1;
/**
* Get the orientation.
*
* @return orientation
* @see com.vaadin.ui.Slider#setOrientation
*/
SliderOrientation orientation() default SliderOrientation.HORIZONTAL;
}
/**
* Specifies how a Java property should be edited using a {@link com.vaadin.ui.RichTextArea}.
*
* @see FieldBuilder.AbstractField
* @see FieldBuilder
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
public @interface RichTextArea {
/**
* Get the {@link com.vaadin.ui.RichTextArea} type that will edit the property.
*
* @return field type
*/
Class type() default com.vaadin.ui.RichTextArea.class;
}
}