Top Description Methods
org.apache.poi.sl.usermodel

public Interface Comment

Imports
java.awt.geom.Point2D, java.util.Date
Common interface for comments
Since
POI 4.0.0

Method Summary

Modifier and TypeMethod and Description
public String
getAuthor()

Get the Author of this comment

public String
getAuthorInitials()

Get the Author's Initials of this comment

public Date

Returns:

the comment date.
getDate()

Gets the date the comment was made.

public Point2D

Returns:

the offset.
getOffset()

Gets the offset of the comment on the page.

public String
getText()

Get the text of this comment

public void
setAuthor(String author)

Set the Author of this comment.

public void
setAuthorInitials(String initials)

Set the Author's Initials of this comment.

public void
setDate(Date
the comment date.
date)

Sets the date the comment was made.

public void
setOffset(Point2D
the offset.
offset)

Sets the offset of the comment on the page.

public void
setText(String text)

Set the text of this comment

Method Detail

getAuthorback to summary
public String getAuthor()

Get the Author of this comment

getAuthorInitialsback to summary
public String getAuthorInitials()

Get the Author's Initials of this comment

getDateback to summary
public Date getDate()

Gets the date the comment was made.

Returns:Date

the comment date.

getOffsetback to summary
public Point2D getOffset()

Gets the offset of the comment on the page.

Returns:Point2D

the offset.

getTextback to summary
public String getText()

Get the text of this comment

setAuthorback to summary
public void setAuthor(String author)

Set the Author of this comment. if the author wasn't registered before, create a new entry

setAuthorInitialsback to summary
public void setAuthorInitials(String initials)

Set the Author's Initials of this comment. if the author wasn't registered before via setAuthor(String) this has no effect

setDateback to summary
public void setDate(Date date)

Sets the date the comment was made.

Parameters
date:Date

the comment date.

setOffsetback to summary
public void setOffset(Point2D offset)

Sets the offset of the comment on the page.

Parameters
offset:Point2D

the offset.

setTextback to summary
public void setText(String text)

Set the text of this comment