|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.poi.hssf.usermodel.HSSFShape
org.apache.poi.hssf.usermodel.HSSFSimpleShape
org.apache.poi.hssf.usermodel.HSSFTextbox
org.apache.poi.hssf.usermodel.HSSFComment
public class HSSFComment
Represents a cell comment - a sticky note associated with a cell.
| Field Summary |
|---|
| Fields inherited from class org.apache.poi.hssf.usermodel.HSSFTextbox |
|---|
OBJECT_TYPE_TEXT |
| Fields inherited from class org.apache.poi.hssf.usermodel.HSSFSimpleShape |
|---|
OBJECT_TYPE_COMMENT, OBJECT_TYPE_LINE, OBJECT_TYPE_OVAL, OBJECT_TYPE_PICTURE, OBJECT_TYPE_RECTANGLE |
| Fields inherited from class org.apache.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 | |
|---|---|
|
HSSFComment(HSSFShape parent,
HSSFAnchor anchor)
Construct a new comment with the given parent and anchor. |
protected |
HSSFComment(NoteRecord note,
TextObjectRecord txo)
|
| Method Summary | |
|---|---|
java.lang.String |
getAuthor()
Name of the original comment author |
short |
getColumn()
Return the column of the cell that contains the comment |
int |
getRow()
Return the row of the cell that contains the comment |
boolean |
isVisible()
Sets whether this comment is visible. |
void |
setAuthor(java.lang.String author)
Name of the original comment author |
void |
setColumn(short col)
Set the column of the cell that contains the comment |
void |
setRow(int row)
Set the row of the cell that contains the comment |
void |
setString(HSSFRichTextString string)
Sets the rich text string used by this comment. |
void |
setVisible(boolean visible)
Returns whether this comment is visible. |
| Methods inherited from class org.apache.poi.hssf.usermodel.HSSFTextbox |
|---|
getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getString, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop |
| Methods inherited from class org.apache.poi.hssf.usermodel.HSSFSimpleShape |
|---|
getShapeType, setShapeType |
| Methods inherited from class org.apache.poi.hssf.usermodel.HSSFShape |
|---|
countOfAllChildren, getAnchor, getFillColor, getLineStyle, getLineStyleColor, getLineWidth, getParent, isNoFill, setAnchor, setFillColor, setFillColor, setLineStyle, setLineStyleColor, setLineStyleColor, setLineWidth, setNoFill |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public HSSFComment(HSSFShape parent,
HSSFAnchor anchor)
parent - anchor - defines position of this anchor in the sheet
protected HSSFComment(NoteRecord note,
TextObjectRecord txo)
| Method Detail |
|---|
public void setVisible(boolean visible)
visible - true if the comment is visible, false otherwisepublic boolean isVisible()
true if the comment is visible, false otherwisepublic int getRow()
public void setRow(int row)
row - the 0-based row of the cell that contains the commentpublic short getColumn()
public void setColumn(short col)
col - the 0-based column of the cell that contains the commentpublic java.lang.String getAuthor()
public void setAuthor(java.lang.String author)
author - the name of the original author of the commentpublic void setString(HSSFRichTextString string)
setString in class HSSFTextboxstring - Sets the rich text string used by this object.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||