Interface Comment

All Known Implementing Classes:
StandardComment
public interface Comment
The Comment interface provides methods for managing comments in a document.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    expression()
    Retrieves the expression associated with the implementing entity.
    org.docx4j.wml.Comments.Comment
    getComment()
    Retrieves the comment associated with this object.
    org.docx4j.wml.CommentRangeEnd
    getCommentRangeEnd()
    Retrieves the CommentRangeEnd object associated with this comment.
    org.docx4j.wml.CommentRangeStart
    getCommentRangeStart()
    Retrieves the CommentRangeStart object associated with this comment.
    @Nullable org.docx4j.wml.R.CommentReference
    getCommentReference()
    Retrieves the R.CommentReference object associated with this comment.
    List<Object>
    getElements()
    Retrieves the elements in the document that are between the comment range anchors.
    BigInteger
    getId()
    Retrieves the ID of this comment.
    Paragraph
    getParagraph()
    Retrieves the paragraph associated with this comment.
    org.docx4j.wml.ContentAccessor
    getParent()
    Retrieves the parent of the comment.
    org.docx4j.wml.CTSmartTagRun
    getStartTagRun()
    Retrieves the CTSmartTagRun object associated with the start of this comment.

  • Method Details

    • getParagraph

      Paragraph getParagraph()
      Retrieves the paragraph associated with this comment.
      Returns:
      the Paragraph object associated with this comment

    • getStartTagRun

      org.docx4j.wml.CTSmartTagRun getStartTagRun()
      Retrieves the CTSmartTagRun object associated with the start of this comment.
      Returns:
      the CTSmartTagRun object representing the start tag run of the comment

    • getCommentRangeStart

      org.docx4j.wml.CommentRangeStart getCommentRangeStart()
      Retrieves the CommentRangeStart object associated with this comment.
      Returns:
      the CommentRangeStart object associated with this comment

    • getParent

      org.docx4j.wml.ContentAccessor getParent()
      Retrieves the parent of the comment.
      Returns:
      the parent of the comment

    • getElements

      List<Object> getElements()
      Retrieves the elements in the document that are between the comment range anchors.
      Returns:
      a list of objects representing the elements between the comment range anchors.

    • getCommentRangeEnd

      org.docx4j.wml.CommentRangeEnd getCommentRangeEnd()
      Retrieves the CommentRangeEnd object associated with this comment.
      Returns:
      the CommentRangeEnd object associated with this comment

    • getCommentReference

      @Nullable org.docx4j.wml.R.CommentReference getCommentReference()
      Retrieves the R.CommentReference object associated with this comment.
      Returns:
      the R.CommentReference object associated with this comment

    • getComment

      org.docx4j.wml.Comments.Comment getComment()
      Retrieves the comment associated with this object.
      Returns:
      the comment associated with this object

    • expression

      String expression()
      Retrieves the expression associated with the implementing entity.
      Returns:
      a string representing the expression

    • getId

      BigInteger getId()
      Retrieves the ID of this comment.
      Returns:
      the ID.