info.magnolia.ui.imageprovider

Interface ImageProvider

All Known Implementing Classes:

AbstractImageProvider, DefaultImageProvider

public interface ImageProvider

The ImageProvider provides portrait or thumbnail images for arbitrary content. It is primarily used to streamline preview images across the Magnolia UI.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PORTRAIT_GENERATOR
static String	THUMBNAIL_GENERATOR

Method Summary

Modifier and Type	Method and Description
String	getPortraitPath(Object itemId)
String	getThumbnailPath(Object itemId)
Object	getThumbnailResource(Object itemId, String generator) Gets an image preview for the content represented by the given itemId.
String	resolveIconClassName(String mimeType) Gets an icon class name for the given media type.

Field Detail

PORTRAIT_GENERATOR

static final String PORTRAIT_GENERATOR

See Also:

Constant Field Values

THUMBNAIL_GENERATOR

static final String THUMBNAIL_GENERATOR

See Also:

Constant Field Values

Method Detail

getThumbnailResource

Object getThumbnailResource(Object itemId,
                            String generator)

Gets an image preview for the content represented by the given itemId. This preview may be an image or an icon related to the content type.

Parameters:

itemId - the id of an Item

generator - the name of a registered ImageGenerator of the imaging module

Returns:

a Vaadin Resource or a String corresponding to an icon class name

resolveIconClassName

String resolveIconClassName(String mimeType)

Gets an icon class name for the given media type.

Parameters:

mimeType - a MIME type

Returns:

a String corresponding to an icon class name

getPortraitPath

String getPortraitPath(Object itemId)

Returns:

a link to the generated "portrait" preview for the content represented by the given itemId.

getThumbnailPath

String getThumbnailPath(Object itemId)

Returns:

a link to the generated "thumbnail" preview for the content represented by the given itemId.