org.dellroad.stuff.vaadin7

Annotation Type FieldBuilder.AbstractField

@Retention(value=RUNTIME)
 @Target(value=METHOD)
 @Documented
public static @interface FieldBuilder.AbstractField

Specifies how a Java property should be edited in Vaadin using an AbstractField.

See Also:

FieldBuilder

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	buffered Get whether this field is buffered.
String	caption Get the caption associated with this field.
String	conversionError Get error message when value cannot be converted to data model type.
Class<? extends Converter>	converter Get the Converter type that convert field value to data model type.
String	description Get the description associated with this field.
boolean	enabled Get whether this field is enabled.
String	height Get height.
boolean	immediate Get whether this field is immediate.
boolean	invalidAllowed Get whether invalid values are allowed.
boolean	invalidCommitted Get whether invalid values should be committed.
boolean	readOnly Get whether this field is read-only.
boolean	required Get whether field is required.
String	requiredError Get the error that is shown if this field is required, but empty.
String[]	styleNames Get style names.
int	tabIndex Get tabular index.
Class<? extends AbstractField>	type Get the AbstractField type that will edit the property.
boolean	validationVisible Get whether automatic visible validation is enabled.
Class<? extends Validator>[]	validators Get Validator types to add to this field.
String	width Get width.

Element Detail

type

public abstract Class<? extends AbstractField> type

Get the 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 TextField.

Returns:

field type

Default:

com.vaadin.ui.AbstractField.class

styleNames

public abstract String[] styleNames

Get style names.

Returns:

style names

See Also:

AbstractComponent.addStyleName(java.lang.String)

Default:

{}

width

public abstract String width

Get width.

Returns:

field width

See Also:

AbstractComponent.setWidth(String)

Default:

""

height

public abstract String height

Get height.

Returns:

field height

See Also:

AbstractComponent.setHeight(String)

Default:

""

caption

public abstract String caption

Get the caption associated with this field.

Returns:

field caption

See Also:

AbstractComponent.setCaption(java.lang.String)

Default:

""

description

public abstract String description

Get the description associated with this field.

Returns:

field description

See Also:

AbstractComponent.setDescription(java.lang.String)

Default:

""

enabled

public abstract boolean enabled

Get whether this field is enabled.

Returns:

true to enable field

See Also:

AbstractComponent.setEnabled(boolean)

Default:

true

immediate

public abstract boolean immediate

Get whether this field is immediate.

Returns:

true for immediate mode

See Also:

AbstractComponent.setImmediate(boolean)

Default:

false

readOnly

public abstract boolean readOnly

Get whether this field is read-only.

Returns:

true for read-only

See Also:

AbstractComponent.setReadOnly(boolean)

Default:

false

converter

public abstract Class<? extends Converter> converter

Get the Converter type that convert field value to data model type. The specified class must have a no-arg constructor and compatible type.

The default value of this property is Converter, which means do not set a specific Converter on the field.

Returns:

field value converter

See Also:

AbstractField.setConverter(Converter)

Default:

com.vaadin.data.util.converter.Converter.class

validators

public abstract Class<? extends Validator>[] validators

Get Validator types to add to this field. All such types must have no-arg constructors.

Returns:

field validators

See Also:

AbstractField.addValidator(com.vaadin.data.Validator)

Default:

{}

buffered

public abstract boolean buffered

Get whether this field is buffered.

Returns:

true for buffered mode

See Also:

AbstractField.setBuffered(boolean)

Default:

false

invalidAllowed

public abstract boolean invalidAllowed

Get whether invalid values are allowed.

Returns:

true to allow invalid values

See Also:

AbstractField.setInvalidAllowed(boolean)

Default:

true

invalidCommitted

public abstract boolean invalidCommitted

Get whether invalid values should be committed.

Returns:

true to allow invalid values to be committed

See Also:

AbstractField.setInvalidCommitted(boolean)

Default:

false

conversionError

public abstract String conversionError

Get error message when value cannot be converted to data model type.

Returns:

error message

See Also:

AbstractField.setConversionError(java.lang.String)

Default:

"Could not convert value to {0}"

requiredError

public abstract String requiredError

Get the error that is shown if this field is required, but empty.

Returns:

error message

See Also:

AbstractField.setRequiredError(java.lang.String)

Default:

""

validationVisible

public abstract boolean validationVisible

Get whether automatic visible validation is enabled.

Returns:

true for automatic visible validation

See Also:

AbstractField.setValidationVisible(boolean)

Default:

true

required

public abstract boolean required

Get whether field is required.

Returns:

true if value is required

See Also:

AbstractField.setRequired(boolean)

Default:

false

tabIndex

public abstract int tabIndex

Get tabular index.

Returns:

field tab index

See Also:

AbstractField.setTabIndex(int)

Default:

0