PreviewOptions

Inheritance: java.lang.Object

public class PreviewOptions

Provides options to sets requirements and stream delegates for preview generation.

Constructors

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.

Methods

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.

PreviewOptions(ICreatePageStream createPageStream)

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

PreviewOptions(ICreatePageStream createPageStream, IReleasePageStream releasePageStream)

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

getWidth()

public final int getWidth()

Gets or sets page preview width.

Returns: int - Page preview width.

setWidth(int value)

public final void setWidth(int value)

Gets or sets page preview width.

Parameters:

Parameter	Type	Description
value	int	Page preview width.

getHeight()

public final int getHeight()

Gets or sets page preview height.

Returns: int - Page preview height.

setHeight(int value)

public final void setHeight(int value)

Gets or sets page preview height.

Parameters:

Parameter	Type	Description
value	int	Page preview height.

getPageNumbers()

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.

setPageNumbers(int[] value)

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.

getPreviewFormat()

public final PreviewFormats getPreviewFormat()

Gets or sets preview image format.

Returns: PreviewFormats - Preview image format.

setPreviewFormat(PreviewFormats value)

public final void setPreviewFormat(PreviewFormats value)

Gets or sets preview image format.

Parameters:

Parameter	Type	Description
value	PreviewFormats	Preview image format.

getCreatePageStream()

public final ICreatePageStream getCreatePageStream()

Gets or sets an instance of page stream creation delegate.

Returns: ICreatePageStream - An instance of page stream creation delegate.

setCreatePageStream(ICreatePageStream value)

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.

getReleasePageStream()

public final IReleasePageStream getReleasePageStream()

Gets or sets an instance of page preview completion delegate.

Returns: IReleasePageStream - An instance of page preview completion delegate.

setReleasePageStream(IReleasePageStream value)

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.