Package org.apache.poi.ss.usermodel
Interface Comment
- All Known Implementing Classes:
HSSFComment,XSSFComment
public interface Comment
-
Method Summary
Modifier and TypeMethodDescriptionGet the address of the cell that this comment is attached toName of the original comment authorReturn defines position of this anchor in the sheet.intReturn the column of the cell that contains the commentintgetRow()Return the row of the cell that contains the commentFetches the rich text string of the commentbooleanReturns whether this comment is visible.voidsetAddress(int row, int col) Set the address of the cell that this comment is attached tovoidsetAddress(CellAddress addr) Set the address of the cell that this comment is attached tovoidName of the original comment authorvoidsetColumn(int col) Set the column of the cell that contains the commentvoidsetRow(int row) Set the row of the cell that contains the commentvoidsetString(RichTextString string) Sets the rich text string used by this comment.voidsetVisible(boolean visible) Sets whether this comment is visible.
-
Method Details
-
setVisible
void setVisible(boolean visible) Sets whether this comment is visible.- Parameters:
visible-trueif the comment is visible,falseotherwise
-
isVisible
boolean isVisible()Returns whether this comment is visible.- Returns:
trueif the comment is visible,falseotherwise
-
getAddress
CellAddress getAddress()Get the address of the cell that this comment is attached to- Returns:
- comment cell address
- Since:
- 3.15-beta1
-
setAddress
Set the address of the cell that this comment is attached to- Parameters:
addr-- Since:
- 3.15-beta1
-
setAddress
void setAddress(int row, int col) Set the address of the cell that this comment is attached to- Parameters:
row-col-- Since:
- 3.15-beta1
-
getRow
int getRow()Return the row of the cell that contains the comment- Returns:
- the 0-based row of the cell that contains the comment
-
setRow
void setRow(int row) Set the row of the cell that contains the comment- Parameters:
row- the 0-based row of the cell that contains the comment
-
getColumn
int getColumn()Return the column of the cell that contains the comment- Returns:
- the 0-based column of the cell that contains the comment
-
setColumn
void setColumn(int col) Set the column of the cell that contains the comment- Parameters:
col- the 0-based column of the cell that contains the comment
-
getAuthor
String getAuthor()Name of the original comment author- Returns:
- the name of the original author of the comment
-
setAuthor
Name of the original comment author- Parameters:
author- the name of the original author of the comment
-
getString
RichTextString getString()Fetches the rich text string of the comment -
setString
Sets the rich text string used by this comment.- Parameters:
string- Sets the rich text string used by this object.
-
getClientAnchor
ClientAnchor getClientAnchor()Return defines position of this anchor in the sheet. The anchor is the yellow box/balloon that is rendered on top of the sheets when the comment is visible. To associate a comment with a different cell, usesetAddress(org.apache.poi.ss.util.CellAddress).- Returns:
- defines position of this anchor in the sheet
-