...

...

...

...

• return true for Transformer.hasI18NSupport() 
• implement a compatible Magnolia i18n logic.

Default Value

ConfiguredFieldDefinition.defaultValue  contains the String representation of the default value.

The default value is only showed the first time the related form is displayed.

This behavior is only supported by  basic field . 

Implemented

Property

A field needs to be linked to a property as data source. The value of the property is used to store the value entered/selected by the user on the field.
In Magnolia 5.1, every field are bound to a property that support Transformer called TransformedProperty.
This property is initialized with the configured Transformer and set to the field as datasource by the FieldFactory.

A ConfiguredField is linked to a TransformedProperty<T>. 

• TransformedProperty<T> 

...

BaseProperty

BaseProperty implements the following basic mechanism:

• Handle i18n support.
• Delegate the configured handler the request  when property.getValue() and property.setValue() are called.

Implemented Handlers

BasicPropertyHandler

Overview

...

• is initialized with a Transformer.

TransformedProperty<T> extend ObjectProperty<T>.

• value T : Transformer.readFromItem()
• T : Transformer.getType()

The Transformer has the responsibility to retrieve the initial value and to set the property class type.

TransformedProperty<T>  may be of any type. For a TextField configured to handle Long (ConfiguredFieldDefinition.type = Long), the <T>  will be of type Long.
For complexer Field (Multi, Composite) the <T> is of type PropertysetItem . This let the complex field easily handle multi property.

Implemented Transformer

BasicTransformer

The property linked to a field is retrieved and stored based on the Field's  property name defined in the field definition.

A new property is created in case id does not yet exist.

...

OptionGroupPropertyHandler

In case of an OptionGroup field is defined as multiselect, the selected values are stored as a JCR multi-value-property. This JCR multi-value-property is normally handled as a List, but the underlying Vaadin field is only working with Set . This handler simply convert  List to Set . 

TextCodePropertyHandler

Simple TextCode Handler that return an empty String instead of a null property value.

TwinSelectPropertyHandler

Like for the OptionGroup field, the underlying Vaadin Field need additional convertor between List to Set.

...

CompositeTransformer

In addition to the CompositeField and SwitchableField default Handler Transformer, we provide two an additional CompositeHandlerTransformer:

SubNodeCompositeHandler

 SubNodeCompositeHandler  will store the  property values of the fields composing the composite field under the following format:

...

...

formNode

...

...

Second field name composing the
Composite field

...

NoOpCompositeTransformer

NoOpCompositeTransformer

...

Third field name composing the
Composite field

...

This Handler do not support i18n (in Magnolia 5.1).

NoOpCompositeHandler

NoOpCompositeHandler is useful if you want to combine a Multi filed storing individual field value into sub nodes with composite field as Multi field component.

In this case, the Multi field handler field Transformer will createread/read write the node Item structure and pass a properties as PropertysetItem to the NoOpCompositeHandler NoOpCompositeTransformer. This handler This Transformer just act as a property container. 

MultiTransformer

...

MultiValueTransformer

MultiValuesPropertyMultiHandler

This is the default Handler default Transformer set for Multi value fields. The fields values are stored in a LinkedList<T> . This LinkedList<T> is then automatically convert to a JCR multi-value-property once it is persisted.
This will only work for simple fields like text/date/radio...

...

MultiValueJSONTransformer

Handler storing Transformer storing the fields values as a String with ',' as separator.
This will only work for simple fields like text/date/radio... and values are stored as String.

...

MultiValueChildrenNodeTransformer

HandlerTransformer storing the fields values in sub node item property: (Equivalent Jcr Structure of the form Item)

SubNodesMultiPropertysetItemHandler

MultiValueSubChildrenNodePropertiesTransformer

Transformer storing each field values into a sub Item. Equivalent to MultiValueChildrenNodeTransformer but this Transformer is able to handle multiple values.  Based on the previous NoOpCompositeHandlero previous NoOpCompositeTransformer example:

...

MultiValueSubChildrenNodeTransformer

Handler creating Transformer creating first a child node (named as the multi field) and storing the fields values in sub node property (equivalent to MultiValueChildrenNodeTransformer) :

Limitation

How to

Open Issue

Default value handling

The field definition allows to define a default value as a String:

• Text field, type is String default value is 'default value'
• Text field, type is Long default value is 1000l
• ....

This default value should be displayed in the related form field if ????

• It is a new Form
  
  • easy to implement
  • if a field is added to an existing form, this default value will never be displayed.
  • chooses solution
• If the property related to a form is null (currently if a property has an empty value, this property is removed or not saved)
  
  • easy to implement
  • if a user remove the default value associated to a field --> no property saved. When he will reopen this form, the default value will be displayed again
• ??

...