Class HSSFComment


  • public class HSSFComment
    extends HSSFTextbox
    Represents a cell comment - a sticky note associated with a cell.
    Author:
    Yegor Kozlov
    • 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
    • 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.