|
||||||||||
| 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 |
|---|
HORIZONTAL_ALIGNMENT_CENTERED, HORIZONTAL_ALIGNMENT_DISTRIBUTED, HORIZONTAL_ALIGNMENT_JUSTIFIED, HORIZONTAL_ALIGNMENT_LEFT, HORIZONTAL_ALIGNMENT_RIGHT, OBJECT_TYPE_TEXT, VERTICAL_ALIGNMENT_BOTTOM, VERTICAL_ALIGNMENT_CENTER, VERTICAL_ALIGNMENT_DISTRIBUTED, VERTICAL_ALIGNMENT_JUSTIFY, VERTICAL_ALIGNMENT_TOP |
| Fields inherited from class org.apache.poi.hssf.usermodel.HSSFSimpleShape |
|---|
OBJECT_TYPE_COMBO_BOX, 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 |
int |
getColumn()
Return the column of the cell that contains the comment |
protected NoteRecord |
getNoteRecord()
Returns the underlying Note record |
int |
getRow()
Return the row of the cell that contains the comment |
protected TextObjectRecord |
getTextObjectRecord()
Returns the underlying Text record |
boolean |
isVisible()
Sets whether this comment is visible. |
void |
setAuthor(java.lang.String author)
Name of the original comment author |
void |
setColumn(int col)
Set the column of the cell that contains the comment |
void |
setColumn(short col)
Deprecated. (Nov 2009) use setColumn(int) } |
void |
setRow(int row)
Set the row of the cell that contains the comment |
void |
setString(RichTextString 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 |
|---|
getHorizontalAlignment, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getString, getVerticalAlignment, setHorizontalAlignment, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setVerticalAlignment |
| 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 |
| Methods inherited from interface org.apache.poi.ss.usermodel.Comment |
|---|
getString |
| 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)
setVisible in interface Commentvisible - true if the comment is visible, false otherwisepublic boolean isVisible()
isVisible in interface Commenttrue if the comment is visible, false otherwisepublic int getRow()
getRow in interface Commentpublic void setRow(int row)
setRow in interface Commentrow - the 0-based row of the cell that contains the commentpublic int getColumn()
getColumn in interface Commentpublic void setColumn(int col)
setColumn in interface Commentcol - the 0-based column of the cell that contains the comment@Deprecated public void setColumn(short col)
setColumn(int) }
public java.lang.String getAuthor()
getAuthor in interface Commentpublic void setAuthor(java.lang.String author)
setAuthor in interface Commentauthor - the name of the original author of the commentpublic void setString(RichTextString string)
setString in interface CommentsetString in class HSSFTextboxstring - Sets the rich text string used by this object.protected NoteRecord getNoteRecord()
protected TextObjectRecord getTextObjectRecord()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||