org.hippoecm.hst.core.parameters

Annotation Type ImageSetPath

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

Indicates that the annotated method returns the absolute path to the handle of an image set. This annotation should only be used on public getter methods.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	pickerConfiguration The root path of the CMS configuration to use for the image picker dialog, relative to '/hippo:configuration/hippo:frontend/cms'.
String	pickerInitialPath The initial path to use in the CMS image picker if nothing has been selected yet.
boolean	pickerRemembersLastVisited Whether the image picker remembers the last visited folder and image.
String[]	pickerSelectableNodeTypes Types of nodes to be able to select in the CMS image picker.
String	previewVariant The variant in the image set to use as the preview image in the CMS (i.e.

Element Detail

previewVariant

public abstract String previewVariant

The variant in the image set to use as the preview image in the CMS (i.e. the CND child node name). By default an empty string is returned, which means "use the primary item". If the given variant cannot be found, the primary item is used instead.

Returns:

the CND name of the image set variant to use as the preview image in the CMS.

Default:

""

pickerConfiguration

public abstract String pickerConfiguration

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

Returns:

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

Default:

"cms-pickers/images"

pickerInitialPath

public abstract String pickerInitialPath

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

Returns:

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

Default:

""

pickerRemembersLastVisited

public abstract boolean pickerRemembersLastVisited

Whether the image picker remembers the last visited folder and image. The default is 'true'.

Returns:

whether the image picker remembers the last visited folder and image.

Default:

true

pickerSelectableNodeTypes

public abstract String[] pickerSelectableNodeTypes

Types of nodes to be able to select in the CMS image picker. The default node type is 'hippogallery:imageset'.

Returns:

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

Default:

"hippogallery:imageset"