PreviewOptions Leave feedback
On this page
Inheritance: java.lang.Object
public class PreviewOptions
Represents document preview options.
| 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. |
| 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. |
| getResolution() | Gets the resolution of the preview images in DPI (dots per inch). |
| setResolution(int value) | Sets the resolution of the preview images in DPI (dots per inch). |
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 |
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[] |
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 |
public final int getWidth()
Gets or sets preview images width.
Returns: int
public final void setWidth(int value)
Gets or sets preview images width.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
public final int getHeight()
Gets or sets preview images height.
Returns: int
public final void setHeight(int value)
Gets or sets preview images height.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
public final int[] getPageNumbers()
Gets or sets preview images page numbers.
Returns: int[]
public final void setPageNumbers(int[] value)
Gets or sets preview images page numbers.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int[] |
public final int getPreviewFormat()
Gets or sets preview images format.
Returns: int
public final void setPreviewFormat(int value)
Gets or sets preview images format.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
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
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 |
public final int getResolution()
Gets the resolution of the preview images in DPI (dots per inch).
Returns: int
public final void setResolution(int value)
Sets the resolution of the preview images in DPI (dots per inch).
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.
