Versions Compared

Old Version 2

changes.mady.by.user Ashraf Khamis

Saved on

compared with

New Version Current

changes.mady.by.user Ashraf Khamis

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
  is java.lang.String

Model type of the field. Use the fully qualified class name. See PropertyType for possible values.

A default type typically hard-coded in each definition class. You only need to add this property if you want to override the default implementation (for example, with java.lang.Long).

optional

Converts values between presentation (UI) and model (stored data). The property must extend com.vaadin.data.Converter

placeholder

optional , default is false

Makes the field required. An asterisk is displayed next to the field label.

name

required

Name of the field definition item. Derived from the configured node name. Use alphanumeric characters without spaces.

class

required (unless $type is used)

Type of the field definition item. The value must be a fully qualified class name and a subtype of info.magnolia.ui.field.FieldDefinition. See Field types for possible values.

$type

You can use this as a shortcut for class if the definition class is annotated with info.magnolia.ui.field.FieldType. The proper value is defined by the annotation.

Code Block
languagejava
titleExample class annotation
collapsetrue
@FieldType("textField")
public class TextFieldDefinition extends ConfiguredFieldDefinition<String> {
...
}

To use the  $type property in YAML, see Example field definition .

type

See Field types for possible values.

itemProvider

required,

default

is

  • JcrPropertyProvider for JcrMultiValueFieldDefinition
  • JcrChildNodeProviderDefinition for JcrMultiFieldDefinition

itemProvider

required (used only in composite, multi and switchable fields)

Node with a $type property that specifies the type of data binding for the subnodes in complex fields.

See Item providers for more information.

converterClass

.

conversionErrorMessage

optional, default is conversion.message.error

Message shown when there is an error in the conversion process. The value can be literal or retrieved from the message bundle with a key. Use alphanumeric characters in literal values.

defaultValue

optional

Pre-filled default value displayed in the field. The value can be overwritten by the user. Use alphanumeric characters.

(info) Applied only when creating a new item, not for already existing items.

description

optional

Help text displayed when the user clicks the help icon. The value can be literal or a key of a message bundle.

factoryClass

optional

Defines the factory class that initializes and builds the Vaadin form field. The default factory class depends on the particular field

.

The value must be a fully qualified class name and a subtype of info.magnolia.ui.field.FieldFactory. 

fieldBinderClass

optional

Defines the binder class that applies configuration parameters from the field.

i18n

optional, default is false

Enables i18n authoring support, which allows editors 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.

label

optional

Field label displayed to editors. The value can be literal or a key of a message bundle.

If you do not provide the property, Magnolia will fall back to a generated i18n key.

If you do not want a to have any label at all, define set the property and set its value to a blank space to an empty string such as label: "" in YAML.

optional (used only in combobox and text fields)

Placeholder text to be displayed when the field is empty. The value is i18n-able.

readOnly

optional , default is false

Makes the field uneditable.

required

requiredErrorMessage

optional , default is validation.message.required

Error message shown when required is set to true and the user saves an empty field. The value can be literal or retrieved from the message bundle with a key. Use alphanumeric characters in literal values.

styleName

optional

Additional style information for an editor property definition item applied to the element when the form is rendered.

optional

List of field validator definition items, which must be a subtype of info.magnolia.ui.field.FieldValidatorDefinition

The value can be a CSS class or a list of CSS classes separated by white spaces.

validators 

.