Page History
...
The central property when defining a link field is appName
- the name of the Magnolia app to choose the item from. The target app is responsible for providing a view that is suitable for selecting the item. When the target app is a content app, the workbench in the browser subapp is a suitable view and it is used by default. For more complex apps like the Assets app - 5 UI, a a choose dialog is configured in the app to browse the contents.
Table of Contents |
---|
Link field properties
Simple link field definition
...
:
Code Block | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
form:
tabs:
- name: tabImage
label: Image
fields:
- name: image
fieldType: link
targetWorkspace: dam
appName: assets
label: Select image
identifierToPathConverter:
class: info.magnolia.dam.app.assets.field.translator.AssetCompositeIdKeyTranslator
contentPreviewDefinition:
contentPreviewClass: info.magnolia.dam.app.ui.field.DamFilePreviewComponent
Localtab | | |||||||||
| ||||||||||
Advanced Tables - Table Plus | ||||||||||
| ||||||||||
Node name | Value |
|
|
|
|
|
| |||
| info.magnolia.dam.app.assets.field.translator.AssetCompositeIdKeyTranslator |
| ||||||||
| info.magnolia.dam.app.ui.field.DamFilePreviewComponent | |||||||||
| contacts | |||||||||
| link | |||||||||
| dam |
Mgnl p |
---|
Mgnl p |
---|
Include Page | ||||
---|---|---|---|---|
|
Field-specific properties:
<field name> | Name of field. | ||||||||||
| required Target app name used to create the content view to choose the item from. All content apps provide a workbench. The workbench view is used as the link target chooser by default. However, you can also provide a choose dialog and provide custom actions. See an example in | ||||||||||
| optional, default is Button label before the target node is selected. The value is i18n-able. | ||||||||||
| optional, default is Button label after the target node is selected. The value is i18n-able. | ||||||||||
| optional Render a preview of the selected content. The preview component typically displays an image thumbnail and some metadata. | ||||||||||
| optional Any class that implements the
| ||||||||||
| optional, default is Makes the text box displaying the link editable once a target has been selected. | ||||||||||
| optional The link field returns the path of the selected node by default. You can convert the path to a UUID with a converter. | ||||||||||
| optional Any class that implements the
| ||||||||||
| optional, default is Path in the workspace that browsing is limited to. The user can start browsing at this path but they cannot navigate to nodes above or at the same level as the target path. Use this property to restrict selecting of items to a particular folder. | ||||||||||
| optional, default is Name of the workspace in which the target content is stored if the content app is JCR based. Examples:
|
Include Page | ||||
---|---|---|---|---|
|
Anchor | ||||
---|---|---|---|---|
|
...
- It extends a custom Vaadin field,
- It stores a value which must be String.
- It has a callback (
).Javadoc resource link rangeHigherVersion 6.0 className info.magnolia.ui.api.app.ChooseDialogCallback renderType asynchronous - When choosing an item, the method
#onItemChosen(actionName, chosenValue)
is triggered on the callback. The parameter choosenValue is of typeObject
and is the corresponding ItemId of the item of the content app . (See see ItemIds and Items).
Depending on the implementation of the content app, the ItemId may be a String or a more complex Object. A well-known ItemId is
Javadoc resource link | ||||||
---|---|---|---|---|---|---|
|
...
...
When using LinkField with JCR-agnostic target apps that use complex ItemIds that extend Object
, override the public String toString()
method on the implementation of the itemId.
If LinkField does not work for your custom content app, create a custom link field. See Custom fields for more.