org.hippoecm.hst.core.parameters

Annotation Type JcrPath

@Retention(value=RUNTIME)
 @Target(value=METHOD)
public @interface JcrPath

Indicates that the annotated method returns a JCR path that can be selected via a 'picker'. The path can be absolute, or relative (see isRelative()) to the picker content root path (see pickerRootPath()). This annotation should only be used on public getter methods.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	isRelative Whether this path is relative to the canonical content root path of the channel in which this annotation is used.
String	pickerConfiguration The root path of the CMS configuration to use for the picker, relative to '/hippo:configuration/hippo:frontend/cms'.
String	pickerInitialPath The initial path to use in the picker if nothing has been selected yet.
boolean	pickerRemembersLastVisited Whether the picker remembers the last visited path.
String	pickerRootPath The root absolute path to use in the picker.
String[]	pickerSelectableNodeTypes Types of nodes to be able to select in the picker.

Element Detail

pickerConfiguration

public abstract String pickerConfiguration

The root path of the CMS configuration to use for the picker, relative to '/hippo:configuration/hippo:frontend/cms'. The default picker configuration is 'cms-pickers/documents'.

Returns:

the root path of the CMS configuration to use for the picker, relative to '/hippo:configuration/hippo:frontend/cms'.

Default:

"cms-pickers/documents"

pickerInitialPath

public abstract String pickerInitialPath

The initial path to use in the picker if nothing has been selected yet. Use the path to a folder to initially open the picker in that folder. Use the path to the handle of a document to preselect that document.

Returns:

the initial path to use in the picker, or an empty string if the default initial path of the picker should be used.

Default:

""

pickerRemembersLastVisited

public abstract boolean pickerRemembersLastVisited

Whether the picker remembers the last visited path. The default is 'true'.

Returns:

whether the picker remembers the last visited path.

Default:

true

pickerSelectableNodeTypes

public abstract String[] pickerSelectableNodeTypes

Types of nodes to be able to select in the picker. The default list is empty, resulting in the default behavior of the picker.

Returns:

the node types to be able to select in the picker.

Default:

{}

isRelative

public abstract boolean isRelative

Whether this path is relative to the canonical content root path of the channel in which this annotation is used. The default is 'false', i.e. the path is absolute.

Returns:

whether this path is relative to the canonical content root path of the channel in which this annotation is used.

Default:

false

pickerRootPath

public abstract String pickerRootPath

The root absolute path to use in the picker. This parameter allows the picker to select documents outside the channel content path scope. However it is still restricted by authorization rules. The default value is empty, it means that the picker will use the canonical content path of the channel as the root path.

Returns:

the absolute root path to use in the picker, or an empty string if the channel content path is used. If configured it must start with a "/".

Default:

""