Package com.groupdocs.cloud.annotation.model

Class AnnotationInfo

java.lang.Object

com.groupdocs.cloud.annotation.model.AnnotationInfo

public class AnnotationInfo
extends Object

Describes annotation properties

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AnnotationInfo.HorizontalAlignmentEnum	Gets or sets text horizontal alignment
static class	AnnotationInfo.PenStyleEnum	Gets or sets the annotation's pen style
static class	AnnotationInfo.TypeEnum	Gets or sets the annotation type
static class	AnnotationInfo.VerticalAlignmentEnum	Gets or sets text vertical alignment

Constructor Summary

Constructors

Constructor	Description
AnnotationInfo()

Method Summary

Modifier and Type	Method	Description
AnnotationInfo	addPointsItem(Point pointsItem)
AnnotationInfo	addRepliesItem(AnnotationReplyInfo repliesItem)
AnnotationInfo	angle(Double angle)
AnnotationInfo	annotationPosition(Point annotationPosition)
AnnotationInfo	autoScale(Boolean autoScale)
AnnotationInfo	backgroundColor(Integer backgroundColor)
AnnotationInfo	box(Rectangle box)
AnnotationInfo	createdOn(org.threeten.bp.OffsetDateTime createdOn)
AnnotationInfo	creatorEmail(String creatorEmail)
AnnotationInfo	creatorId(Integer creatorId)
AnnotationInfo	creatorName(String creatorName)
boolean	equals(Object o)
AnnotationInfo	fontColor(Integer fontColor)
AnnotationInfo	fontFamily(String fontFamily)
AnnotationInfo	fontSize(Double fontSize)
Double	getAngle()	Gets or sets the watermark annotation's rotation angle
Point	getAnnotationPosition()	Gets or sets the annotation position
Boolean	getAutoScale()	Sets auto scale for watermark annotation
Integer	getBackgroundColor()	Gets or sets the annotation's background color
Rectangle	getBox()	Gets or sets the box where annotation will be placed
org.threeten.bp.OffsetDateTime	getCreatedOn()	Gets or sets the annotation created on date
String	getCreatorEmail()	Gets or sets the creator's email
Integer	getCreatorId()	Gets or sets the creator unique identifier
String	getCreatorName()	Gets or sets the name of the creator
Integer	getFontColor()	Gets or sets the annotation's font color
String	getFontFamily()	Gets or sets the annotation's font family
Double	getFontSize()	Gets or sets the annotation's font size
AnnotationInfo.HorizontalAlignmentEnum	getHorizontalAlignment()	Gets or sets text horizontal alignment
Integer	getId()	Gets or sets the unique identifier
String	getImagePath()	Gets or sets image file path in cloud storage, for Image annotations
Double	getOpacity()	Gets or sets the annotation's opacity
Integer	getPageNumber()	Gets or sets the number of page where annotation will be placed
Integer	getPenColor()	Gets or sets the annotation's pen color
AnnotationInfo.PenStyleEnum	getPenStyle()	Gets or sets the annotation's pen style
Integer	getPenWidth()	Gets or sets the annotation's pen width
List<Point>	getPoints()	Gets or sets collection of points that describe rectangles with text
List<AnnotationReplyInfo>	getReplies()	Gets or sets the array of annotation replies
Integer	getSquigglyColor()	Gets or sets annotation color
String	getSvgPath()	Gets or sets the annotation SVG path
String	getText()	Gets or sets the annotation text
String	getTextToReplace()	GGets or sets text to be replaced
AnnotationInfo.TypeEnum	getType()	Gets or sets the annotation type
String	getUrl()	Gets or sets annotation link url
AnnotationInfo.VerticalAlignmentEnum	getVerticalAlignment()	Gets or sets text vertical alignment
Integer	getZindex()	Gets or sets z-index.
int	hashCode()
AnnotationInfo	horizontalAlignment(AnnotationInfo.HorizontalAlignmentEnum horizontalAlignment)
AnnotationInfo	id(Integer id)
AnnotationInfo	imagePath(String imagePath)
AnnotationInfo	opacity(Double opacity)
AnnotationInfo	pageNumber(Integer pageNumber)
AnnotationInfo	penColor(Integer penColor)
AnnotationInfo	penStyle(AnnotationInfo.PenStyleEnum penStyle)
AnnotationInfo	penWidth(Integer penWidth)
AnnotationInfo	points(List<Point> points)
AnnotationInfo	replies(List<AnnotationReplyInfo> replies)
void	setAngle(Double angle)
void	setAnnotationPosition(Point annotationPosition)
void	setAutoScale(Boolean autoScale)
void	setBackgroundColor(Integer backgroundColor)
void	setBox(Rectangle box)
void	setCreatedOn(org.threeten.bp.OffsetDateTime createdOn)
void	setCreatorEmail(String creatorEmail)
void	setCreatorId(Integer creatorId)
void	setCreatorName(String creatorName)
void	setFontColor(Integer fontColor)
void	setFontFamily(String fontFamily)
void	setFontSize(Double fontSize)
void	setHorizontalAlignment(AnnotationInfo.HorizontalAlignmentEnum horizontalAlignment)
void	setId(Integer id)
void	setImagePath(String imagePath)
void	setOpacity(Double opacity)
void	setPageNumber(Integer pageNumber)
void	setPenColor(Integer penColor)
void	setPenStyle(AnnotationInfo.PenStyleEnum penStyle)
void	setPenWidth(Integer penWidth)
void	setPoints(List<Point> points)
void	setReplies(List<AnnotationReplyInfo> replies)
void	setSquigglyColor(Integer squigglyColor)
void	setSvgPath(String svgPath)
void	setText(String text)
void	setTextToReplace(String textToReplace)
void	setType(AnnotationInfo.TypeEnum type)
void	setUrl(String url)
void	setVerticalAlignment(AnnotationInfo.VerticalAlignmentEnum verticalAlignment)
void	setZindex(Integer zindex)
AnnotationInfo	squigglyColor(Integer squigglyColor)
AnnotationInfo	svgPath(String svgPath)
AnnotationInfo	text(String text)
AnnotationInfo	textToReplace(String textToReplace)
String	toString()
AnnotationInfo	type(AnnotationInfo.TypeEnum type)
AnnotationInfo	url(String url)
AnnotationInfo	verticalAlignment(AnnotationInfo.VerticalAlignmentEnum verticalAlignment)
AnnotationInfo	zindex(Integer zindex)

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotationInfo

