Package eu.europa.esig.dss.pdf.pdfbox

Class PdfBoxScreenshotBuilder

java.lang.Object

eu.europa.esig.dss.pdf.pdfbox.PdfBoxScreenshotBuilder

public class PdfBoxScreenshotBuilder
extends Object

Utility class to build a screenshot of PDF document

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PdfBoxScreenshotBuilder(DSSDocument pdfDocument)	Default constructor to generate a screenshot for a PDF document
protected	PdfBoxScreenshotBuilder(DSSDocument pdfDocument, char[] passwordProtection)	Constructor to generate a screenshot for a password-protected PDF document

Method Summary

Modifier and Type	Method	Description
static PdfBoxScreenshotBuilder	fromDocument(DSSDocument pdfDocument)	Creates a new PdfBoxScreenshotBuilder for the given DSSDocument
static PdfBoxScreenshotBuilder	fromDocument(DSSDocument pdfDocument, char[] passwordProtection)	Creates a new PdfBoxScreenshotBuilder for the password-protected DSSDocument
BufferedImage	generateBufferedImageScreenshot(int page)	The method generates a BufferedImage for the specified page of the document
DSSDocument	generateScreenshot(int page)	Generates a screenshot image of the specified page for the given PDF document
DSSDocument	generateScreenshot(int page, DSSResourcesHandler dssResourcesHandler)	Deprecated. since DSS 6.2.
protected PdfMemoryUsageSetting	getMemoryUsageSetting()	Gets PDF Memory Usage setting.
protected DSSResourcesHandler	initDssResourcesHandler()	Creates a new instance of DSSResourcesHandler.
PdfBoxScreenshotBuilder	setDSSResourcesHandlerBuilder(DSSResourcesHandlerBuilder dssResourcesHandlerBuilder)	Sets a resources handler builder for processing temporary documents (e.g. in memory vs temporary file) Default : In-memory processing is used.
PdfBoxScreenshotBuilder	setMemoryUsageSetting(PdfMemoryUsageSetting memoryUsageSetting)	Sets PDF memory usage settings on PDF document reading.

Methods inherited from class java.lang.Object

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

Constructor Details

PdfBoxScreenshotBuilder

protected PdfBoxScreenshotBuilder(DSSDocument pdfDocument)

Default constructor to generate a screenshot for a PDF document

Parameters:

pdfDocument - DSSDocument

PdfBoxScreenshotBuilder

protected PdfBoxScreenshotBuilder(DSSDocument pdfDocument,
 char[] passwordProtection)

Constructor to generate a screenshot for a password-protected PDF document

Parameters:

pdfDocument - DSSDocument

passwordProtection - char array containing a passphrase for the PDF document

Method Details

setDSSResourcesHandlerBuilder

public PdfBoxScreenshotBuilder setDSSResourcesHandlerBuilder(DSSResourcesHandlerBuilder dssResourcesHandlerBuilder)

Sets a resources handler builder for processing temporary documents (e.g. in memory vs temporary file) Default : In-memory processing is used.

Parameters:

dssResourcesHandlerBuilder - DSSResourcesHandlerBuilder

Returns:

this PdfBoxScreenshotBuilder

getMemoryUsageSetting

protected PdfMemoryUsageSetting getMemoryUsageSetting()

Gets PDF Memory Usage setting. Instantiates a default setting, if not defined.

Returns:

PdfMemoryUsageSetting

setMemoryUsageSetting

public PdfBoxScreenshotBuilder setMemoryUsageSetting(PdfMemoryUsageSetting memoryUsageSetting)

Sets PDF memory usage settings on PDF document reading. Default : PDF document is fully loaded in memory.

Parameters:

memoryUsageSetting - PdfMemoryUsageSetting

Returns:

this PdfBoxScreenshotBuilder

fromDocument

public static PdfBoxScreenshotBuilder fromDocument(DSSDocument pdfDocument)

Creates a new PdfBoxScreenshotBuilder for the given DSSDocument

Parameters:

pdfDocument - DSSDocument to build a screenshot for

Returns:

PdfBoxScreenshotBuilder

fromDocument

public static PdfBoxScreenshotBuilder fromDocument(DSSDocument pdfDocument,
 char[] passwordProtection)

Creates a new PdfBoxScreenshotBuilder for the password-protected DSSDocument

Parameters:

pdfDocument - DSSDocument to build a screenshot for

passwordProtection - char array containing a passphrase for the PDF document

Returns:

PdfBoxScreenshotBuilder

generateScreenshot

public DSSDocument generateScreenshot(int page)

Generates a screenshot image of the specified page for the given PDF document

Parameters:

page - a page number to generate screenshot for (page order starts from 1)

Returns:

DSSDocument PNG screenshot

generateScreenshot

@Deprecated
public DSSDocument generateScreenshot(int page,
 DSSResourcesHandler dssResourcesHandler)

Deprecated.

since DSS 6.2. This is a temporary method to ensure smooth migration.

Generates a screenshot image of the specified page for the given PDF document using the provided dssResourcesHandler. NOTE: This is a temporary method to ensure a smooth migration. Please do not use it.

Parameters:

page - a page number to generate screenshot for (page order starts from 1)

dssResourcesHandler - DSSResourcesHandler

Returns:

DSSDocument PNG screenshot

generateBufferedImageScreenshot

public BufferedImage generateBufferedImageScreenshot(int page)

The method generates a BufferedImage for the specified page of the document

Parameters:

page - a page number to generate screenshot for (page order starts from 1)

Returns:

BufferedImage

initDssResourcesHandler

protected DSSResourcesHandler initDssResourcesHandler()

Creates a new instance of DSSResourcesHandler. Instantiates default DSSResourcesHandlerBuilder if not defined.

Returns:

DSSResourcesHandler