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 the 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 the page preview width.
setWidth(int width)	Sets the page preview width.
getHeight()	Gets the page preview height.
setHeight(int height)	Sets the page preview height.
getDpi()	Gets a dpi.
setDpi(int dpi)	Sets a dpi.
getPageNumbers()	Gets an array of page numbers to generate previews.
setPageNumbers(int[] pageNumbers)	Sets an array of page numbers to generate previews.
getPreviewFormat()	Gets the preview image format.
setPreviewFormat(PreviewFormats previewFormat)	Sets the preview image format.
getCreatePageStream()	Gets an instance of the page stream creation delegate.
setCreatePageStream(ICreatePageStream createPageStream)	Sets an instance of the page stream creation delegate.
getReleasePageStream()	Gets an instance of the page preview completion delegate.
setReleasePageStream(IReleasePageStream releasePageStream)	Sets an instance of the page preview completion delegate.
getPreviewPageRender()	Gets an instance of the page preview render info delegate.
setPreviewPageRender(IPreviewPageRender previewPageRender)	Sets an instance of the page preview render info delegate.

PreviewOptions(ICreatePageStream createPageStream)

public PreviewOptions(ICreatePageStream createPageStream)

Initializes a new instance of the 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 the output stream.

getWidth()

public int getWidth()

Gets the page preview width.

Returns: int - The page width.

setWidth(int width)

public void setWidth(int width)

Sets the page preview width.

Parameters:

Parameter	Type	Description
width	int	The page width.

getHeight()

public int getHeight()

Gets the page preview height.

Returns: int - The page height.

setHeight(int height)

public void setHeight(int height)

Sets the page preview height.

Parameters:

Parameter	Type	Description
height	int	The page height.

getDpi()

public int getDpi()

Gets a dpi.

Returns: int - An integer value that represents a dpi.

setDpi(int dpi)

public void setDpi(int dpi)

Sets a dpi.

Parameters:

Parameter	Type	Description
dpi	int	The dpi.

getPageNumbers()

public int[] getPageNumbers()

Gets an array of page numbers to generate previews.

Returns: int[] - A collection of page numbers.

setPageNumbers(int[] pageNumbers)

public void setPageNumbers(int[] pageNumbers)

Sets an array of page numbers to generate previews.

Parameters:

Parameter	Type	Description
pageNumbers	int[]	A collection of page numbers.

getPreviewFormat()

public PreviewFormats getPreviewFormat()

Gets the preview image format.

Returns: PreviewFormats - PreviewFormats numeration.

setPreviewFormat(PreviewFormats previewFormat)

public void setPreviewFormat(PreviewFormats previewFormat)

Sets the preview image format.

Parameters:

Parameter	Type	Description
previewFormat	PreviewFormats	The preview format.

getCreatePageStream()

public ICreatePageStream getCreatePageStream()

Gets an instance of the page stream creation delegate.

Returns: ICreatePageStream - The page stream creation delegate.

setCreatePageStream(ICreatePageStream createPageStream)

public void setCreatePageStream(ICreatePageStream createPageStream)

Sets an instance of the page stream creation delegate.

Parameters:

Parameter	Type	Description
createPageStream	ICreatePageStream	The page stream creation delegate.

getReleasePageStream()

public IReleasePageStream getReleasePageStream()

Gets an instance of the page preview completion delegate.

Returns: IReleasePageStream - The page preview completion delegate.

setReleasePageStream(IReleasePageStream releasePageStream)

public void setReleasePageStream(IReleasePageStream releasePageStream)

Sets an instance of the page preview completion delegate.

Parameters:

Parameter	Type	Description
releasePageStream	IReleasePageStream	The page preview completion delegate.

getPreviewPageRender()

public IPreviewPageRender getPreviewPageRender()

Gets an instance of the page preview render info delegate.

Returns: IPreviewPageRender - The page preview render info delegate.

setPreviewPageRender(IPreviewPageRender previewPageRender)

public void setPreviewPageRender(IPreviewPageRender previewPageRender)

Sets an instance of the page preview render info delegate.

Parameters:

Parameter	Type	Description
previewPageRender	IPreviewPageRender	The page preview render info delegate.