info.magnolia.ui.form.field.definition

Class LinkFieldDefinition

java.lang.Object

info.magnolia.ui.form.field.definition.ConfiguredFieldDefinition

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

All Implemented Interfaces:

FieldDefinition

public class LinkFieldDefinition
extends ConfiguredFieldDefinition

The link field allows you to create a link to content stored in Magnolia. You can browse any specified workspace and select a content node to link to such as a page (website), file (dms) or data item (data).

Constructor Summary

Constructors

Constructor and Description
LinkFieldDefinition()

Method Summary

Methods

Modifier and Type	Method and Description
String	getAppName()
String	getButtonSelectNewLabel()
String	getButtonSelectOtherLabel()
ContentPreviewDefinition	getContentPreviewDefinition() If not define, no Content preview component will added to the selection field.
IdentifierToPathConverter	getIdentifierToPathConverter() If not define, no translation will be performed.
String	getTargetPropertyToPopulate()
String	getTargetTreeRootPath()
String	getTargetWorkspace()
boolean	isFieldEditable()
void	setAppName(String appName)
void	setButtonSelectNewLabel(String buttonSelectNewLabel)
void	setButtonSelectOtherLabel(String buttonSelectOtherLabel)
void	setContentPreviewDefinition(ContentPreviewDefinition contentPreviewDefinition)
void	setFieldEditable(boolean fieldEditable)
void	setIdentifierToPathConverter(IdentifierToPathConverter identifierToPathConverter)
void	setTargetPropertyToPopulate(String targetPropertyToPopulate)
void	setTargetTreeRootPath(String targetTreeRootPath)
void	setTargetWorkspace(String targetWorkspace)

Methods inherited from class info.magnolia.ui.form.field.definition.ConfiguredFieldDefinition

addValidator, getConverterClass, getDefaultValue, getDescription, getI18nBasename, getLabel, getName, getRequiredErrorMessage, getStyleName, getTransformerClass, getType, getValidators, isI18n, isReadOnly, isRequired, setConverterClass, setDefaultValue, setDescription, setI18n, setI18nBasename, setLabel, setName, setReadOnly, setRequired, setRequiredErrorMessage, setStyleName, setTransformerClass, setType, setValidators

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LinkFieldDefinition

public LinkFieldDefinition()

Method Detail

getAppName

public String getAppName()

Returns:

the target App Name used to create the ContentView, like 'pages'

getTargetPropertyToPopulate

public String getTargetPropertyToPopulate()

Returns:

the target property name to populate into the link field.

getTargetWorkspace

public String getTargetWorkspace()

Returns:

the workspace from which the link was retrieve.

getIdentifierToPathConverter

public IdentifierToPathConverter getIdentifierToPathConverter()

If not define, no translation will be performed.

Returns:

the implemented class used to perform the translation between a path and an Identifier.

getContentPreviewDefinition

public ContentPreviewDefinition getContentPreviewDefinition()

If not define, no Content preview component will added to the selection field.

Returns:

the implemented class used to display the File preview.

getTargetTreeRootPath

public String getTargetTreeRootPath()

Returns:

the root of the target tree.

getButtonSelectNewLabel

public String getButtonSelectNewLabel()

Returns:

the Button Label displayed when no link is yet selected.

getButtonSelectOtherLabel

public String getButtonSelectOtherLabel()

Returns:

the Button Label displayed when a link is selected.

isFieldEditable

public boolean isFieldEditable()

Returns:

if true, the select link field is editable, else it is defined as readOnly.

setTargetPropertyToPopulate

public void setTargetPropertyToPopulate(String targetPropertyToPopulate)

setTargetWorkspace

public void setTargetWorkspace(String targetWorkspace)

setTargetTreeRootPath

public void setTargetTreeRootPath(String targetTreeRootPath)

setAppName

public void setAppName(String appName)

setButtonSelectNewLabel

public void setButtonSelectNewLabel(String buttonSelectNewLabel)

setButtonSelectOtherLabel

public void setButtonSelectOtherLabel(String buttonSelectOtherLabel)

setIdentifierToPathConverter

public void setIdentifierToPathConverter(IdentifierToPathConverter identifierToPathConverter)

setContentPreviewDefinition

public void setContentPreviewDefinition(ContentPreviewDefinition contentPreviewDefinition)

setFieldEditable

public void setFieldEditable(boolean fieldEditable)