| java.lang.Object | |
| ↳ | com.pdftron.collab.db.entity.AnnotationEntity |
Class Overview
Immutable model class for an annotation
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| AnnotationEntity() | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| String | getAt() | ||||||||||
| String |
getAuthorId()
Gets the unique identifier of the author
| ||||||||||
| String |
getAuthorName()
Gets the author name
| ||||||||||
| int |
getColor()
Gets the tint color to be shown in annotation list
| ||||||||||
| String |
getContents()
Gets the contents
| ||||||||||
| Date |
getCreationDate()
Gets the creation date
| ||||||||||
| Date |
getDate()
Gets the date
| ||||||||||
| String |
getDocumentId()
Gets the unique identifier of the document
| ||||||||||
| String |
getId()
Gets the unique identifier of the annotation
| ||||||||||
| String |
getInReplyTo()
Gets the IRT of this annotation
| ||||||||||
| String |
getLastReplyAuthor()
Gets the last reply author
| ||||||||||
| String |
getLastReplyContents()
Gets the last reply contents
| ||||||||||
| Date |
getLastReplyDate()
Gets the last reply date
| ||||||||||
| float |
getOpacity()
Gets the opacity to be shown in annotation list
| ||||||||||
| int |
getPage()
Gets the page the annotation is on
| ||||||||||
| String | getParent() | ||||||||||
| int |
getReviewState()
Gets the review state, -1 if no state
| ||||||||||
| String |
getServerId()
Gets the server database id if different from the annotation id
| ||||||||||
| int |
getType()
Gets the annotation type
| ||||||||||
| int |
getUnreadCount()
Gets the unread reply count
| ||||||||||
| String |
getUnreads()
Gets the unread reply IDs
| ||||||||||
| String |
getXfdf()
Gets the XFDF of this annotation
| ||||||||||
| double |
getYPos()
Gets the y position
| ||||||||||
| void | setAt(String at) | ||||||||||
| void |
setAuthorId(String authorId)
Sets the unique identifier of the author
| ||||||||||
| void |
setAuthorName(String authorName)
Sets the author name
| ||||||||||
| void |
setColor(int color)
Sets the tint color to be shown in annotation list
| ||||||||||
| void |
setContents(String contents)
Sets the contents
| ||||||||||
| void |
setCreationDate(Date creationDate)
Sets the creation date
| ||||||||||
| void |
setDate(Date date)
Sets the date
| ||||||||||
| void |
setDocumentId(String documentId)
Sets the unique identifier of the document
| ||||||||||
| void |
setId(String id)
Sets the unique identifier of the annotation
| ||||||||||
| void |
setInReplyTo(String inReplyTo)
Sets the IRT of this annotation
| ||||||||||
| void |
setLastReplyAuthor(String lastReplyAuthor)
Sets the last reply author
| ||||||||||
| void |
setLastReplyContents(String lastReplyContents)
Sets the last reply contents
| ||||||||||
| void |
setLastReplyDate(Date lastReplyDate)
Sets the last reply date
| ||||||||||
| void |
setOpacity(float opacity)
Sets the opacity to be shown in annotation list
| ||||||||||
| void |
setPage(int page)
Sets the page the annotation is on
| ||||||||||
| void | setParent(String parent) | ||||||||||
| void |
setReviewState(int reviewState)
Sets the review state, -1 if no state
| ||||||||||
| void |
setServerId(String serverId)
Sets the server database id if different from annotation id
| ||||||||||
| void |
setType(int type)
Sets the annotation type
| ||||||||||
| void |
setUnreadCount(int unreadCount)
Sets the unread reply count
| ||||||||||
| void |
setUnreads(String unreads)
Sets the unread reply IDs
| ||||||||||
| void |
setXfdf(String xfdf)
Sets the XFDF of this annotation
In the database, this is represented by a local file path to the XFDF string
| ||||||||||
| void |
setYPos(double yPos)
Sets the y position
| ||||||||||
| String | toString() | ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
|
From interface
com.pdftron.collab.model.Annotation
| |||||||||||
Public Constructors
public AnnotationEntity ()
Public Methods
public String getAt ()
public String getAuthorId ()
Gets the unique identifier of the author
public String getAuthorName ()
Gets the author name
public int getColor ()
Gets the tint color to be shown in annotation list
public String getContents ()
Gets the contents
public Date getCreationDate ()
Gets the creation date
public Date getDate ()
Gets the date
public String getDocumentId ()
Gets the unique identifier of the document
public String getId ()
Gets the unique identifier of the annotation
public String getInReplyTo ()
Gets the IRT of this annotation
public String getLastReplyAuthor ()
Gets the last reply author
public String getLastReplyContents ()
Gets the last reply contents
public Date getLastReplyDate ()
Gets the last reply date
public float getOpacity ()
Gets the opacity to be shown in annotation list
public int getPage ()
Gets the page the annotation is on
public String getParent ()
public int getReviewState ()
Gets the review state, -1 if no state
public String getServerId ()
Gets the server database id if different from the annotation id
public int getType ()
Gets the annotation type
public int getUnreadCount ()
Gets the unread reply count
public String getUnreads ()
Gets the unread reply IDs
public String getXfdf ()
Gets the XFDF of this annotation
public double getYPos ()
Gets the y position
public void setAt (String at)
public void setAuthorId (String authorId)
Sets the unique identifier of the author
public void setAuthorName (String authorName)
Sets the author name
public void setColor (int color)
Sets the tint color to be shown in annotation list
public void setContents (String contents)
Sets the contents
public void setCreationDate (Date creationDate)
Sets the creation date
public void setDate (Date date)
Sets the date
public void setDocumentId (String documentId)
Sets the unique identifier of the document
public void setId (String id)
Sets the unique identifier of the annotation
public void setInReplyTo (String inReplyTo)
Sets the IRT of this annotation
public void setLastReplyAuthor (String lastReplyAuthor)
Sets the last reply author
public void setLastReplyContents (String lastReplyContents)
Sets the last reply contents
public void setLastReplyDate (Date lastReplyDate)
Sets the last reply date
public void setOpacity (float opacity)
Sets the opacity to be shown in annotation list
public void setPage (int page)
Sets the page the annotation is on
public void setParent (String parent)
public void setReviewState (int reviewState)
Sets the review state, -1 if no state
public void setServerId (String serverId)
Sets the server database id if different from annotation id
public void setType (int type)
Sets the annotation type
public void setUnreadCount (int unreadCount)
Sets the unread reply count
public void setUnreads (String unreads)
Sets the unread reply IDs
public void setXfdf (String xfdf)
Sets the XFDF of this annotation In the database, this is represented by a local file path to the XFDF string
public void setYPos (double yPos)
Sets the y position