AbstractFieldFactory (Magnolia UI (parent) 6.2 API)

java.lang.Object
- info.magnolia.ui.form.AbstractFormItem
- - info.magnolia.ui.form.field.factory.AbstractFieldFactory<D,T>

Type Parameters:

D - definition type

T - field value type

All Implemented Interfaces:

FieldFactory, FormItem

Direct Known Subclasses:

AbstractAccessFieldFactory, BasicUploadFieldFactory, CheckBoxFieldFactory, CodeFieldFactory, CompositeFieldFactory, DateFieldFactory, HiddenFieldFactory, LinkFieldFactory, LinkFieldSelectionFactory, MultiValueFieldFactory, PasswordFieldFactory, RichTextFieldFactory, SelectFieldFactory, StaticFieldFactory, SwitchableFieldFactory, TextFieldFactory, WorkbenchFieldFactory

Deprecated.
since 6.2 - use AbstractFieldFactory instead.
```
@Deprecated
public abstract class AbstractFieldFactory<D extends FieldDefinition,T>
extends AbstractFormItem
implements FieldFactory
```
Abstract FieldFactory implementations. This class handle all common attributes defined in FieldDefinition and binds Vaadin Field instances created by subclasses to the Property they will be reading and writing to.

See Also:

Upgrading to Magnolia 6.2.x

Property Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Type	Property and Description
`protected com.vaadin.v7.data.Property<T>`	`initialize` Deprecated. Initialize the property used as field's Datasource. If no `Transformer` is configure to the field definition, use the default `BasicTransformer`

Field Summary

Fields
Modifier and Type	Field and Description
`protected D`	`definition` Deprecated.
`protected com.vaadin.v7.ui.Field<T>`	`field` Deprecated.
`protected com.vaadin.v7.data.Item`	`item` Deprecated.

Constructor Summary

Constructors
Constructor and Description
`AbstractFieldFactory(D definition, com.vaadin.v7.data.Item relatedFieldItem)` Deprecated. since 5.4.2 - use `AbstractFieldFactory(FieldDefinition, Item, UiContext, I18NAuthoringSupport)` instead.
`AbstractFieldFactory(D definition, com.vaadin.v7.data.Item relatedFieldItem, UiContext uiContext, I18NAuthoringSupport i18NAuthoringSupport)` Deprecated.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected Object`	`createDefaultValue(com.vaadin.v7.data.Property property)` Deprecated.
`com.vaadin.v7.ui.Field<T>`	`createField()` Deprecated. Creates and initializes a Vaadin `Field` component.
`protected abstract com.vaadin.v7.ui.Field<T>`	`createFieldComponent()` Deprecated. Implemented by subclasses to create and initialize the Vaadin Field instance to use.
`protected Object`	`createTypedValue(Object defaultValue, Class<?> propertyType)` Deprecated. Create a typed value from an arbitrary value object to the given property type.
`protected info.magnolia.objectfactory.ComponentProvider`	`getComponentProvider()` Deprecated.
`protected Object`	`getConfiguredDefaultValue()` Deprecated. Resolve the default value from configuration.
`protected Class<?>`	`getDefaultFieldType()` Deprecated. Exposed method used by field's factory in order to define a default Field Type (decoupled from the definition).
`protected Class<?>`	`getDefinitionType()` Deprecated.
`D`	`getFieldDefinition()` Deprecated.
`protected Class<?>`	`getFieldType()` Deprecated. Define the field property value type Class. Return the value defined by the configuration ('type' property). If this value is not defined, return the value of the overriding method `getDefaultFieldType()`. If this method is not override, return `UndefinedPropertyType`. In this case, the `Transformer` will have the responsibility to define the property type.
`protected String`	`getI18nBasename()` Deprecated.
`Locale`	`getLocale()` Deprecated.
`View`	`getView()` Deprecated.
`protected com.vaadin.v7.data.util.converter.Converter<?,?>`	`initializeConverter(Class<?> converterClass)` Deprecated. Exposed method used by field's factory to initialize the property `Converter`. This allows to add additional constructor parameter if needed.
`protected com.vaadin.v7.data.Property<T>`	`initializeProperty()` Deprecated. Initialize the property used as field's Datasource. If no `Transformer` is configure to the field definition, use the default `BasicTransformer`
`protected Transformer<?>`	`initializeTransformer(Class<? extends Transformer<?>> transformerClass)` Deprecated. Exposed method used by field's factory to initialize the property `Transformer`. This allows to add additional constructor parameter if needed.
`protected boolean`	`isMessageKey(String key)` Deprecated. Field factories may use this method to check whether an @i18nText config property has an actual translation, or is a generated key.
`void`	`setComponentProvider(info.magnolia.objectfactory.ComponentProvider componentProvider)` Deprecated.
`void`	`setFieldValidatorFactoryFactory(FieldValidatorFactoryFactory fieldValidatorFactoryFactory)` Deprecated.
`void`	`setI18nContentSupport(info.magnolia.cms.i18n.I18nContentSupport i18nContentSupport)` Deprecated. This is deprecated since 5.3.4; `I18nContentSupport` was never used within any `FieldFactory`, rightfully so. If any, `I18NAuthoringSupport` is the one that should be used.
`void`	`setLocale(Locale locale)` Deprecated.
`void`	`setPropertyDataSourceAndDefaultValue(com.vaadin.v7.data.Property property)` Deprecated. Set the DataSource of the current field. Set the default value if : - the item is an instance of `ItemAdapter` and this is a new Item (Not yet stored in the related datasource). - the item is not an instance of `ItemAdapter`. In this case, the Item is a custom implementation of `Item` and we have no possibility to define if it is or not a new Item.
`protected void`	`setPropertyDataSourceDefaultValue(com.vaadin.v7.data.Property property)` Deprecated. Set the Field default value is required.

Methods inherited from class info.magnolia.ui.form.AbstractFormItem
getMessage, getMessages, getParent, setParent

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface info.magnolia.ui.form.FormItem
getMessages, getParent, setParent

- Property Detail
  - initialize
```
protected com.vaadin.v7.data.Property<T> initializeProperty
```
    Initialize the property used as field's Datasource.
    If no Transformer is configure to the field definition, use the default BasicTransformer
- Field Detail
  - field
```
protected com.vaadin.v7.ui.Field<T> field
```
    Deprecated.
  - definition
```
protected D extends FieldDefinition definition
```
    Deprecated.
  - item
```
protected com.vaadin.v7.data.Item item
```
    Deprecated.
- Constructor Detail
  - AbstractFieldFactory
```
@Inject
public AbstractFieldFactory(D definition,
                                    com.vaadin.v7.data.Item relatedFieldItem,
                                    UiContext uiContext,
                                    I18NAuthoringSupport i18NAuthoringSupport)
