Package com.groupdocs.cloud.signature.model

Class PreviewSettings

java.lang.Object

com.groupdocs.cloud.signature.model.BaseSettings

com.groupdocs.cloud.signature.model.PreviewSettings

public class PreviewSettings
extends BaseSettings

Defines preview request settings

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PreviewSettings.PreviewFormatEnum	Preview format

Constructor Summary

Constructors

Constructor	Description
PreviewSettings()

Method Summary

Modifier and Type	Method	Description
PreviewSettings	addPageNumbersItem(Integer pageNumbersItem)
boolean	equals(Object o)
Integer	getHeight()	Preview images height
Boolean	getHideSignatures()	Flag to hide signatures from page preview image.
String	getOutputPath()	Set path for output pages.
List<Integer>	getPageNumbers()	Preview page numbers
PreviewSettings.PreviewFormatEnum	getPreviewFormat()	Preview format
Integer	getResolution()	Gets or sets the resolution of the preview images in DPI (dots per inch).
Integer	getWidth()	Preview images width
int	hashCode()
PreviewSettings	height(Integer height)
PreviewSettings	hideSignatures(Boolean hideSignatures)
PreviewSettings	outputPath(String outputPath)
PreviewSettings	pageNumbers(List<Integer> pageNumbers)
PreviewSettings	previewFormat(PreviewSettings.PreviewFormatEnum previewFormat)
PreviewSettings	resolution(Integer resolution)
void	setHeight(Integer height)
void	setHideSignatures(Boolean hideSignatures)
void	setOutputPath(String outputPath)
void	setPageNumbers(List<Integer> pageNumbers)
void	setPreviewFormat(PreviewSettings.PreviewFormatEnum previewFormat)
void	setResolution(Integer resolution)
void	setWidth(Integer width)
String	toString()
PreviewSettings	width(Integer width)

Methods inherited from class com.groupdocs.cloud.signature.model.BaseSettings

fileInfo, getFileInfo, setFileInfo

Methods inherited from class java.lang.Object

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

Constructor Detail

PreviewSettings

public PreviewSettings()

Method Detail

width

public PreviewSettings width(Integer width)

getWidth

public Integer getWidth()

Preview images width

Returns:

width

setWidth

public void setWidth(Integer width)

height

public PreviewSettings height(Integer height)

getHeight

public Integer getHeight()

Preview images height

Returns:

height

setHeight

public void setHeight(Integer height)

resolution

public PreviewSettings resolution(Integer resolution)

getResolution

public Integer getResolution()

Gets or sets the resolution of the preview images in DPI (dots per inch).

Returns:

resolution

setResolution

public void setResolution(Integer resolution)

pageNumbers

public PreviewSettings pageNumbers(List<Integer> pageNumbers)

addPageNumbersItem

public PreviewSettings addPageNumbersItem(Integer pageNumbersItem)

getPageNumbers

public List<Integer> getPageNumbers()

Preview page numbers

Returns:

pageNumbers

setPageNumbers

public void setPageNumbers(List<Integer> pageNumbers)

previewFormat

public PreviewSettings previewFormat(PreviewSettings.PreviewFormatEnum previewFormat)

getPreviewFormat

public PreviewSettings.PreviewFormatEnum getPreviewFormat()

Preview format

Returns:

previewFormat

setPreviewFormat

public void setPreviewFormat(PreviewSettings.PreviewFormatEnum previewFormat)

hideSignatures

public PreviewSettings hideSignatures(Boolean hideSignatures)

getHideSignatures

public Boolean getHideSignatures()

Flag to hide signatures from page preview image. Only signatures are marked as IsSignature will be hidden from generated document page image

Returns:

hideSignatures

setHideSignatures

public void setHideSignatures(Boolean hideSignatures)

outputPath

public PreviewSettings outputPath(String outputPath)

getOutputPath

public String getOutputPath()

Set path for output pages. If not set then default path used.

Returns:

outputPath

setOutputPath

public void setOutputPath(String outputPath)

equals

public boolean equals(Object o)

Overrides:

equals in class BaseSettings

hashCode

public int hashCode()

Overrides:

hashCode in class BaseSettings

toString

public String toString()

Overrides:

toString in class BaseSettings