org.nuxeo.ecm.platform.preview.api

Interface HtmlPreviewAdapter

All Known Implementing Classes:

AbstractHtmlPreviewAdapter, ConverterBasedHtmlPreviewAdapter, NoteHtmlPreviewAdapter, PreprocessedHtmlPreviewAdapter

public interface HtmlPreviewAdapter

Interface for the Preview DocumentModel adapter.

Author:

tiry

Method Summary

Modifier and Type	Method and Description
boolean	cachable()
void	cleanup()
List<Blob>	getFilePreviewBlobs()
List<Blob>	getFilePreviewBlobs(boolean postProcess)
List<Blob>	getFilePreviewBlobs(String xpath)
List<Blob>	getFilePreviewBlobs(String xpath, boolean postProcess)
String	getFilePreviewURL()
String	getFilePreviewURL(String xpath)
boolean	hasBlobToPreview() Check if the document holds some blobs that are suitable for preview
boolean	hasPreview(String xpath)
void	setAdaptedDocument(DocumentModel doc)

Method Detail

cachable

boolean cachable()

getFilePreviewURL

String getFilePreviewURL()

getFilePreviewURL

String getFilePreviewURL(String xpath)

getFilePreviewBlobs

List<Blob> getFilePreviewBlobs()
                        throws PreviewException

Throws:

PreviewException

getFilePreviewBlobs

List<Blob> getFilePreviewBlobs(String xpath)
                        throws PreviewException

Throws:

PreviewException

getFilePreviewBlobs

List<Blob> getFilePreviewBlobs(boolean postProcess)
                        throws PreviewException

Throws:

PreviewException

getFilePreviewBlobs

List<Blob> getFilePreviewBlobs(String xpath,
                               boolean postProcess)
                        throws PreviewException

Throws:

PreviewException

setAdaptedDocument

void setAdaptedDocument(DocumentModel doc)

cleanup

void cleanup()

hasBlobToPreview

boolean hasBlobToPreview()
                  throws PreviewException

Check if the document holds some blobs that are suitable for preview

Returns:

Throws:

PreviewException

Since:

5.7.3

hasPreview

boolean hasPreview(String xpath)

Since:

8.2