Package com.groupdocs.cloud.watermark.model

Class PreviewOptions

java.lang.Object

com.groupdocs.cloud.watermark.model.PreviewOptions

public class PreviewOptions
extends Object

Document preview options.

Constructor Summary

Constructors

Constructor	Description
PreviewOptions()

Method Summary

Modifier and Type	Method	Description
PreviewOptions	addPageNumbersItem(Integer pageNumbersItem)
boolean	equals(Object o)
PreviewOptions	fileInfo(FileInfo fileInfo)
PreviewOptions	format(String format)
FileInfo	getFileInfo()	Gets or sets the file information.
String	getFormat()	Gets or sets the image format: PNG, JPEG or BMP.
Integer	getHeight()	Gets or sets the image height in pixels.
String	getOutputFolder()	Gets or sets the folder for the page images.
List<Integer>	getPageNumbers()	Gets or sets the numbers of the pages to preview, starting from 1.
Integer	getWidth()	Gets or sets the image width in pixels.
int	hashCode()
PreviewOptions	height(Integer height)
PreviewOptions	outputFolder(String outputFolder)
PreviewOptions	pageNumbers(List<Integer> pageNumbers)
void	setFileInfo(FileInfo fileInfo)
void	setFormat(String format)
void	setHeight(Integer height)
void	setOutputFolder(String outputFolder)
void	setPageNumbers(List<Integer> pageNumbers)
void	setWidth(Integer width)
String	toString()
PreviewOptions	width(Integer width)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PreviewOptions

public PreviewOptions()

Method Detail

fileInfo

public PreviewOptions fileInfo(FileInfo fileInfo)

getFileInfo

public FileInfo getFileInfo()

Gets or sets the file information.

Returns:

fileInfo

setFileInfo

public void setFileInfo(FileInfo fileInfo)

outputFolder

public PreviewOptions outputFolder(String outputFolder)

getOutputFolder

public String getOutputFolder()

Gets or sets the folder for the page images. When not set, the default folder is used.

Returns:

outputFolder

setOutputFolder

public void setOutputFolder(String outputFolder)

format

public PreviewOptions format(String format)

getFormat

public String getFormat()

Gets or sets the image format: PNG, JPEG or BMP. Default is PNG.

Returns:

format

setFormat

public void setFormat(String format)

width

public PreviewOptions width(Integer width)

getWidth

public Integer getWidth()

Gets or sets the image width in pixels. Width and Height must be set together; when not set, the original page size is used.

Returns:

width

setWidth

public void setWidth(Integer width)

height

public PreviewOptions height(Integer height)

getHeight

public Integer getHeight()

Gets or sets the image height in pixels. Width and Height must be set together; when not set, the original page size is used.

Returns:

height

setHeight

public void setHeight(Integer height)

pageNumbers

public PreviewOptions pageNumbers(List<Integer> pageNumbers)

addPageNumbersItem

public PreviewOptions addPageNumbersItem(Integer pageNumbersItem)

getPageNumbers

public List<Integer> getPageNumbers()

Gets or sets the numbers of the pages to preview, starting from 1. When empty, all pages are previewed; pages that do not exist are skipped.

Returns:

pageNumbers

setPageNumbers

public void setPageNumbers(List<Integer> pageNumbers)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object