Class AbstractGridFieldBuilder<S extends AbstractGridFieldBuilder<S,T>, T>

java.lang.Object

org.dellroad.stuff.vaadin25.field.AbstractFieldBuilder<S,T>

org.dellroad.stuff.vaadin25.field.AbstractGridFieldBuilder<S,T>

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

FieldBuilder

public class AbstractGridFieldBuilder<S extends AbstractGridFieldBuilder<S,T>, T>
extends AbstractFieldBuilder<S,T>

Extension of AbstractFieldBuilder that adds the @FieldBuilder.GridSingleSelect and @FieldBuilder.GridMultiSelect annotations.

These annotations require special handling because they are not normal fields.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static @interface	AbstractGridFieldBuilder.GridMultiSelect	Specifies how a Java bean property should be edited using a Grid converted to a multi-select field via Grid.asMultiSelect().
static @interface	AbstractGridFieldBuilder.GridSingleSelect	Specifies how a Java bean property should be edited using a Grid converted to a single-select field via Grid.asSingleSelect().

Nested classes/interfaces inherited from class AbstractFieldBuilder

AbstractFieldBuilder.Binding, AbstractFieldBuilder.BindingInfo, AbstractFieldBuilder.DefaultInfo, AbstractFieldBuilder.EnabledBy, AbstractFieldBuilder.FieldDefault, AbstractFieldBuilder.FormLayout, AbstractFieldBuilder.NullifyCheckbox, AbstractFieldBuilder.ProvidesField

Field Summary

Fields inherited from class AbstractFieldBuilder

DEFAULT_ANNOTATION_DEFAULTS_METHOD_NAME, DEFAULT_IMPLEMENTATION_PROPERTY_NAME

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractGridFieldBuilder(Class<T> type)	Constructor.
protected	AbstractGridFieldBuilder(AbstractGridFieldBuilder<S,T> original)	Static information copy constructor.

Method Summary

Modifier and Type	Method	Description
protected Map<Class<? extends Annotation>, Annotation>	buildDeclarativeAnnotationsMap()	Get all of the declarative widget annotation types defined for this class and their default values.
protected FieldComponent<?>	buildDeclarativeField(AbstractFieldBuilder<S,T>.BindingInfo bindingInfo)	Construct and configure a field based on a @FieldBuilder.Foo declarative annotation.
protected Grid<?>	buildGrid(AbstractFieldBuilder<S,T>.BindingInfo bindingInfo, GridColumn column)

Methods inherited from class AbstractFieldBuilder

addFieldComponents, applyFieldDefaultAnnotations, bindFields, buildProvidedField, createBindingInfo, getFieldComponents, getImplementationPropertyName, getScannedFieldDefaults, getScannedProperties, getType, instantiate, instantiate, newFieldBuilderContext, scanForAnnotations, scanForFieldDefaultAnnotations

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AbstractGridFieldBuilder

protected AbstractGridFieldBuilder(Class<T> type)

Constructor.

Parameters:

type - backing object type

AbstractGridFieldBuilder

protected AbstractGridFieldBuilder(AbstractGridFieldBuilder<S,T> original)

Static information copy constructor.

Only the static information gathered by this instance by scanning for annotations is copied. Any previously bound fields are not copied.

Parameters:

original - original instance

Throws:

IllegalArgumentException - if original is null

Method Details

buildDeclarativeAnnotationsMap

protected Map<Class<? extends Annotation>, Annotation> buildDeclarativeAnnotationsMap()

Get all of the declarative widget annotation types defined for this class and their default values.

The implementation in AbstractFieldBuilder gleans this information using reflection by looking for a method named "annotationDefaultsMethod"<S extends AbstractFieldBuilder<S,T>, T> taking zero parameters declared by this class or some superclass and returning all annotations on that method. Subclasses may override this method to augment or modify this information.

Entries in the map may have null values if defaults are handled differently in a subclass' overridden buildDeclarativeField().

The implementation in AbstractGridFieldBuilder adds @FieldBuilder.GridSingleSelect and @FieldBuilder.GridMultiSelect.

Overrides:

buildDeclarativeAnnotationsMap in class AbstractFieldBuilder<S extends AbstractGridFieldBuilder<S,T>, T>

Returns:

widget annotation types

buildDeclarativeField

protected FieldComponent<?> buildDeclarativeField(AbstractFieldBuilder<S,T>.BindingInfo bindingInfo)

Description copied from class: AbstractFieldBuilder

Construct and configure a field based on a @FieldBuilder.Foo declarative annotation.

Overrides:

buildDeclarativeField in class AbstractFieldBuilder<S extends AbstractGridFieldBuilder<S,T>, T>

Parameters:

bindingInfo - field binding context

Returns:

new field

buildGrid

protected Grid<?> buildGrid(AbstractFieldBuilder<S,T>.BindingInfo bindingInfo,
 GridColumn column)