Package com.xwiki.macros.viewfile.thumbnail.generators

Interface ThumbnailGenerator

@Role
public interface ThumbnailGenerator

Handles the thumbnail generation for a specific file type.

Since:

1.29.0

Version:

$Id$

Field Summary

Fields

Modifier and Type	Field	Description
static String	JPG	JPG file type.

Method Summary

Modifier and Type	Method	Description
String	generateThumbnail(org.xwiki.model.reference.AttachmentReference attachmentReference)	Generate the thumbnail for the given AttachmentReference.

Field Detail

JPG

static final String JPG

JPG file type.

See Also:

Constant Field Values

Method Detail

generateThumbnail

String generateThumbnail(org.xwiki.model.reference.AttachmentReference attachmentReference)
                  throws Exception

Generate the thumbnail for the given AttachmentReference.

Parameters:

attachmentReference - the reference of the file for which a thumbnail is requested

Returns:

the Url to the generated temporary attachment thumbnail

Throws:

Exception - if an error occurs during generation