org.apache.poi.hssf.usermodel: public class: HSSFComment

org.apache.poi.hssf.usermodel
public class: HSSFComment [javadoc | source]

java.lang.Object
   org.apache.poi.hssf.usermodel.HSSFShape
      org.apache.poi.hssf.usermodel.HSSFSimpleShape
         org.apache.poi.hssf.usermodel.HSSFTextbox
            org.apache.poi.hssf.usermodel.HSSFComment

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

author: Yegor - Kozlov

Fields inherited from org.apache.poi.hssf.usermodel.HSSFTextbox:
OBJECT_TYPE_TEXT, HORIZONTAL_ALIGNMENT_LEFT, HORIZONTAL_ALIGNMENT_CENTERED, HORIZONTAL_ALIGNMENT_RIGHT, HORIZONTAL_ALIGNMENT_JUSTIFIED, HORIZONTAL_ALIGNMENT_DISTRIBUTED, VERTICAL_ALIGNMENT_TOP, VERTICAL_ALIGNMENT_CENTER, VERTICAL_ALIGNMENT_BOTTOM, VERTICAL_ALIGNMENT_JUSTIFY, VERTICAL_ALIGNMENT_DISTRIBUTED, marginLeft, marginRight, marginTop, marginBottom, halign, valign, string

Fields inherited from org.apache.poi.hssf.usermodel.HSSFSimpleShape:
OBJECT_TYPE_LINE, OBJECT_TYPE_RECTANGLE, OBJECT_TYPE_OVAL, OBJECT_TYPE_PICTURE, OBJECT_TYPE_COMMENT, shapeType

Fields inherited from org.apache.poi.hssf.usermodel.HSSFShape:
LINEWIDTH_ONE_PT, LINEWIDTH_DEFAULT, LINESTYLE_SOLID, LINESTYLE_DASHSYS, LINESTYLE_DOTSYS, LINESTYLE_DASHDOTSYS, LINESTYLE_DASHDOTDOTSYS, LINESTYLE_DOTGEL, LINESTYLE_DASHGEL, LINESTYLE_LONGDASHGEL, LINESTYLE_DASHDOTGEL, LINESTYLE_LONGDASHDOTGEL, LINESTYLE_LONGDASHDOTDOTGEL, LINESTYLE_NONE, parent, anchor, lineStyleColor, fillColor, lineWidth, lineStyle, noFill

Constructor:

Constructor:
public HSSFComment(HSSFShape parent, HSSFAnchor anchor) { super( parent, anchor ); setShapeType(OBJECT_TYPE_COMMENT); //default color for comments fillColor = 0x08000050; //by default comments are hidden visible = false; author = ""; } Construct a new comment with the given parent and anchor. Parameters: `parent` - `anchor` - defines position of this anchor in the sheet
protected HSSFComment(NoteRecord note, TextObjectRecord txo) { this( (HSSFShape)null, (HSSFAnchor)null ); this.txo = txo; this.note = note; }

 public HSSFComment(HSSFShape parent,
    HSSFAnchor anchor) {
                                
        super( parent, anchor );
        setShapeType(OBJECT_TYPE_COMMENT);
        //default color for comments
        fillColor = 0x08000050;
        //by default comments are hidden
        visible = false;
        author = "";
}

Construct a new comment with the given parent and anchor.

Parameters:

parent -

anchor - defines position of this anchor in the sheet

 protected HSSFComment(NoteRecord note,
    TextObjectRecord txo) {
        this( (HSSFShape)null, (HSSFAnchor)null );
        this.txo = txo;
        this.note = note;
}

Method from org.apache.poi.hssf.usermodel.HSSFComment Summary:
getAuthor, getColumn, getRow, isVisible, setAuthor, setColumn, setRow, setString, setVisible

Methods from org.apache.poi.hssf.usermodel.HSSFTextbox:
getHorizontalAlignment, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getString, getVerticalAlignment, setHorizontalAlignment, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setString, setVerticalAlignment

Methods from org.apache.poi.hssf.usermodel.HSSFSimpleShape:
getShapeType, setShapeType

Methods from org.apache.poi.hssf.usermodel.HSSFShape:
countOfAllChildren, getAnchor, getFillColor, getLineStyle, getLineStyleColor, getLineWidth, getParent, isNoFill, setAnchor, setFillColor, setFillColor, setLineStyle, setLineStyleColor, setLineStyleColor, setLineWidth, setNoFill

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.apache.poi.hssf.usermodel.HSSFComment Detail:
public String getAuthor() { return author; } Name of the original comment author
public short getColumn() { return col; } Return the column of the cell that contains the comment
public int getRow() { return row; } Return the row of the cell that contains the comment
public boolean isVisible() { return this.visible; } Sets whether this comment is visible.
public void setAuthor(String author) { if(note != null) note.setAuthor(author); this.author = author; } Name of the original comment author
public void setColumn(short col) { if(note != null) note.setColumn(col); this.col = col; } Set the column of the cell that contains the comment
public void setRow(int row) { if(note != null) note.setRow((short)row); this.row = (short)row; } Set the row of the cell that contains the comment
public void setString(HSSFRichTextString string) { //if font is not set we must set the default one if (string.numFormattingRuns() == 0) string.applyFont((short)0); if (txo != null) { int frLength = ( string.numFormattingRuns() + 1 ) * 8; txo.setFormattingRunLength( (short) frLength ); txo.setTextLength( (short) string.length() ); txo.setStr( string ); } super.setString(string); } Sets the rich text string used by this comment.
public void setVisible(boolean visible) { if(note != null) note.setFlags(visible ? NoteRecord.NOTE_VISIBLE : NoteRecord.NOTE_HIDDEN); this.visible = visible; } Returns whether this comment is visible.

Method from org.apache.poi.hssf.usermodel.HSSFComment Detail:

 public String getAuthor() {
        return author;
}

Name of the original comment author

 public short getColumn() {
        return col;
}

Return the column of the cell that contains the comment

 public int getRow() {
        return row;
}

Return the row of the cell that contains the comment

 public boolean isVisible() {
        return this.visible;
}

Sets whether this comment is visible.

 public  void setAuthor(String author) {
        if(note != null) note.setAuthor(author);
        this.author = author;
}

Name of the original comment author

 public  void setColumn(short col) {
        if(note != null) note.setColumn(col);
        this.col = col;
}

Set the column of the cell that contains the comment

 public  void setRow(int row) {
        if(note != null) note.setRow((short)row);
        this.row = (short)row;
}

Set the row of the cell that contains the comment

 public  void setString(HSSFRichTextString string) {
        //if font is not set we must set the default one
        if (string.numFormattingRuns() == 0) string.applyFont((short)0);
        if (txo != null) {
            int frLength = ( string.numFormattingRuns() + 1 ) * 8;
            txo.setFormattingRunLength( (short) frLength );
            txo.setTextLength( (short) string.length() );
            txo.setStr( string );
        }
        super.setString(string);
}

Sets the rich text string used by this comment.

 public  void setVisible(boolean visible) {
        if(note != null) note.setFlags(visible ? NoteRecord.NOTE_VISIBLE : NoteRecord.NOTE_HIDDEN);
        this.visible = visible;
}

Returns whether this comment is visible.