Page History

Javadoc

0

-resource-link-macro

rangeHigherVersion	5.5
className	info.magnolia.ui.form.field.definition.LinkFieldDefinition
renderType	asynchronous

renders a text field and a browse button that allows the user to select an item from a configured app. The link field is used to select targets inside Magnolia, for example a page to tease, an asset to render an image, etc.. The link field stores a reference to the selected item.

5.4.4+ The link field allows you to choose items from any content app, included non-JCR apps. See Using a link field to choose an item from non JCR Content app.

Classclass: info.magnolia.ui.form.field.definition.LinkFieldDefinition

...

Localtab Group

Localtab

active	true
title	YAML file

Code Block

language	js

form:
 tabs:
    - name: tabImage
      label: Image 
      fields:
        - name: image
          class: info.magnolia.ui.form.field.definition.LinkFieldDefinition
          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

title	JCR node

Advanced Tables - Table Plus

heading	0
enableHeadingAttributes	false
enableSorting	false
class	m5-configuration-tree
enableHighlighting	false

Node name

Value

Mgnl n

form

Mgnl n

tabs

Mgnl n

tabImage

Mgnl n

fields

Mgnl n

image

Mgnl n

identifierToPathConverter

Mgnl p

class

info.magnolia.dam.app.assets.field.translator.AssetCompositeIdKeyTranslator

Mgnl n

contentPreviewDefinition

Mgnl p

contentPreviewClass

info.magnolia.dam.app.ui.field.DamFilePreviewComponent

Mgnl p

appName

contacts

Mgnl p

class

info.magnolia.ui.form.field.definition.LinkFieldDefinition

Mgnl p

targetWorkspace

dam

Mgnl p

label

Select image

Mgnl p

label

Image

You can use common field properties and the following properties in a link field definition:

...

<field name> Name of field.

appName

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 /modules/dam/apps/assets/chooseDialog.

targetWorkspace

optional, default is website

Name of the workspace in which the target content is stored if the content app is JCR based. Examples:

appName	targetWorkspace
`pages`	`website`
`assets`	`dam`
`contacts`	`contacts`
`categories`	`category`

fieldEditable

optional, default is true

Makes the text box displaying the link editable once a target has been selected.

buttonSelectNewLabel

optional, default is Select new...

Button label before the target node is selected.

buttonSelectOtherLabel

optional, default is Select another...

Button label after the target node is selected.

targetTreeRootPath

optional, default is /

Path where to start browsing the workspace.

identifierToPathConverter

optional

The link field returns the path of the selected node by default. You can convert the path to a UUID with a converter.

class

optional

Any class that implements the

Javadoc

0	info.magnolia.ui.form.field.converter.IdentifierToPathConverter
rangeHigherVersion	5.5
className	info.magnolia.ui.form.field.converter.IdentifierToPathConverter
renderType	asynchronous

interface. Examples:

info.magnolia.ui.form.field.converter.BaseIdentifierToPathConverter
info.magnolia.dam.app.assets.field.translator.AssetCompositeIdKeyTranslator converts an asset composite ID key to a path.

contentPreviewDefinition

optional

Render a preview of the selected content. The preview component typically displays an image thumbnail and some metadata.

contentPreviewClass

optional

Any class that implements the

Javadoc

0	info.magnolia.ui.form.field.component.ContentPreviewComponent
rangeHigherVersion	5.5
className	info.magnolia.ui.form.field.component.ContentPreviewComponent
renderType	asynchronous

interface. Examples:

info.magnolia.contacts.app.field.component.ContactPreviewComponent displays a contact thumbnail and information.
info.magnolia.dam.app.ui.field.DamFilePreviewComponent. Displays an asset thumbnail and related information.

...

To understand the process when choosing an item from a content app via link field, basic knowledge of the Content app framework and the nature of

Javadoc

0	info.magnolia.ui.form.field.LinkField
rangeHigherVersion	5.5
className	info.magnolia.ui.form.field.LinkField
renderType	asynchronous

is necessary.

Things to note about LinkField:

It extends a custom Vaadin field,
It stores a value which must be String.
It has a callback (
Javadoc
0 info.magnolia.ui.api.app.ChooseDialogCallback
rangeHigherVersion 5.5
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 type Object and is the corresponding ItemId of the item of the content app. (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

0	info.magnolia.ui.vaadin.integration.jcr.JcrItemId
rangeHigherVersion	5.5
className	info.magnolia.ui.vaadin.integration.jcr.JcrItemId
renderType	asynchronous

. The callback properly handles JcrItemId, and if it is another type, String.valueOf(chosenValue) is saved to the link field.

Code Pro

collapseType	Expand
language	java
title	Click to expand to see LinkFieldFactory#createChooseDialogCallback
collapse	true
sections	%%(protected ChooseDialogCallback)%% -
url	https://git.magnolia-cms.com/projects/PLATFORM/repos/ui.pub/browse/magnolia-ui-form/src/main/java/info/magnolia/ui/form/field/factory/LinkFieldFactory.java?at=

...

refs%2Ftags%2Fmagnolia-ui-5.4.17&raw

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.

...

Page tree

Versions Compared

Old Version 1

New Version Current

Key