Package loci.poi.hssf.usermodel
Class HSSFComment
java.lang.Object
loci.poi.hssf.usermodel.HSSFShape
loci.poi.hssf.usermodel.HSSFSimpleShape
loci.poi.hssf.usermodel.HSSFTextbox
loci.poi.hssf.usermodel.HSSFComment
Represents a cell comment - a sticky note associated with a cell.
- Author:
- Yegor Kozlov
-
Field Summary
Fields inherited from class loci.poi.hssf.usermodel.HSSFTextbox
OBJECT_TYPE_TEXTFields inherited from class loci.poi.hssf.usermodel.HSSFSimpleShape
OBJECT_TYPE_COMMENT, OBJECT_TYPE_LINE, OBJECT_TYPE_OVAL, OBJECT_TYPE_PICTURE, OBJECT_TYPE_RECTANGLEFields inherited from class loci.poi.hssf.usermodel.HSSFShape
LINESTYLE_DASHDOTDOTSYS, LINESTYLE_DASHDOTGEL, LINESTYLE_DASHDOTSYS, LINESTYLE_DASHGEL, LINESTYLE_DASHSYS, LINESTYLE_DOTGEL, LINESTYLE_DOTSYS, LINESTYLE_LONGDASHDOTDOTGEL, LINESTYLE_LONGDASHDOTGEL, LINESTYLE_LONGDASHGEL, LINESTYLE_NONE, LINESTYLE_SOLID, LINEWIDTH_DEFAULT, LINEWIDTH_ONE_PT -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedHSSFComment(NoteRecord note, TextObjectRecord txo) HSSFComment(HSSFShape parent, HSSFAnchor anchor) Construct a new comment with the given parent and anchor. -
Method Summary
Modifier and TypeMethodDescriptionName of the original comment authorshortReturn the column of the cell that contains the commentintgetRow()Return the row of the cell that contains the commentbooleanSets whether this comment is visible.voidName of the original comment authorvoidsetColumn(short col) Set the column of the cell that contains the commentvoidsetRow(int row) Set the row of the cell that contains the commentvoidsetString(HSSFRichTextString string) Sets the rich text string used by this comment.voidsetVisible(boolean visible) Returns whether this comment is visible.Methods inherited from class loci.poi.hssf.usermodel.HSSFTextbox
getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getString, setMarginBottom, setMarginLeft, setMarginRight, setMarginTopMethods inherited from class loci.poi.hssf.usermodel.HSSFSimpleShape
getShapeType, setShapeTypeMethods inherited from class loci.poi.hssf.usermodel.HSSFShape
countOfAllChildren, getAnchor, getFillColor, getLineStyle, getLineStyleColor, getLineWidth, getParent, isNoFill, setAnchor, setFillColor, setFillColor, setLineStyle, setLineStyleColor, setLineStyleColor, setLineWidth, setNoFill
-
Constructor Details
-
HSSFComment
Construct a new comment with the given parent and anchor.- Parameters:
parent-anchor- defines position of this anchor in the sheet
-
HSSFComment
-
-
Method Details
-
setVisible
public void setVisible(boolean visible) Returns whether this comment is visible.- Parameters:
visible-trueif the comment is visible,falseotherwise
-
isVisible
public boolean isVisible()Sets whether this comment is visible.- Returns:
trueif the comment is visible,falseotherwise
-
getRow
public 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
public 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
public short getColumn()Return the column of the cell that contains the comment- Returns:
- the 0-based column of the cell that contains the comment
-
setColumn
public void setColumn(short 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
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
-
setString
Sets the rich text string used by this comment.- Overrides:
setStringin classHSSFTextbox- Parameters:
string- Sets the rich text string used by this object.
-