public AnnotationInfo()

Method Detail

id

public AnnotationInfo id(Integer id)

getId

public Integer getId()

Gets or sets the unique identifier

Returns:

id

setId

public void setId(Integer id)

text

public AnnotationInfo text(String text)

getText

public String getText()

Gets or sets the annotation text

Returns:

text

setText

public void setText(String text)

textToReplace

public AnnotationInfo textToReplace(String textToReplace)

getTextToReplace

public String getTextToReplace()

GGets or sets text to be replaced

Returns:

textToReplace

setTextToReplace

public void setTextToReplace(String textToReplace)

horizontalAlignment

public AnnotationInfo horizontalAlignment(AnnotationInfo.HorizontalAlignmentEnum horizontalAlignment)

getHorizontalAlignment

public AnnotationInfo.HorizontalAlignmentEnum getHorizontalAlignment()

Gets or sets text horizontal alignment

Returns:

horizontalAlignment

setHorizontalAlignment

public void setHorizontalAlignment(AnnotationInfo.HorizontalAlignmentEnum horizontalAlignment)

verticalAlignment

public AnnotationInfo verticalAlignment(AnnotationInfo.VerticalAlignmentEnum verticalAlignment)

getVerticalAlignment

public AnnotationInfo.VerticalAlignmentEnum getVerticalAlignment()

Gets or sets text vertical alignment

Returns:

verticalAlignment

setVerticalAlignment

public void setVerticalAlignment(AnnotationInfo.VerticalAlignmentEnum verticalAlignment)

creatorId

public AnnotationInfo creatorId(Integer creatorId)

getCreatorId

public Integer getCreatorId()

Gets or sets the creator unique identifier

Returns:

creatorId

setCreatorId

public void setCreatorId(Integer creatorId)

creatorName

public AnnotationInfo creatorName(String creatorName)

getCreatorName

public String getCreatorName()

Gets or sets the name of the creator

Returns:

creatorName

setCreatorName

public void setCreatorName(String creatorName)

creatorEmail

public AnnotationInfo creatorEmail(String creatorEmail)

getCreatorEmail

public String getCreatorEmail()

Gets or sets the creator's email

Returns:

creatorEmail

setCreatorEmail

public void setCreatorEmail(String creatorEmail)

box

public AnnotationInfo box(Rectangle box)

getBox

public Rectangle getBox()

Gets or sets the box where annotation will be placed

Returns:

box

setBox

public void setBox(Rectangle box)

points

public AnnotationInfo points(List<Point> points)

addPointsItem

public AnnotationInfo addPointsItem(Point pointsItem)

getPoints

public List<Point> getPoints()

Gets or sets collection of points that describe rectangles with text

Returns:

points

setPoints

public void setPoints(List<Point> points)

pageNumber

public AnnotationInfo pageNumber(Integer pageNumber)

getPageNumber

public Integer getPageNumber()

Gets or sets the number of page where annotation will be placed

Returns:

pageNumber

setPageNumber

public void setPageNumber(Integer pageNumber)

annotationPosition

public AnnotationInfo annotationPosition(Point annotationPosition)

getAnnotationPosition

