com.liferay.document.library.preview

Interface DLPreviewRendererProvider

@ProviderType
public interface DLPreviewRendererProvider

Renders file previews in conjunction with DLPreviewRenderer.

Implementations must specify at least one value for the OSGi property content.type, and can be called only for those supported content types. For example, a DLPreviewRendererProvider that can provide previews for PDF files would have the content type settings content.type=application/pdf and content.type=application/x-pdf.

Method Summary

Modifier and Type	Method and Description
java.util.Set<java.lang.String>	getMimeTypes()
DLPreviewRenderer	getPreviewDLPreviewRenderer(com.liferay.portal.kernel.repository.model.FileVersion fileVersion)
default java.util.Optional<DLPreviewRenderer>	getPreviewDLPreviewRendererOptional(com.liferay.portal.kernel.repository.model.FileVersion fileVersion) Deprecated. As of Athanasius (7.3.x), replaced by getPreviewDLPreviewRenderer(FileVersion)
DLPreviewRenderer	getThumbnailDLPreviewRenderer(com.liferay.portal.kernel.repository.model.FileVersion fileVersion)
default java.util.Optional<DLPreviewRenderer>	getThumbnailDLPreviewRendererOptional(com.liferay.portal.kernel.repository.model.FileVersion fileVersion) Deprecated. As of Athanasius (7.3.x), replaced by getThumbnailDLPreviewRenderer(FileVersion)

Method Detail

getMimeTypes

java.util.Set<java.lang.String> getMimeTypes()

getPreviewDLPreviewRenderer

DLPreviewRenderer getPreviewDLPreviewRenderer(com.liferay.portal.kernel.repository.model.FileVersion fileVersion)

getPreviewDLPreviewRendererOptional

@Deprecated
default java.util.Optional<DLPreviewRenderer> getPreviewDLPreviewRendererOptional(com.liferay.portal.kernel.repository.model.FileVersion fileVersion)

Deprecated. As of Athanasius (7.3.x), replaced by getPreviewDLPreviewRenderer(FileVersion)

Returns the DL preview renderer responsible for rendering the file preview. If no such provider exists, the default preview is rendered.

Parameters:

fileVersion - the file version to preview

Returns:

the optional DL preview renderer

getThumbnailDLPreviewRenderer

DLPreviewRenderer getThumbnailDLPreviewRenderer(com.liferay.portal.kernel.repository.model.FileVersion fileVersion)

getThumbnailDLPreviewRendererOptional

@Deprecated
default java.util.Optional<DLPreviewRenderer> getThumbnailDLPreviewRendererOptional(com.liferay.portal.kernel.repository.model.FileVersion fileVersion)

Deprecated. As of Athanasius (7.3.x), replaced by getThumbnailDLPreviewRenderer(FileVersion)

Returns the DL preview renderer responsible for rendering the file thumbnail in the card view. If no such provider exists, the default thumbnail is rendered.

Parameters:

fileVersion - the file version to preview

Returns:

the optional DL preview renderer