Package org.wickedsource.docxstamper.util

Class CommentWrapper

java.lang.Object
org.wickedsource.docxstamper.util.CommentWrapper
public class CommentWrapper extends Object

CommentWrapper class.

Version:
1.6.6
Author:
Joseph Verron

  • Constructor Summary

    Constructors
    Constructor
    Description
    CommentWrapper()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Set<CommentWrapper>
    getChildren()
    Getter for the field children.
    org.docx4j.wml.Comments.Comment
    getComment()
    Getter for the field comment.
    org.docx4j.wml.CommentRangeEnd
    getCommentRangeEnd()
    Getter for the field commentRangeEnd.
    org.docx4j.wml.CommentRangeStart
    getCommentRangeStart()
    Getter for the field commentRangeStart.
    org.docx4j.wml.R.CommentReference
    getCommentReference()
    Getter for the field commentReference.
    org.docx4j.wml.ContentAccessor
    getParent()
    getParent.
    List<Object>
    getRepeatElements()
    getRepeatElements.
    org.docx4j.openpackaging.packages.WordprocessingMLPackage
    getSubTemplate(org.docx4j.openpackaging.packages.WordprocessingMLPackage document)
    Creates a new document containing only the elements between the comment range anchors.
    org.docx4j.openpackaging.packages.WordprocessingMLPackage
    tryBuildingSubtemplate(org.docx4j.openpackaging.packages.WordprocessingMLPackage document)
    Creates a new document containing only the elements between the comment range anchors.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • CommentWrapper

      public CommentWrapper()

  • Method Details

    • getParent

      public org.docx4j.wml.ContentAccessor getParent()

      getParent.

      Returns:
      the comment's author.

    • getRepeatElements

      public List<Object> getRepeatElements()

      getRepeatElements.

      Returns:
      the elements in the document that are between the comment range anchors.

    • getSubTemplate

      public org.docx4j.openpackaging.packages.WordprocessingMLPackage getSubTemplate(org.docx4j.openpackaging.packages.WordprocessingMLPackage document) throws Exception
      Creates a new document containing only the elements between the comment range anchors.
      Parameters:
      document - the document from which to copy the elements.
      Returns:
      a new document containing only the elements between the comment range anchors.
      Throws:
      Exception - if the subtemplate could not be created.

    • tryBuildingSubtemplate

      public org.docx4j.openpackaging.packages.WordprocessingMLPackage tryBuildingSubtemplate(org.docx4j.openpackaging.packages.WordprocessingMLPackage document)
      Creates a new document containing only the elements between the comment range anchors. If the subtemplate could not be created, a DocxStamperException is thrown.
      Parameters:
      document - the document from which to copy the elements.
      Returns:
      a new document containing only the elements between the comment range anchors.

    • getCommentRangeEnd

      public org.docx4j.wml.CommentRangeEnd getCommentRangeEnd()

      Getter for the field commentRangeEnd.

      Returns:
      a CommentRangeEnd object

    • getCommentRangeStart

      public org.docx4j.wml.CommentRangeStart getCommentRangeStart()

      Getter for the field commentRangeStart.

      Returns:
      a CommentRangeStart object

    • getCommentReference

      public org.docx4j.wml.R.CommentReference getCommentReference()

      Getter for the field commentReference.

      Returns:
      a R.CommentReference object

    • getChildren

      public Set<CommentWrapper> getChildren()

      Getter for the field children.

      Returns:
      a Set object

    • getComment

      public org.docx4j.wml.Comments.Comment getComment()

      Getter for the field comment.

      Returns:
      a Comments.Comment object