Versions Compared

Old Version 3

changes.mady.by.user Christoph Meier

Saved on

compared with

New Version 4

changes.mady.by.user Christoph Meier

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

<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:

appNametargetWorkspace
pageswebsite
assetsdam
contactscontacts
categoriescategory

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
0info.magnolia.ui.form.field.converter.IdentifierToPathConverter
rangeHigherVersion5.5
classNameinfo.magnolia.ui.form.field.converter.IdentifierToPathConverter
renderTypeasynchronous
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
0info.magnolia.ui.form.field.component.ContentPreviewComponent
rangeHigherVersion5.5
classNameinfo.magnolia.ui.form.field.component.ContentPreviewComponent
renderTypeasynchronous
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
0info.magnolia.ui.form.field.LinkField
rangeHigherVersion5.5
classNameinfo.magnolia.ui.form.field.LinkField
renderTypeasynchronous
 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
    0info.magnolia.ui.api.app.ChooseDialogCallback
    rangeHigherVersion5.5
    classNameinfo.magnolia.ui.api.app.ChooseDialogCallback
    renderTypeasynchronous
    ). 
  • 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
0info.magnolia.ui.vaadin.integration.jcr.JcrItemId
rangeHigherVersion5.5
classNameinfo.magnolia.ui.vaadin.integration.jcr.JcrItemId
renderTypeasynchronous
. The callback properly handles JcrItemId, and if it is another type, String.valueOf(chosenValue) is saved to the link field.

...