Interface RenditionProvider
- All Known Implementing Classes:
AbstractLazyCachableRenditionProvider
,AutomationLazyRenditionProvider
,DefaultAutomationRenditionProvider
,HtmlRenditionProvider
,PdfAutomationRenditionProvider
,PictureRenditionProvider
,RenderViewRenditionProvider
,TemplateBasedRenditionProvider
,ThumbnailRenditionProvider
,TransmissionThreeDRenditionProvider
,VideoRenditionProvider
public interface RenditionProvider
Interface to hide providers of
Rendition
. A provider could be converter based, template based, or Automation
based- Since:
- 5.6
- Author:
- Tiry
-
Method Summary
Modifier and TypeMethodDescriptiondefault String
getVariant
(DocumentModel doc, RenditionDefinition definition) Gets the optionalRENDITION_VARIANT_PROPERTY
value for a givenRenditionDefinition
.boolean
isAvailable
(DocumentModel doc, RenditionDefinition definition) Test if the Rendition is available on the given DocumentModelrender
(DocumentModel doc, RenditionDefinition definition) Generate the rendition Blobs for a givenRenditionDefinition
.
-
Method Details
-
isAvailable
Test if the Rendition is available on the given DocumentModel -
render
Generate the rendition Blobs for a givenRenditionDefinition
. Return is a List of Blob for bigger flexibility (typically HTML rendition with resources)- Parameters:
doc
- the targetDocumentModel
definition
- theRenditionDefinition
to use- Returns:
- The list of Blobs
-
getVariant
Gets the optionalRENDITION_VARIANT_PROPERTY
value for a givenRenditionDefinition
.- Parameters:
doc
- the target documentdefinition
- the rendition definition to use- Returns:
- the generated
RENDITION_VARIANT_PROPERTY
value, ornull
- Since:
- 8.1
-