com.groupdocs.signature.options.preview

Class PreviewOptions

java.lang.Object

com.groupdocs.signature.options.preview.PreviewOptions

public class PreviewOptions
extends Object

Represents document preview options.

Constructor Summary

Constructors

Constructor and Description
PreviewOptions(com.groupdocs.signature.options.PageDataStreamFactory pageDataStreamFactory, int... pageNumbers) Initializes PreviewOptions object.
PreviewOptions(PageStreamFactory pageStreamFactory, int... pageNumbers) Initializes PreviewOptions object.
PreviewOptions(String filePathFormat, int... pageNumbers) Initializes PreviewOptions object.

Method Summary

Modifier and Type	Method and Description
int	getHeight() Gets or sets preview images height.
boolean	getHideSignatures() Gets or sets flag to hide signatures from page preview image.
int[]	getPageNumbers() Gets or sets preview images page numbers.
int	getPreviewFormat() Gets or sets preview images format.
int	getResolution() Gets the resolution of the preview images in DPI (dots per inch).
int	getWidth() Gets or sets preview images width.
void	setHeight(int value) Gets or sets preview images height.
void	setHideSignatures(boolean value) Gets or sets flag to hide signatures from page preview image.
void	setPageNumbers(int[] value) Gets or sets preview images page numbers.
void	setPreviewFormat(int value) Gets or sets preview images format.
void	setResolution(int value) Sets the resolution of the preview images in DPI (dots per inch).
void	setWidth(int value) Gets or sets preview images width.

Methods inherited from class java.lang.Object

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

Constructor Detail

PreviewOptions

public PreviewOptions(com.groupdocs.signature.options.PageDataStreamFactory pageDataStreamFactory,
                      int... pageNumbers)

Initializes PreviewOptions object.

Parameters:

pageDataStreamFactory - Interface which defines method to create output page preview stream.

PreviewOptions

public PreviewOptions(PageStreamFactory pageStreamFactory,
                      int... pageNumbers)

Initializes PreviewOptions object.

Parameters:

pageStreamFactory - Interface which defines method to create output page preview stream.

pageNumbers - Desired page numbers

PreviewOptions

public PreviewOptions(String filePathFormat,
                      int... pageNumbers)

Initializes PreviewOptions object.

Parameters:

filePathFormat - Path to output file.

pageNumbers - Desired page numbers

Method Detail

getHeight

public final int getHeight()

Gets or sets preview images height.

getHideSignatures

public final boolean getHideSignatures()

Gets or sets flag to hide signatures from page preview image. Only signatures are marked as IsSignature will be hidden from generated document page image.

getPageNumbers

public final int[] getPageNumbers()

Gets or sets preview images page numbers.

getPreviewFormat

public final int getPreviewFormat()

Gets or sets preview images format.

getResolution

public final int getResolution()

Gets the resolution of the preview images in DPI (dots per inch).

getWidth

public final int getWidth()

Gets or sets preview images width.

setHeight

public final void setHeight(int value)

Gets or sets preview images height.

setHideSignatures

public final void setHideSignatures(boolean value)

Gets or sets flag to hide signatures from page preview image. Only signatures are marked as IsSignature will be hidden from generated document page image.

setPageNumbers

public final void setPageNumbers(int[] value)

Gets or sets preview images page numbers.

setPreviewFormat

public final void setPreviewFormat(int value)

Gets or sets preview images format.

setResolution

public final void setResolution(int value)

Sets the resolution of the preview images in DPI (dots per inch).

setWidth

public final void setWidth(int value)

Gets or sets preview images width.