Package org.apache.poi.sl.usermodel
Interface Comment
- All Known Implementing Classes:
HSLFComment
,XSLFComment
public interface Comment
Common interface for comments
- Since:
- POI 4.0.0
-
Method Summary
Modifier and TypeMethodDescriptionGet the Author of this commentGet the Author's Initials of this commentgetDate()
Gets the date the comment was made.Gets the offset of the comment on the page.getText()
Get the text of this commentvoid
Set the Author of this comment.void
setAuthorInitials
(String initials) Set the Author's Initials of this comment.void
Sets the date the comment was made.void
Sets the offset of the comment on the page.void
Set the text of this comment
-
Method Details
-
getAuthor
String getAuthor()Get the Author of this comment -
setAuthor
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
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
Set the text of this comment -
getDate
Date getDate()Gets the date the comment was made.- Returns:
- the comment date.
-
setDate
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
Sets the offset of the comment on the page.- Parameters:
offset
- the offset.
-