```
    Deprecated.
  - AbstractFieldFactory
```
@Deprecated
public AbstractFieldFactory(D definition,
                                        com.vaadin.v7.data.Item relatedFieldItem)
```
    Deprecated. since 5.4.2 - use AbstractFieldFactory(FieldDefinition, Item, UiContext, I18NAuthoringSupport) instead.
- Method Detail
  - setFieldValidatorFactoryFactory
```
public void setFieldValidatorFactoryFactory(FieldValidatorFactoryFactory fieldValidatorFactoryFactory)
```
    Deprecated.
    
    Specified by:
    
    setFieldValidatorFactoryFactory in interface FieldFactory
  - setI18nContentSupport
```
@Deprecated
public void setI18nContentSupport(info.magnolia.cms.i18n.I18nContentSupport i18nContentSupport)
```
    Deprecated. This is deprecated since 5.3.4; I18nContentSupport was never used within any FieldFactory, rightfully so. If any, I18NAuthoringSupport is the one that should be used.
    
    Specified by:
    
    setI18nContentSupport in interface FieldFactory
  - createField
```
public com.vaadin.v7.ui.Field<T> createField()
```
    Deprecated.
    
    Description copied from interface: FieldFactory
    
    Creates and initializes a Vaadin Field component.
    
    Specified by:
    
    createField in interface FieldFactory
  - setPropertyDataSourceAndDefaultValue
```
public void setPropertyDataSourceAndDefaultValue(com.vaadin.v7.data.Property property)
```
    Deprecated.
    
    Set the DataSource of the current field.
    Set the default value if :
    - the item is an instance of ItemAdapter and this is a new Item (Not yet stored in the related datasource).
    - the item is not an instance of ItemAdapter.
    In this case, the Item is a custom implementation of Item and we have no possibility to define if it is or not a new Item.
  - setPropertyDataSourceDefaultValue
```
protected void setPropertyDataSourceDefaultValue(com.vaadin.v7.data.Property property)
```
    Deprecated.
    
    Set the Field default value is required.
  - createDefaultValue
```
protected Object createDefaultValue(com.vaadin.v7.data.Property property)
```
    Deprecated.
  - createTypedValue
```
protected Object createTypedValue(Object defaultValue,
                                  Class<?> propertyType)
