Package org.apache.poi.sl.usermodel
Interface Comment
-
public interface CommentCommon interface for comments- Since:
- POI 4.0.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetAuthor()Get the Author of this commentStringgetAuthorInitials()Get the Author's Initials of this commentDategetDate()Gets the date the comment was made.Point2DgetOffset()Gets the offset of the comment on the page.StringgetText()Get the text of this commentvoidsetAuthor(String author)Set the Author of this comment.voidsetAuthorInitials(String initials)Set the Author's Initials of this comment.voidsetDate(Date date)Sets the date the comment was made.voidsetOffset(Point2D offset)Sets the offset of the comment on the page.voidsetText(String text)Set the text of this comment
-
-
-
Method Detail
-
getAuthor
String getAuthor()
Get the Author of this comment
-
setAuthor
void setAuthor(String author)
Set the Author of this comment. if the author wasn't registered before, create a new entry
-
getAuthorInitials
String getAuthorInitials()
Get the Author's Initials of this comment
-
setAuthorInitials
void setAuthorInitials(String initials)
Set the Author's Initials of this comment. if the author wasn't registered before viasetAuthor(String)this has no effect
-
getText
String getText()
Get the text of this comment
-
setText
void setText(String text)
Set the text of this comment
-
getDate
Date getDate()
Gets the date the comment was made.- Returns:
- the comment date.
-
setDate
void setDate(Date date)
Sets the date the comment was made.- Parameters:
date- the comment date.
-
getOffset
Point2D getOffset()
Gets the offset of the comment on the page.- Returns:
- the offset.
-
setOffset
void setOffset(Point2D offset)
Sets the offset of the comment on the page.- Parameters:
offset- the offset.
-
-