Package org.apache.poi.xssf.binary

Class XSSFBComment

java.lang.Object
org.apache.poi.xssf.binary.XSSFBComment
All Implemented Interfaces:
Comment
@Internal public class XSSFBComment extends Object implements Comment
Since:
3.16-beta3

  • Method Details

    • setVisible

      public void setVisible(boolean visible)
      Description copied from interface: Comment
      Sets whether this comment is visible.
      Specified by:
      setVisible in interface Comment
      Parameters:
      visible - true if the comment is visible, false otherwise

    • isVisible

      public boolean isVisible()
      Description copied from interface: Comment
      Returns whether this comment is visible.
      Specified by:
      isVisible in interface Comment
      Returns:
      true if the comment is visible, false otherwise

    • getAddress

      public CellAddress getAddress()
      Description copied from interface: Comment
      Get the address of the cell that this comment is attached to
      Specified by:
      getAddress in interface Comment
      Returns:
      comment cell address

    • setAddress

      public void setAddress(CellAddress addr)
      Description copied from interface: Comment
      Set the address of the cell that this comment is attached to
      Specified by:
      setAddress in interface Comment

    • setAddress

      public void setAddress(int row, int col)
      Description copied from interface: Comment
      Set the address of the cell that this comment is attached to
      Specified by:
      setAddress in interface Comment

    • getRow

      public int getRow()
      Description copied from interface: Comment
      Return the row of the cell that contains the comment
      Specified by:
      getRow in interface Comment
      Returns:
      the 0-based row of the cell that contains the comment

    • setRow

      public void setRow(int row)
      Description copied from interface: Comment
      Set the row of the cell that contains the comment
      Specified by:
      setRow in interface Comment
      Parameters:
      row - the 0-based row of the cell that contains the comment

    • getColumn

      public int getColumn()
      Description copied from interface: Comment
      Return the column of the cell that contains the comment
      Specified by:
      getColumn in interface Comment
      Returns:
      the 0-based column of the cell that contains the comment

    • setColumn

      public void setColumn(int col)
      Description copied from interface: Comment
      Set the column of the cell that contains the comment
      Specified by:
      setColumn in interface Comment
      Parameters:
      col - the 0-based column of the cell that contains the comment

    • getAuthor

      public String getAuthor()
      Description copied from interface: Comment
      Name of the original comment author
      Specified by:
      getAuthor in interface Comment
      Returns:
      the name of the original author of the comment

    • setAuthor

      public void setAuthor(String author)
      Description copied from interface: Comment
      Name of the original comment author
      Specified by:
      setAuthor in interface Comment
      Parameters:
      author - the name of the original author of the comment

    • getString

      public XSSFBRichTextString getString()
      Description copied from interface: Comment
      Fetches the rich text string of the comment
      Specified by:
      getString in interface Comment

    • setString

      public void setString(RichTextString string)
      Description copied from interface: Comment
      Sets the rich text string used by this comment.
      Specified by:
      setString in interface Comment
      Parameters:
      string - Sets the rich text string used by this object.

    • getClientAnchor

      public ClientAnchor getClientAnchor()
      Description copied from interface: Comment
      Return defined position of this anchor in the sheet. The anchor is the yellow box/balloon that is rendered on top of the sheets when the comment is visible. To associate a comment with a different cell, use Comment.setAddress(org.apache.poi.ss.util.CellAddress).
      Specified by:
      getClientAnchor in interface Comment
      Returns:
      defined position of this anchor in the sheet, can be null