public Point getAnnotationPosition()

Gets or sets the annotation position

Returns:

annotationPosition

setAnnotationPosition

public void setAnnotationPosition(Point annotationPosition)

svgPath

public AnnotationInfo svgPath(String svgPath)

getSvgPath

public String getSvgPath()

Gets or sets the annotation SVG path

Returns:

svgPath

setSvgPath

public void setSvgPath(String svgPath)

type

public AnnotationInfo type(AnnotationInfo.TypeEnum type)

getType

public AnnotationInfo.TypeEnum getType()

Gets or sets the annotation type

Returns:

type

setType

public void setType(AnnotationInfo.TypeEnum type)

replies

public AnnotationInfo replies(List<AnnotationReplyInfo> replies)

addRepliesItem

public AnnotationInfo addRepliesItem(AnnotationReplyInfo repliesItem)

getReplies

public List<AnnotationReplyInfo> getReplies()

Gets or sets the array of annotation replies

Returns:

replies

setReplies

public void setReplies(List<AnnotationReplyInfo> replies)

createdOn

public AnnotationInfo createdOn(org.threeten.bp.OffsetDateTime createdOn)

getCreatedOn

public org.threeten.bp.OffsetDateTime getCreatedOn()

Gets or sets the annotation created on date

Returns:

createdOn

setCreatedOn

public void setCreatedOn(org.threeten.bp.OffsetDateTime createdOn)

fontColor

public AnnotationInfo fontColor(Integer fontColor)

getFontColor

public Integer getFontColor()

Gets or sets the annotation's font color

Returns:

fontColor

setFontColor

public void setFontColor(Integer fontColor)

penColor

public AnnotationInfo penColor(Integer penColor)

getPenColor

public Integer getPenColor()

Gets or sets the annotation's pen color

Returns:

penColor

setPenColor

public void setPenColor(Integer penColor)

penWidth

public AnnotationInfo penWidth(Integer penWidth)

getPenWidth

public Integer getPenWidth()

Gets or sets the annotation's pen width

Returns:

penWidth

setPenWidth

public void setPenWidth(Integer penWidth)

penStyle

public AnnotationInfo penStyle(AnnotationInfo.PenStyleEnum penStyle)

getPenStyle

public AnnotationInfo.PenStyleEnum getPenStyle()

Gets or sets the annotation's pen style

Returns:

penStyle

setPenStyle

public void setPenStyle(AnnotationInfo.PenStyleEnum penStyle)

backgroundColor

public AnnotationInfo backgroundColor(Integer backgroundColor)

getBackgroundColor

public Integer getBackgroundColor()

Gets or sets the annotation's background color

Returns:

backgroundColor

setBackgroundColor

public void setBackgroundColor(Integer backgroundColor)

squigglyColor

public AnnotationInfo squigglyColor(Integer squigglyColor)

getSquigglyColor

public Integer getSquigglyColor()

Gets or sets annotation color

Returns:

squigglyColor

setSquigglyColor

public void setSquigglyColor(Integer squigglyColor)

fontFamily

public AnnotationInfo fontFamily(String fontFamily)

getFontFamily

public String getFontFamily()

Gets or sets the annotation's font family

Returns:

fontFamily

setFontFamily

public void setFontFamily(String fontFamily)

fontSize

public AnnotationInfo fontSize(Double fontSize)

getFontSize

public Double getFontSize()

Gets or sets the annotation's font size

Returns:

fontSize

setFontSize

public void setFontSize(Double fontSize)

opacity

public AnnotationInfo opacity(Double opacity)

getOpacity

public Double getOpacity()

Gets or sets the annotation's opacity

Returns:

opacity

setOpacity

public void setOpacity(Double opacity)

angle

public AnnotationInfo angle(Double angle)

getAngle

public Double getAngle()

Gets or sets the watermark annotation's rotation angle

Returns:

angle

setAngle

public void setAngle(Double angle)

zindex

public AnnotationInfo zindex(Integer zindex)

getZindex

public Integer getZindex()

Gets or sets z-index. Default value is 0 The z-index property specifies the stack order of an element.

Returns:

zindex

setZindex

public void setZindex(Integer zindex)

url

public AnnotationInfo url(String url)

getUrl

public String getUrl()

Gets or sets annotation link url

Returns:

url

setUrl

public void setUrl(String url)

imagePath

public AnnotationInfo imagePath(String imagePath)

getImagePath

public String getImagePath()

Gets or sets image file path in cloud storage, for Image annotations

Returns:

imagePath

setImagePath

public void setImagePath(String imagePath)

autoScale

public AnnotationInfo autoScale(Boolean autoScale)

getAutoScale

public Boolean getAutoScale()

Sets auto scale for watermark annotation

Returns:

autoScale

setAutoScale

public void setAutoScale(Boolean autoScale)

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