Link field

LinkFieldDefinition renders a text field and a browse button that allows you to select an item from any data source. It extends the ComboBoxFieldDefinition class.

The link field is used to select targets inside Magnolia (for example, an asset to render an image or a page to tease) where it stores a reference to the selected item. Magnolia provides three preconfigured link field definitions:

DamLinkFieldDefinition: links to an asset (damLinkField).
PageLinkFieldDefinition: links to a page (pageLinkField).
JsonLinkFieldDefinition: links to a JSON node (jsonLinkField).

This link field definition is part of the Magnolia 6 UI framework. The fully qualified class name is info.magnolia.ui.field.LinkFieldDefinition.

If you work with the Magnolia 5 UI framework, see Link field for Magnolia 5 UI instead.

Example definition

link:
  label: Select image
  $type: linkField
  datasource:
    $type: jcrDatasource
    workspace: contacts
  chooserId: myModule:chooser

Field properties

Field-specific properties

`chooserId`	optional, default is `ui-framework-jcr:chooser` Unique identifier for the chooser dialog. If none is specified, the JCR chooser will be used by default.
`buttonSelectNewLabel`	optional, default is translated `buttons.select.new` key Button label before the target node is selected. The value is i18n-able.
`buttonSelectOtherLabel`	optional, default is translated `buttons.select.another` key Button label after the target node is selected. The value is i18n-able.
`editable`	optional, default is `true` When `false`, the text field displaying the link cannot be edited once a target is selected.
`preview`	optional Renders a preview of the selected content. The preview component typically displays an image thumbnail and some metadata.
`implementationClass`	required Any class that implements the `info.magnolia.ui.preview.ItemPreviewComponent` interface. Examples: `info.magnolia.contacts.app.ContactPreview` `info.magnolia.rest.ui.field.linkfield.JsonItemPreviewComponent`

Common combobox field properties

`emptySelectionAllowed`	optional, default is `false` (`true` in link field) Defines whether the user can select nothing in the field. When `true`, an empty item appears to the user.
`emptySelectionCaption`	optional, default is empty string When `emptySelectionAllowed` is `true`, the empty item appears with the given caption. The value is i18n-able.
`pageLength`	optional, default is `0` To enable paging and filtering in the field pop-up, value must be an integer greater than `0`. Value of `0` disables paging and filtering and makes all items visible.
`placeholder`	optional Placeholder text to be displayed when the field is empty. The value is i18n-able.
`popWidth`	optional Sets the width of the field pop-up relative to the field itself. If no value is specified, the pop-up's width will automatically expand to fit the content of all displayed items.
`scrollToSelectedItem`	optional Defines whether the selected item is visible when opening the field pop-up. Available values are `true` and `false`.
`textInputAllowed`	optional, default is `false` (`true` in link field) When `true`, the user can type into the field to filter the available items. The `filteringMode` property of select field defines how the options are filtered. When `false`, the field just shows the current selection.

Common select field properties

datasource

required

Connects the field to a data source. Options are populated via the configured data source.

Use the fully qualified class name or the $type alias if the definition class is annotated with info.magnolia.ui.datasource.DatasourceType.

filteringMode

optional, default is OFF (STARTSWITH in link field)

Vaadin FilteringMode. Available values are CONTAINS and STARTSWITH.

For this to work, you have to set the textInputAllowed property of combobox field to true.

Common simple field properties

`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. Example class annotation Expand source @FieldType("textField") public class TextFieldDefinition extends ConfiguredFieldDefinition<String> { ... } See Field types for possible values.
`type`	required, default is `java.lang.String` Model type of the field. Use the fully qualified class name. See PropertyType for possible values. A default type is 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`).
`converterClass`	optional Converts values between presentation (UI) and model (stored data). The property must extend com.vaadin.data.Converter.
`conversionErrorMessage`	optional, default is translated `conversion.message.error` key Message shown when there is an error in the conversion process. The value can be literal or a key of a message bundle. 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. 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 to have any label, set the property to an empty string such as `label: ""` in YAML.
`readOnly`	optional, default is `false` Makes the field uneditable.
`required`	optional, default is `false` (not relevant for checkbox field) Makes the field required. An asterisk is displayed next to the field label.
`requiredErrorMessage`	optional, default is translated `validation.message.required` key Error message shown when `required` is set to `true` and the user saves an empty field. The value can be literal or a key of a message bundle. 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. The value can be a CSS class or a list of CSS classes separated by white spaces.
`validators`	optional List of field validator definition items. Any value must be a subtype of `info.magnolia.ui.field.FieldValidatorDefinition`. See Field validators for more information.

Page tree