info.magnolia.ui.field

Interface FieldDefinition<T>

Type Parameters:

T - item type.

All Superinterfaces:

EditorPropertyDefinition, info.magnolia.config.NamedDefinition

All Known Implementing Classes:

AbstractOptionGroupFieldDefinition, AbstractSelectFieldDefinition, CheckBoxFieldDefinition, CheckBoxGroupFieldDefinition, CodeFieldDefinition, ComboBoxFieldDefinition, ConfiguredFieldDefinition, DateFieldDefinition, LinkFieldDefinition, ListSelectFieldDefinition, RadioButtonGroupFieldDefinition, RichTextFieldDefinition, TextFieldDefinition, TokenFieldDefinition, TwinColSelectFieldDefinition

public interface FieldDefinition<T>
extends EditorPropertyDefinition

Defines a field within a form.

See Also:

FormDefinition, FieldValidatorDefinition

Method Summary

Modifier and Type	Method and Description
String	getConversionErrorMessage() Message text displayed in case of conversion error.
Class<? extends com.vaadin.data.Converter<T,?>>	getConverterClass() Converts the model type returned by getType() into a presentation type, in case the two differ.
T	getDefaultValue() Pre-filled value displayed in the field.
Class<? extends FieldFactory<T>>	getFactoryClass()
Class<? extends FieldBinder<T>>	getFieldBinderClass()
String	getRequiredErrorMessage() Error message text displayed in case of required = true.
Class<?>	getType() The type of this field, i.e. the model type.
List<FieldValidatorDefinition>	getValidators()
boolean	isI18n() Enables i18n authoring support.
boolean	isReadOnly() Determines if a Field Property can be changed.
boolean	isRequired() Makes the field mandatory.

Methods inherited from interface info.magnolia.ui.field.EditorPropertyDefinition

getDescription, getLabel, getStyleName

Methods inherited from interface info.magnolia.config.NamedDefinition

getName

Method Detail

isRequired

boolean isRequired()

Makes the field mandatory.

getRequiredErrorMessage

String getRequiredErrorMessage()

Error message text displayed in case of required = true.

getType

Class<?> getType()

The type of this field, i.e. the model type. This needs to be the fully qualified Java class name representing the type, e.g. java.lang.Long or my.custom.Foo

getDefaultValue

T getDefaultValue()

Pre-filled value displayed in the field. The value can be overwritten by the user.

isReadOnly

boolean isReadOnly()

Determines if a Field Property can be changed.

getValidators

List<FieldValidatorDefinition> getValidators()

getConverterClass

Class<? extends com.vaadin.data.Converter<T,?>> getConverterClass()

Converts the model type returned by getType() into a presentation type, in case the two differ. For instance, a text field will likely use String but the model may be a Long. The converter will then handle the conversion between those two types.

See Also:

getType(), Converter

getConversionErrorMessage

String getConversionErrorMessage()

Message text displayed in case of conversion error.

isI18n

boolean isI18n()

Enables i18n authoring support. This allows authors to write foreign language or regionally targeted content. A two-letter language identifier (en, de, fr etc.) is displayed on controls where i18n is set to true.

Specified by:

isI18n in interface EditorPropertyDefinition

getFactoryClass

Class<? extends FieldFactory<T>> getFactoryClass()

getFieldBinderClass

Class<? extends FieldBinder<T>> getFieldBinderClass()