PreviewOptions Leave feedback
On this page
Inheritance: java.lang.Object
public class PreviewOptions
Provides options to sets requirements and stream delegates for preview generation.
| Constructor | Description |
|---|---|
| PreviewOptions(ICreatePageStream createPageStream) | Initializes a new instance of PreviewOptions class, causing the output stream to be closed. |
| PreviewOptions(ICreatePageStream createPageStream, IReleasePageStream releasePageStream) | Initializes a new instance of PreviewOptions class, causing the output stream to be returned to the client for further use. |
| Method | Description |
|---|---|
| getWidth() | Gets or sets page preview width. |
| setWidth(int value) | Gets or sets page preview width. |
| getHeight() | Gets or sets page preview height. |
| setHeight(int value) | Gets or sets page preview height. |
| getPageNumbers() | Gets or sets an array of page numbers to generate preview. |
| setPageNumbers(int[] value) | Gets or sets an array of page numbers to generate preview. |
| getPreviewFormat() | Gets or sets preview image format. |
| setPreviewFormat(PreviewFormats value) | Gets or sets preview image format. |
| getCreatePageStream() | Gets or sets an instance of page stream creation delegate. |
| setCreatePageStream(ICreatePageStream value) | Gets or sets an instance of page stream creation delegate. |
| getReleasePageStream() | Gets or sets an instance of page preview completion delegate. |
| setReleasePageStream(IReleasePageStream value) | Gets or sets an instance of page preview completion delegate. |
public PreviewOptions(ICreatePageStream createPageStream)
Initializes a new instance of PreviewOptions class, causing the output stream to be closed.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| createPageStream | ICreatePageStream | Creates a stream for a specific page preview |
public PreviewOptions(ICreatePageStream createPageStream, IReleasePageStream releasePageStream)
Initializes a new instance of PreviewOptions class, causing the output stream to be returned to the client for further use.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| createPageStream | ICreatePageStream | Creates a stream for a specific page preview |
| releasePageStream | IReleasePageStream | Notifies that the page preview generation is done and gets output stream |
public final int getWidth()
Gets or sets page preview width.
Returns: int - Page preview width.
public final void setWidth(int value)
Gets or sets page preview width.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | Page preview width. |
public final int getHeight()
Gets or sets page preview height.
Returns: int - Page preview height.
public final void setHeight(int value)
Gets or sets page preview height.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | Page preview height. |
public final int[] getPageNumbers()
Gets or sets an array of page numbers to generate preview.
Returns: int[] - An array of page numbers to generate preview.
public final void setPageNumbers(int[] value)
Gets or sets an array of page numbers to generate preview.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int[] | An array of page numbers to generate preview. |
public final PreviewFormats getPreviewFormat()
Gets or sets preview image format.
Returns: PreviewFormats - Preview image format.
public final void setPreviewFormat(PreviewFormats value)
Gets or sets preview image format.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | PreviewFormats | Preview image format. |
public final ICreatePageStream getCreatePageStream()
Gets or sets an instance of page stream creation delegate.
Returns: ICreatePageStream - An instance of page stream creation delegate.
public final void setCreatePageStream(ICreatePageStream value)
Gets or sets an instance of page stream creation delegate.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | ICreatePageStream | An instance of page stream creation delegate. |
public final IReleasePageStream getReleasePageStream()
Gets or sets an instance of page preview completion delegate.
Returns: IReleasePageStream - An instance of page preview completion delegate.
public final void setReleasePageStream(IReleasePageStream value)
Gets or sets an instance of page preview completion delegate.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | IReleasePageStream | An instance of page preview completion delegate. |
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.