Package org.apache.poi.xssf.model

Class CommentsTable

java.lang.Object
org.apache.poi.ooxml.POIXMLDocumentPart
org.apache.poi.xssf.model.CommentsTable
All Implemented Interfaces:
Comments
@Internal public class CommentsTable extends POIXMLDocumentPart implements Comments

  • Field Details

  • Constructor Details

  • Method Details

    • readFrom

      public void readFrom(InputStream is) throws IOException
      Throws:
      IOException

    • writeTo

      public void writeTo(OutputStream out) throws IOException
      Throws:
      IOException

    • setSheet

      @Internal public void setSheet(Sheet sheet)
      Description copied from interface: Comments
      This method is for internal POI use only. POI uses it to link the sheet and comments table. This method will not move comments from one sheet to another (if a user tries to use this method for that purpose).
      Specified by:
      setSheet in interface Comments
      Parameters:
      sheet - the sheet that this comments table is associated with

    • referenceUpdated

      @Deprecated @Removal(version="6.0.0") public void referenceUpdated(CellAddress oldReference, CTComment comment)
      Deprecated.
      use referenceUpdated(CellAddress, XSSFComment)
      Called after the reference is updated, so that we can reflect that in our cache
      Parameters:
      oldReference - the comment to remove from the commentRefs map
      comment - the comment to replace in the commentRefs map

    • referenceUpdated

      public void referenceUpdated(CellAddress oldReference, XSSFComment comment)
      Called after the reference is updated, so that we can reflect that in our cache
      Specified by:
      referenceUpdated in interface Comments
      Parameters:
      oldReference - the comment to remove from the commentRefs map
      comment - the comment to replace in the commentRefs map
      Since:
      POI 5.2.0
      See Also:

    • commentUpdated

      public void commentUpdated(XSSFComment comment)
      Called after the comment is updated, so that we can reflect that in our cache
      Specified by:
      commentUpdated in interface Comments
      Parameters:
      comment - the comment to replace in the commentRefs map
      Since:
      POI 5.2.0
      See Also:

    • getNumberOfComments

      public int getNumberOfComments()
      Specified by:
      getNumberOfComments in interface Comments

    • getNumberOfAuthors

      public int getNumberOfAuthors()
      Specified by:
      getNumberOfAuthors in interface Comments

    • getAuthor

      public String getAuthor(long authorId)
      Specified by:
      getAuthor in interface Comments

    • findAuthor

      public int findAuthor(String author)
      Specified by:
      findAuthor in interface Comments

    • findCellComment

      public XSSFComment findCellComment(CellAddress cellAddress)
      Finds the cell comment at cellAddress, if one exists
      Specified by:
      findCellComment in interface Comments
      Parameters:
      cellAddress - the address of the cell to find a comment
      Returns:
      cell comment if one exists, otherwise returns null

    • getCellAddresses

      public Iterator<CellAddress> getCellAddresses()
      Returns all cell addresses that have comments.
      Specified by:
      getCellAddresses in interface Comments
      Returns:
      An iterator to traverse all cell addresses that have comments.
      Since:
      4.0.0

    • createNewComment

      public XSSFComment createNewComment(ClientAnchor clientAnchor)
      Create a new comment and add to the CommentTable.
      Specified by:
      createNewComment in interface Comments
      Parameters:
      clientAnchor - the anchor for this comment
      Returns:
      new XSSFComment
      Since:
      POI 5.2.0

    • newComment

      @Internal public CTComment newComment(CellAddress ref)
      Create a new comment located at cell address
      Parameters:
      ref - the location to add the comment
      Returns:
      a new CTComment located at ref with default author

    • removeComment

      public boolean removeComment(CellAddress cellRef)
      Remove the comment at cellRef location, if one exists
      Specified by:
      removeComment in interface Comments
      Parameters:
      cellRef - the location of the comment to remove
      Returns:
      returns true if a comment was removed

    • getCTComments

      @Internal public CTComments getCTComments()
      Returns the underlying CTComments list xmlbean
      Returns:
      underlying comments list xmlbean