Package com.groupdocs.cloud.annotation.model

Class AnnotateOptions

java.lang.Object

com.groupdocs.cloud.annotation.model.AnnotateOptions

public class AnnotateOptions
extends Object

Defines options for annotating documents

Constructor Summary

Constructors

Constructor	Description
AnnotateOptions()

Method Summary

Modifier and Type	Method	Description
AnnotateOptions	addAnnotationsItem(AnnotationInfo annotationsItem)
AnnotateOptions	annotations(List<AnnotationInfo> annotations)
boolean	equals(Object o)
AnnotateOptions	fileInfo(FileInfo fileInfo)
AnnotateOptions	firstPage(Integer firstPage)
AnnotateOptions	fontsPath(String fontsPath)
List<AnnotationInfo>	getAnnotations()	List of annotations to add to the document
FileInfo	getFileInfo()	Input document description
Integer	getFirstPage()	First page number when saving page range
String	getFontsPath()	The path to directory containing custom fonts in storage
Integer	getLastPage()	Last page number when saving page range
Boolean	getOnlyAnnotatedPages()	Indicates whether to save only annotated pages
String	getOutputPath()	Path to output document in the cloud storage.
int	hashCode()
AnnotateOptions	lastPage(Integer lastPage)
AnnotateOptions	onlyAnnotatedPages(Boolean onlyAnnotatedPages)
AnnotateOptions	outputPath(String outputPath)
void	setAnnotations(List<AnnotationInfo> annotations)
void	setFileInfo(FileInfo fileInfo)
void	setFirstPage(Integer firstPage)
void	setFontsPath(String fontsPath)
void	setLastPage(Integer lastPage)
void	setOnlyAnnotatedPages(Boolean onlyAnnotatedPages)
void	setOutputPath(String outputPath)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotateOptions

public AnnotateOptions()

Method Detail

fileInfo

public AnnotateOptions fileInfo(FileInfo fileInfo)

getFileInfo

public FileInfo getFileInfo()

Input document description

Returns:

fileInfo

setFileInfo

public void setFileInfo(FileInfo fileInfo)

annotations

public AnnotateOptions annotations(List<AnnotationInfo> annotations)

addAnnotationsItem

public AnnotateOptions addAnnotationsItem(AnnotationInfo annotationsItem)

getAnnotations

public List<AnnotationInfo> getAnnotations()

List of annotations to add to the document

Returns:

annotations

setAnnotations

public void setAnnotations(List<AnnotationInfo> annotations)

firstPage

public AnnotateOptions firstPage(Integer firstPage)

getFirstPage

public Integer getFirstPage()

First page number when saving page range

Returns:

firstPage

setFirstPage

public void setFirstPage(Integer firstPage)

lastPage

public AnnotateOptions lastPage(Integer lastPage)

getLastPage

public Integer getLastPage()

Last page number when saving page range

Returns:

lastPage

setLastPage

public void setLastPage(Integer lastPage)

onlyAnnotatedPages

public AnnotateOptions onlyAnnotatedPages(Boolean onlyAnnotatedPages)

getOnlyAnnotatedPages

public Boolean getOnlyAnnotatedPages()

Indicates whether to save only annotated pages

Returns:

onlyAnnotatedPages

setOnlyAnnotatedPages

public void setOnlyAnnotatedPages(Boolean onlyAnnotatedPages)

outputPath

public AnnotateOptions outputPath(String outputPath)

getOutputPath

public String getOutputPath()

Path to output document in the cloud storage. Required for Add method. Not required if Annotate (with file result) method used.

Returns:

outputPath

setOutputPath

public void setOutputPath(String outputPath)

fontsPath

public AnnotateOptions 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