```
    Deprecated.
    
    Create a typed value from an arbitrary value object to the given property type. This primarily favors JCR types conversion, but also supports broader conversions via configured converterClass.
  - getConfiguredDefaultValue
```
protected Object getConfiguredDefaultValue()
```
    Deprecated.
    
    Resolve the default value from configuration.
    
    Returns:
    
    the field's configured defaultValue, unless otherwise stated.
  - getFieldDefinition
```
public D getFieldDefinition()
```
    Deprecated.
    
    Specified by:
    
    getFieldDefinition in interface FieldFactory
  - createFieldComponent
```
protected abstract com.vaadin.v7.ui.Field<T> createFieldComponent()
```
    Deprecated.
    
    Implemented by subclasses to create and initialize the Vaadin Field instance to use.
  - getView
```
public View getView()
```
    Deprecated.
    
    Specified by:
    
    getView in interface FieldFactory
  - initializeProperty
```
protected com.vaadin.v7.data.Property<T> initializeProperty()
```
    Deprecated.
    
    Initialize the property used as field's Datasource.
    If no Transformer is configure to the field definition, use the default BasicTransformer
  - initializeTransformer
```
protected Transformer<?> initializeTransformer(Class<? extends Transformer<?>> transformerClass)
```
    Deprecated.
    
    Exposed method used by field's factory to initialize the property Transformer.
    This allows to add additional constructor parameter if needed.
  - initializeConverter
```
protected com.vaadin.v7.data.util.converter.Converter<?,?> initializeConverter(Class<?> converterClass)
```
    Deprecated.
    
    Exposed method used by field's factory to initialize the property Converter.
    This allows to add additional constructor parameter if needed.
  - getFieldType
```
protected Class<?> getFieldType()
```
    Deprecated.
    
    Define the field property value type Class.
    Return the value defined by the configuration ('type' property).
    If this value is not defined, return the value of the overriding method getDefaultFieldType().
    If this method is not override, return UndefinedPropertyType.
    In this case, the Transformer will have the responsibility to define the property type.
  - getDefinitionType
```
protected Class<?> getDefinitionType()
```
    Deprecated.
    
    Returns:
    
    Class Type defined into the field definition or null if not defined.
  - getDefaultFieldType
```
protected Class<?> getDefaultFieldType()
```
    Deprecated.
    
    Exposed method used by field's factory in order to define a default Field Type (decoupled from the definition).
  - getI18nBasename
```
protected String getI18nBasename()
```
    Deprecated.
    
    Specified by:
    
    getI18nBasename in class AbstractFormItem
  - isMessageKey
```
protected boolean isMessageKey(String key)
```
    Deprecated.
    
    Field factories may use this method to check whether an @i18nText config property has an actual translation, or is a generated key.
    By default, if no translation is found, these properties contain the longest key to provide such a translation.
  - setComponentProvider
```
public void setComponentProvider(info.magnolia.objectfactory.ComponentProvider componentProvider)
```
    Deprecated.
    
    Specified by:
    
    setComponentProvider in interface FieldFactory
  - getComponentProvider
```
protected info.magnolia.objectfactory.ComponentProvider getComponentProvider()
```
    Deprecated.
  - setLocale
```
public void setLocale(Locale locale)
```
    Deprecated.
  - getLocale
```
public Locale getLocale()
```
    Deprecated.

Class AbstractFieldFactory<D extends FieldDefinition,T>

Property Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class info.magnolia.ui.form.AbstractFormItem

Methods inherited from class java.lang.Object

Methods inherited from interface info.magnolia.ui.form.FormItem

Property Detail

initialize

Field Detail

field

definition

item

Constructor Detail

AbstractFieldFactory

AbstractFieldFactory

Method Detail

setFieldValidatorFactoryFactory

setI18nContentSupport

createField

setPropertyDataSourceAndDefaultValue

setPropertyDataSourceDefaultValue

createDefaultValue

createTypedValue

getConfiguredDefaultValue

getFieldDefinition

createFieldComponent

getView

initializeProperty

initializeTransformer

initializeConverter

getFieldType

getDefinitionType

getDefaultFieldType

getI18nBasename

isMessageKey

setComponentProvider

getComponentProvider

setLocale

getLocale