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

public class HSSFComment
extends HSSFTextbox

Represents a cell comment - a sticky note associated with a cell.

Author:

Yegor Kozlov

Field Summary

Fields

Modifier and Type	Field and Description
private String	author
private short	col
private NoteRecord	note
private short	row
private TextObjectRecord	txo
private boolean	visible

Fields inherited from class loci.poi.hssf.usermodel.HSSFTextbox

marginBottom, marginLeft, marginRight, marginTop, OBJECT_TYPE_TEXT, string

Fields inherited from class loci.poi.hssf.usermodel.HSSFSimpleShape

OBJECT_TYPE_COMMENT, OBJECT_TYPE_LINE, OBJECT_TYPE_OVAL, OBJECT_TYPE_PICTURE, OBJECT_TYPE_RECTANGLE, shapeType

Fields inherited from class loci.poi.hssf.usermodel.HSSFShape

anchor, fillColor, lineStyle, LINESTYLE_DASHDOTDOTSYS, LINESTYLE_DASHDOTGEL, LINESTYLE_DASHDOTSYS, LINESTYLE_DASHGEL, LINESTYLE_DASHSYS, LINESTYLE_DOTGEL, LINESTYLE_DOTSYS, LINESTYLE_LONGDASHDOTDOTGEL, LINESTYLE_LONGDASHDOTGEL, LINESTYLE_LONGDASHGEL, LINESTYLE_NONE, LINESTYLE_SOLID, lineStyleColor, lineWidth, LINEWIDTH_DEFAULT, LINEWIDTH_ONE_PT, noFill, parent

Constructor Summary

Constructors

Modifier	Constructor and Description
	HSSFComment(HSSFShape parent, HSSFAnchor anchor) Construct a new comment with the given parent and anchor.
protected	HSSFComment(NoteRecord note, TextObjectRecord txo)

Method Summary

Methods

Modifier and Type	Method and Description
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(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 loci.poi.hssf.usermodel.HSSFTextbox

getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getString, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop

Methods inherited from class loci.poi.hssf.usermodel.HSSFSimpleShape

getShapeType, setShapeType

Methods inherited from class loci.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

Field Detail

visible

private boolean visible

col

private short col

row

private short row

author

private String author

note

private NoteRecord note

txo

private TextObjectRecord txo

Constructor Detail

HSSFComment

public HSSFComment(HSSFShape parent,
           HSSFAnchor anchor)

Construct a new comment with the given parent and anchor.

Parameters:

parent -

anchor - defines position of this anchor in the sheet

HSSFComment

protected HSSFComment(NoteRecord note,
           TextObjectRecord txo)

Method Detail

setVisible

public void setVisible(boolean visible)

Returns whether this comment is visible.

Parameters:

visible - true if the comment is visible, false otherwise

isVisible

public boolean isVisible()

Sets whether this comment is visible.

Returns:

true if the comment is visible, false otherwise

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

public String getAuthor()

Name of the original comment author

Returns:

the name of the original author of the comment

setAuthor

public void setAuthor(String author)

Name of the original comment author

Parameters:

author - the name of the original author of the comment

setString

public void setString(HSSFRichTextString string)

Sets the rich text string used by this comment.

Overrides:

setString in class HSSFTextbox

Parameters:

string - Sets the rich text string used by this object.