Interface IElFinderThumbnailUrlGenerator<Entry extends IFileSystemEntry<?>>

Type Parameters:

Entry - Common super type of all file system entries.

All Superinterfaces:

Serializable

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface IElFinderThumbnailUrlGenerator<Entry extends IFileSystemEntry<?>>
extends Serializable

Creates URLs for thumbnails of image files on the file system, used by the elFinder feature. ElFinder is a JavaScript file manager.

Since:

8.3.0

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
String	createThumbnailUrl(Entry entry, ICommonFileSystemManager<Entry> fileSystemManager, ImageThumbnailGeneratorConstraints constraints)	Creates a URL for the thumbnail of the given file.

Method Details

createThumbnailUrl

String createThumbnailUrl(Entry entry,
 ICommonFileSystemManager<Entry> fileSystemManager,
 ImageThumbnailGeneratorConstraints constraints)

Creates a URL for the thumbnail of the given file. A GET request to this URL should return the thumbnail content.

Parameters:

entry - The file system entry for which to create the thumbnail URL.

fileSystemManager - The file system manager with the file system containing the file.

constraints - Optional. When given, implementations should make the best effort to create a thumbnail that satisfies these constraints. If null, the thumbnail should use the default settings.

Returns:

The URL for the file. null if no thumbnail URL is available.