com.groupdocs.merger.domain.options

Class PreviewOptions

java.lang.Object

com.groupdocs.merger.domain.options.PageOptions

com.groupdocs.merger.domain.options.PreviewOptions

All Implemented Interfaces:

IOptions, IPageOptions, IPreviewOptions

public class PreviewOptions
extends PageOptions
implements IPreviewOptions

Represents document preview options.

Constructor Summary

Constructors

Constructor and Description
PreviewOptions(PageStreamFactory pageStreamFactory, int previewMode) Initializes a new instance of the PreviewOptions class.
PreviewOptions(PageStreamFactory pageStreamFactory, int previewMode, int[] pageNumbers) Initializes a new instance of the PreviewOptions class.
PreviewOptions(PageStreamFactory pageStreamFactory, int previewMode, int startNumber, int endNumber) Initializes a new instance of the PreviewOptions class.
PreviewOptions(PageStreamFactory pageStreamFactory, int previewMode, int startNumber, int endNumber, int mode) Initializes a new instance of the PreviewOptions class.

Method Summary

Modifier and Type	Method and Description
int	getHeight() Preview height.
int	getMode() Mode for preview.
PageStreamFactory	getPageStreamFactory() PageStreamFactory for create or release output page preview stream.
String	getPathByPageNumber(int pageNumber, String extension) Gets the full file path of previewed document by page number with defined extension.
int	getResolution() Image resolution.
int	getWidth() Preview width.
void	setHeight(int value) Preview height.
void	setResolution(int value) Image resolution.
void	setWidth(int value) Preview width.
void	validate(FileType fileType) Validates the preview options.

Methods inherited from class com.groupdocs.merger.domain.options.PageOptions

pages

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.groupdocs.merger.domain.options.interfaces.IPageOptions

getPages

Constructor Detail

PreviewOptions

public PreviewOptions(PageStreamFactory pageStreamFactory,
                      int previewMode)

Initializes a new instance of the PreviewOptions class.

Parameters:

pageStreamFactory - The method that instantiates stream used to write output page data.

previewMode - The preview mode of Mode(getMode()/setMode(int))

PreviewOptions

public PreviewOptions(PageStreamFactory pageStreamFactory,
                      int previewMode,
                      int[] pageNumbers)

Initializes a new instance of the PreviewOptions class.

Parameters:

pageStreamFactory - The method that instantiates stream used to write output page data.

previewMode - The preview mode of Mode(getMode()/setMode(int))

pageNumbers - Page numbers.

PreviewOptions

public PreviewOptions(PageStreamFactory pageStreamFactory,
                      int previewMode,
                      int startNumber,
                      int endNumber)
               throws Exception

Initializes a new instance of the PreviewOptions class.

Parameters:

pageStreamFactory - The method that instantiates stream used to write output page data.

previewMode - The preview mode of Mode(getMode()/setMode(int))

startNumber - The start page number.

endNumber - The end page number.

Throws:

Exception

PreviewOptions

public PreviewOptions(PageStreamFactory pageStreamFactory,
                      int previewMode,
                      int startNumber,
                      int endNumber,
                      int mode)
               throws Exception

Initializes a new instance of the PreviewOptions class.

Parameters:

pageStreamFactory - The method that instantiates stream used to write output page data.

previewMode - The preview mode of Mode(getMode()/setMode(int))

startNumber - The start page number.

endNumber - The end page number.

mode - The range mode.

Throws:

Exception

Method Detail

getHeight

public final int getHeight()

Preview height.

Specified by:

getHeight in interface IPreviewOptions

getMode

public final int getMode()

Mode for preview.

Specified by:

getMode in interface IPreviewOptions

getPageStreamFactory

public PageStreamFactory getPageStreamFactory()

PageStreamFactory for create or release output page preview stream.

Specified by:

getPageStreamFactory in interface IPreviewOptions

getPathByPageNumber

public final String getPathByPageNumber(int pageNumber,
                                        String extension)

Gets the full file path of previewed document by page number with defined extension.

Specified by:

getPathByPageNumber in interface IPreviewOptions

Parameters:

pageNumber - Page number of preview.

extension - Extension of file.

Returns:

The full file path.

getResolution

public final int getResolution()

Image resolution.

Specified by:

getResolution in interface IPreviewOptions

getWidth

public final int getWidth()

Preview width.

Specified by:

getWidth in interface IPreviewOptions

setHeight

public final void setHeight(int value)

Preview height.

Specified by:

setHeight in interface IPreviewOptions

setResolution

public final void setResolution(int value)

Image resolution.

Specified by:

setResolution in interface IPreviewOptions

setWidth

public final void setWidth(int value)

Preview width.

Specified by:

setWidth in interface IPreviewOptions

validate

public final void validate(FileType fileType)
                    throws Exception

Validates the preview options.

Specified by:

validate in interface IPreviewOptions

Parameters:

fileType - The file type.

Throws:

Exception