Class ElFinderDynamicResourceFileEntityThumbnails.BaseBuilder<Entry extends IFileSystemEntry<?>>

java.lang.Object

de.xima.fc.gui.elfinder.ElFinderDynamicResourceFileEntityThumbnails.BaseBuilder<Entry>

Type Parameters:

Entry - Common super type of all file system entries.

Enclosing class:

ElFinderDynamicResourceFileEntityThumbnails

public static final class ElFinderDynamicResourceFileEntityThumbnails.BaseBuilder<Entry extends IFileSystemEntry<?>>
extends Object

Base builder for generating thumbnail URLs via the dynamic resource servlet and handling requests to that servlet. This base builder lets you configure options that are common to ElFinderDynamicResourceFileEntityThumbnails.UrlGeneratorBuilder and ElFinderDynamicResourceFileEntityThumbnails.RequestHandlerBuilder. Use urlGenerator() or requestHandler() to continue with a specific builder.

ElFinderDynamicResourceFileEntityThumbnails.UrlGeneratorBuilder creates a URL for the thumbnail, using PrimeFaces' dynamic resource feature, see DynamicContentSrcBuilder and DynamicContentHandler.

ElFinderDynamicResourceFileEntityThumbnails.RequestHandlerBuilder creates a handler for processing requests to the dynamic resource servlet. It finds or generates the thumbnail image and writes it to the response.

The thumbnail may come from two sources: either directly from the file, in case the file was not yet changed; or directly from the ICommonFileSystem in case the file has unsaved changes.

Since:

8.3.0

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
ElFinderDynamicResourceFileEntityThumbnails.BaseBuilder<Entry>	paramNameFileEntityId(String paramNameFileEntityId)	Sets the name of the file entity ID parameter.
ElFinderDynamicResourceFileEntityThumbnails.BaseBuilder<Entry>	paramNameFileEntryHash(String paramNameFileEntryHash)	Sets the name of the file entry hash parameter.
ElFinderDynamicResourceFileEntityThumbnails.BaseBuilder<Entry>	paramNameThumbnailConstraints(String paramNameThumbnailConstraints)	Sets the name of the thumbnail constraints' parameter.
<FileEntity extends IFileEntity<?,?>> ElFinderDynamicResourceFileEntityThumbnails.RequestHandlerBuilder<Entry, FileEntity>	requestHandler()	Continues as a builder for a thumbnail request handler for file system entries from a ICommonFileSystem, with initial data from a IFileEntity stored in a database.
protected ElFinderDynamicResourceFileEntityThumbnails.BaseBuilder<Entry>	self()
ElFinderDynamicResourceFileEntityThumbnails.UrlGeneratorBuilder<Entry>	urlGenerator()	Continues as a builder for a URL creator that generates thumbnails for image files from file system entries of a ICommonFileSystem, with initial data from a IFileEntity stored in a database.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

requestHandler

public <FileEntity extends IFileEntity<?,?>>
ElFinderDynamicResourceFileEntityThumbnails.RequestHandlerBuilder<Entry, FileEntity> requestHandler()

Continues as a builder for a thumbnail request handler for file system entries from a ICommonFileSystem, with initial data from a IFileEntity stored in a database. This is the method for the request handler, see also urlGenerator.

ElFinderDynamicResourceFileEntityThumbnails.UrlGeneratorBuilder creates a URL for the thumbnail, using PrimeFaces' dynamic resource feature, see DynamicContentSrcBuilder and DynamicContentHandler.

ElFinderDynamicResourceFileEntityThumbnails.RequestHandlerBuilder creates a handler for processing HTTP requests to the dynamic resource servlet. It finds or generates the thumbnail image and writes it to the response.

The thumbnail may come from two sources: either directly from the file, in case the file was not yet changed; or directly from the ICommonFileSystem in case the file has unsaved changes.

Type Parameters:

FileEntity - The type of the file entity.

Returns:

A new builder for creating a thumbnail generator.

urlGenerator

public ElFinderDynamicResourceFileEntityThumbnails.UrlGeneratorBuilder<Entry> urlGenerator()

Continues as a builder for a URL creator that generates thumbnails for image files from file system entries of a ICommonFileSystem, with initial data from a IFileEntity stored in a database. This is the method for the request handler, see also requestHandler.

ElFinderDynamicResourceFileEntityThumbnails.UrlGeneratorBuilder creates a URL for the thumbnail, using PrimeFaces' dynamic resource feature, see DynamicContentSrcBuilder and DynamicContentHandler.

ElFinderDynamicResourceFileEntityThumbnails.RequestHandlerBuilder creates a handler for processing HTTP requests to the dynamic resource servlet. It finds or generates the thumbnail image and writes it to the response.

The thumbnail may come from two sources: either directly from the file, in case the file was not yet changed; or directly from the ICommonFileSystem in case the file has unsaved changes.

Returns:

A new builder for creating a thumbnail generator.

self

protected ElFinderDynamicResourceFileEntityThumbnails.BaseBuilder<Entry> self()

paramNameFileEntityId

public ElFinderDynamicResourceFileEntityThumbnails.BaseBuilder<Entry> paramNameFileEntityId(String paramNameFileEntityId)

Sets the name of the file entity ID parameter. Defaults to elfinder_feid.

Parameters:

paramNameFileEntityId - The name of the file entity ID parameter.

Returns:

This builder for chaining method calls.

paramNameFileEntryHash

public ElFinderDynamicResourceFileEntityThumbnails.BaseBuilder<Entry> paramNameFileEntryHash(String paramNameFileEntryHash)

Sets the name of the file entry hash parameter. Defaults to elfinder_feh.

Parameters:

paramNameFileEntryHash - The name of the file entry hash parameter.

Returns:

This builder for chaining method calls.

paramNameThumbnailConstraints

public ElFinderDynamicResourceFileEntityThumbnails.BaseBuilder<Entry> paramNameThumbnailConstraints(String paramNameThumbnailConstraints)

Sets the name of the thumbnail constraints' parameter. This parameter is added to request a certain set of constraints on the thumbnail, such as a target width. Defaults to elfinder_tc.

Parameters:

paramNameThumbnailConstraints - Parameter name for the thumbnail constraints.

Returns:

This builder for chaining method calls.