com.groupdocs.metadata.options

Class PreviewOptions

java.lang.Object

com.groupdocs.metadata.options.PreviewOptions

public class PreviewOptions
extends Object

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

Constructor Summary

Constructors

Constructor and 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.

Method Summary

Modifier and Type	Method and Description
String	getCacheFolder() Gets the cache folder.
ICreatePageStream	getCreatePageStream() Gets an instance of the page stream creation delegate.
int	getHeight() Gets the page preview height.
int	getMaxDiskSpaceForCache() Gets the maximum available disk space for cache in bytes.
int	getMaxMemoryForCache() Gets the maximum available memory for cache in memory in bytes.
int[]	getPageNumbers() Gets an array of page numbers to generate previews.
PreviewFormats	getPreviewFormat() Gets the preview image format.
IReleasePageStream	getReleasePageStream() Gets an instance of the page preview completion delegate.
int	getResolution() Gets or sets the page preview resolution.
int	getWidth() Gets the page preview width.
void	setCacheFolder(String value) Sets the cache folder.
void	setCreatePageStream(ICreatePageStream value) Sets an instance of the page stream creation delegate.
void	setHeight(int value) Sets the page preview height.
void	setMaxDiskSpaceForCache(int value) Sets the maximum available disk space for cache in bytes.
void	setMaxMemoryForCache(int value) Sets the maximum available memory for cache in memory in bytes.
void	setPageNumbers(int[] value) Sets an array of page numbers to generate previews.
void	setPreviewFormat(PreviewFormats value) Sets the preview image format.
void	setReleasePageStream(IReleasePageStream value) Sets an instance of the page preview completion delegate.
void	setResolution(int value) Gets or sets the page preview resolution.
void	setWidth(int value) Sets the page preview width.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PreviewOptions

public PreviewOptions(ICreatePageStream createPageStream)

Initializes a new instance of the PreviewOptions class causing the output stream to be closed.

Parameters:

createPageStream - Creates a stream for a specific page preview.

PreviewOptions

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:

createPageStream - Creates a stream for a specific page preview

releasePageStream - Notifies that the page preview generation is done and gets the output stream.

Method Detail

getCacheFolder

public final String getCacheFolder()

Gets the cache folder. By default the cache folder is set to user's local temp directory.

Returns:

The cache folder.

getCreatePageStream

public final ICreatePageStream getCreatePageStream()

Gets an instance of the page stream creation delegate.

Returns:

An instance of the page stream creation delegate.

getHeight

public final int getHeight()

Gets the page preview height.

Returns:

The page preview height.

getMaxDiskSpaceForCache

public final int getMaxDiskSpaceForCache()

Gets the maximum available disk space for cache in bytes. The default value is 1073741824.

Returns:

The maximum available disk space for cache in bytes.

getMaxMemoryForCache

public final int getMaxMemoryForCache()

Gets the maximum available memory for cache in memory in bytes. The default value is 1073741824.

Returns:

The maximum available memory for cache in memory in bytes.

getPageNumbers

public final int[] getPageNumbers()

Gets an array of page numbers to generate previews.

Returns:

An array of page numbers to generate previews.

getPreviewFormat

public final PreviewFormats getPreviewFormat()

Gets the preview image format.

Returns:

The preview image format.

getReleasePageStream

public final IReleasePageStream getReleasePageStream()

Gets an instance of the page preview completion delegate.

Returns:

An instance of the page preview completion delegate.

getResolution

public final int getResolution()

Gets or sets the page preview resolution.

getWidth

public final int getWidth()

Gets the page preview width.

Returns:

The page preview width.

setCacheFolder

public final void setCacheFolder(String value)

Sets the cache folder. By default the cache folder is set to user's local temp directory.

Parameters:

value - The cache folder.

setCreatePageStream

public final void setCreatePageStream(ICreatePageStream value)

Sets an instance of the page stream creation delegate.

Parameters:

value - An instance of the page stream creation delegate.

setHeight

public final void setHeight(int value)

Sets the page preview height.

Parameters:

value - The page preview height.

setMaxDiskSpaceForCache

public final void setMaxDiskSpaceForCache(int value)

Sets the maximum available disk space for cache in bytes. The default value is 1073741824.

Parameters:

value - The maximum available disk space for cache in bytes.

setMaxMemoryForCache

public final void setMaxMemoryForCache(int value)

Sets the maximum available memory for cache in memory in bytes. The default value is 1073741824.

Parameters:

value - The maximum available memory for cache in memory in bytes.

setPageNumbers

public final void setPageNumbers(int[] value)

Sets an array of page numbers to generate previews.

Parameters:

value - An array of page numbers to generate previews.

setPreviewFormat

public final void setPreviewFormat(PreviewFormats value)

Sets the preview image format.

Parameters:

value - The preview image format.

setReleasePageStream

public final void setReleasePageStream(IReleasePageStream value)

Sets an instance of the page preview completion delegate.

Parameters:

value - An instance of the page preview completion delegate.

setResolution

public final void setResolution(int value)

Gets or sets the page preview resolution.

setWidth

public final void setWidth(int value)

Sets the page preview width.

Parameters:

value - The page preview width.