Package com.groupdocs.cloud.annotation.model

Class PreviewOptions

java.lang.Object

com.groupdocs.cloud.annotation.model.PreviewOptions

public class PreviewOptions
extends Object

Represents options for GetPages API method

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PreviewOptions.FormatEnum	Preview format.

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	fontsPath(String fontsPath)
PreviewOptions	format(PreviewOptions.FormatEnum format)
FileInfo	getFileInfo()	Input document description
String	getFontsPath()	The path to directory containing custom fonts in storage
PreviewOptions.FormatEnum	getFormat()	Preview format.
Integer	getHeight()	Preview image height.
List<Integer>	getPageNumbers()	Page numbers to preview.
Boolean	getRenderAnnotations()	The property that controls whether annotations will be generated on the preview.
Boolean	getRenderComments()	Render document comments.
Integer	getResolution()	Gets or sets the resolution for generated images, in dots per inch.
Integer	getWidth()	Preview image width.
int	hashCode()
PreviewOptions	height(Integer height)
PreviewOptions	pageNumbers(List<Integer> pageNumbers)
PreviewOptions	renderAnnotations(Boolean renderAnnotations)
PreviewOptions	renderComments(Boolean renderComments)
PreviewOptions	resolution(Integer resolution)
void	setFileInfo(FileInfo fileInfo)
void	setFontsPath(String fontsPath)
void	setFormat(PreviewOptions.FormatEnum format)
void	setHeight(Integer height)
void	setPageNumbers(List<Integer> pageNumbers)
void	setRenderAnnotations(Boolean renderAnnotations)
void	setRenderComments(Boolean renderComments)
void	setResolution(Integer resolution)
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()

Input document description

Returns:

fileInfo

setFileInfo

public void setFileInfo(FileInfo fileInfo)

format

public PreviewOptions format(PreviewOptions.FormatEnum format)

getFormat

public PreviewOptions.FormatEnum getFormat()

Preview format. Supported values are: PNG, JPEG or BMP. Default value is PNG.

Returns:

format

setFormat

public void setFormat(PreviewOptions.FormatEnum format)

pageNumbers

public PreviewOptions pageNumbers(List<Integer> pageNumbers)

addPageNumbersItem

public PreviewOptions addPageNumbersItem(Integer pageNumbersItem)

getPageNumbers

public List<Integer> getPageNumbers()

Page numbers to preview. All pages proceeded if not specified.

Returns:

pageNumbers

setPageNumbers

public void setPageNumbers(List<Integer> pageNumbers)

width

public PreviewOptions width(Integer width)

getWidth

public Integer getWidth()

Preview image width. Not required. Default width used if not specified or 0.

Returns:

width

setWidth

public void setWidth(Integer width)

height

public PreviewOptions height(Integer height)

getHeight

public Integer getHeight()

Preview image height. Not required. Default width used if not specified or 0.

Returns:

height

setHeight

public void setHeight(Integer height)

resolution

public PreviewOptions resolution(Integer resolution)

getResolution

public Integer getResolution()

Gets or sets the resolution for generated images, in dots per inch. The default value is 96.

Returns:

resolution

setResolution

public void setResolution(Integer resolution)

renderComments

public PreviewOptions renderComments(Boolean renderComments)

getRenderComments

public Boolean getRenderComments()

Render document comments. Default value is 'false'.

Returns:

renderComments

setRenderComments

public void setRenderComments(Boolean renderComments)

renderAnnotations

public PreviewOptions renderAnnotations(Boolean renderAnnotations)

getRenderAnnotations

public Boolean getRenderAnnotations()

The property that controls whether annotations will be generated on the preview. Default State - true.

Returns:

renderAnnotations

setRenderAnnotations

public void setRenderAnnotations(Boolean renderAnnotations)

fontsPath

public PreviewOptions fontsPath(String fontsPath)

getFontsPath

public String getFontsPath()

The path to directory containing custom fonts in storage

Returns:

fontsPath

setFontsPath

public void setFontsPath(String fontsPath)

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