PreviewOptions

Inheritance: java.lang.Object

public class PreviewOptions

Represents document preview options.

Constructors

Constructor	Description
PreviewOptions(PageStreamFactory pageStreamFactory, int[] pageNumbers)	Initializes PreviewOptions object.
PreviewOptions(PageDataStreamFactory pageDataStreamFactory, int[] pageNumbers)	Initializes PreviewOptions object.
PreviewOptions(String filePathFormat, int[] pageNumbers)	Initializes PreviewOptions object.

Methods

Method	Description
getWidth()	Gets or sets preview images width.
setWidth(int value)	Gets or sets preview images width.
getHeight()	Gets or sets preview images height.
setHeight(int value)	Gets or sets preview images height.
getPageNumbers()	Gets or sets preview images page numbers.
setPageNumbers(int[] value)	Gets or sets preview images page numbers.
getPreviewFormat()	Gets or sets preview images format.
setPreviewFormat(int value)	Gets or sets preview images format.
getHideSignatures()	Gets or sets flag to hide signatures from page preview image.
setHideSignatures(boolean value)	Gets or sets flag to hide signatures from page preview image.

PreviewOptions(PageStreamFactory pageStreamFactory, int[] pageNumbers)

public PreviewOptions(PageStreamFactory pageStreamFactory, int[] pageNumbers)

Initializes PreviewOptions object.

Parameters:

Parameter	Type	Description
pageStreamFactory	PageStreamFactory	Interface which defines method to create output page preview stream.
pageNumbers	int[]	Desired page numbers

PreviewOptions(PageDataStreamFactory pageDataStreamFactory, int[] pageNumbers)

public PreviewOptions(PageDataStreamFactory pageDataStreamFactory, int[] pageNumbers)

Initializes PreviewOptions object.

Parameters:

Parameter	Type	Description
pageDataStreamFactory	PageDataStreamFactory	Interface which defines method to create output page preview stream.
pageNumbers	int[]

PreviewOptions(String filePathFormat, int[] pageNumbers)

public PreviewOptions(String filePathFormat, int[] pageNumbers)

Initializes PreviewOptions object.

Parameters:

Parameter	Type	Description
filePathFormat	java.lang.String	Path to output file.
pageNumbers	int[]	Desired page numbers

getWidth()

public final int getWidth()

Gets or sets preview images width.

Returns: int

setWidth(int value)

public final void setWidth(int value)

Gets or sets preview images width.

Parameters:

Parameter	Type	Description
value	int

getHeight()

public final int getHeight()

Gets or sets preview images height.

Returns: int

setHeight(int value)

public final void setHeight(int value)

Gets or sets preview images height.

Parameters:

Parameter	Type	Description
value	int

getPageNumbers()

public final int[] getPageNumbers()

Gets or sets preview images page numbers.

Returns: int[]

setPageNumbers(int[] value)

public final void setPageNumbers(int[] value)

Gets or sets preview images page numbers.

Parameters:

Parameter	Type	Description
value	int[]

getPreviewFormat()

public final int getPreviewFormat()

Gets or sets preview images format.

Returns: int

setPreviewFormat(int value)

public final void setPreviewFormat(int value)

Gets or sets preview images format.

Parameters:

Parameter	Type	Description
value	int

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.

Returns: boolean

setHideSignatures(boolean value)

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.

Parameters:

Parameter	Type	Description
value	boolean