Class HSSFComment

All Implemented Interfaces:
Comment, Shape, SimpleShape

public class HSSFComment extends HSSFTextbox implements Comment
Represents a cell comment - a sticky note associated with a cell.
  • Constructor Details

  • Method Details

    • createSpContainer

      protected EscherContainerRecord createSpContainer()
      Overrides:
      createSpContainer in class HSSFTextbox
    • createObjRecord

      protected ObjRecord createObjRecord()
      Overrides:
      createObjRecord in class HSSFTextbox
    • setVisible

      public void setVisible(boolean visible)
      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()
      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 address)
      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()
      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)
      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()
      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)
      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()
      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)
      Name of the original comment author
      Specified by:
      setAuthor in interface Comment
      Parameters:
      author - the name of the original author of the comment
    • getNoteRecord

      protected NoteRecord getNoteRecord()
      Returns the underlying Note record
    • hasPosition

      public boolean hasPosition()
      Do we know which cell this comment belongs to?
    • getClientAnchor

      public ClientAnchor getClientAnchor()
      Description copied from interface: Comment
      Return defines 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:
      defines position of this anchor in the sheet
    • setShapeType

      public void setShapeType(int shapeType)
      Overrides:
      setShapeType in class HSSFTextbox
      Parameters:
      shapeType - - shapeType
      See Also:
    • afterRemove

      public void afterRemove(HSSFPatriarch patriarch)
      Description copied from class: HSSFShape
      remove escher container from the patriarch.escherAggregate remove obj, textObj and note records if it's necessary in case of ShapeGroup remove all contained shapes
      Overrides:
      afterRemove in class HSSFTextbox
    • cloneShape

      protected HSSFShape cloneShape()
      Overrides:
      cloneShape in class HSSFTextbox
    • setBackgroundImage

      public void setBackgroundImage(int pictureIndex)
    • resetBackgroundImage

      public void resetBackgroundImage()
    • getBackgroundImageId

      public int getBackgroundImageId()
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object