Module pro.verron.officestamper
Package pro.verron.officestamper.api

Class AbstractCommentProcessor

java.lang.Object
pro.verron.officestamper.api.AbstractCommentProcessor
All Implemented Interfaces:
CommentProcessor
Direct Known Subclasses:
BaseCommentProcessor
public abstract class AbstractCommentProcessor extends Object implements CommentProcessor
AbstractCommentProcessor is an abstract base class for comment processors. It implements the CommentProcessor interface. It provides common functionality and fields that subclasses can use.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected final ParagraphPlaceholderReplacer
    placeholderReplacer
    PlaceholderReplacer used to replace expressions in the comment text.

  • Constructor Summary

    Constructors
    Constructor
    Description
    AbstractCommentProcessor(ParagraphPlaceholderReplacer placeholderReplacer)
    Creates an instance of AbstractCommentProcessor with the given ParagraphPlaceholderReplacer.

  • Method Summary

    Modifier and Type
    Method
    Description
    Comment
    getCurrentCommentWrapper()
    Getter for the field currentCommentWrapper.
    org.docx4j.wml.R
    getCurrentRun()
    Getter for the field currentRun.
    org.docx4j.openpackaging.packages.WordprocessingMLPackage
    getDocument()
    Deprecated, for removal: This API element is subject to removal in a future version.
    the document is passed to the processor through the commitChange method now and will probably pe passed through the constructor in the future
    org.docx4j.wml.P
    getParagraph()
    Getter for the field paragraph.
    void
    setCurrentCommentWrapper(Comment currentComment)
    Passes the comment range wrapper that is currently being processed (i.e., the start and end of comment that in the .docx template).
    void
    setCurrentRun(org.docx4j.wml.R run)
    Passes the run that is currently being processed (i.e., the run that is commented in the .docx template).
    void
    setDocument(org.docx4j.openpackaging.packages.WordprocessingMLPackage document)
    Deprecated, for removal: This API element is subject to removal in a future version.
    the document is passed to the processor through the commitChange method now, and will probably pe passed through the constructor in the future
    void
    setParagraph(org.docx4j.wml.P paragraph)
    Passes the paragraph that is currently being processed (i.e., the paragraph that is commented in the .docx template).

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface pro.verron.officestamper.api.CommentProcessor

    commitChanges, reset

  • Field Details

    • placeholderReplacer

      protected final ParagraphPlaceholderReplacer placeholderReplacer
      PlaceholderReplacer used to replace expressions in the comment text.

  • Constructor Details

    • AbstractCommentProcessor

      public AbstractCommentProcessor(ParagraphPlaceholderReplacer placeholderReplacer)
      Creates an instance of AbstractCommentProcessor with the given ParagraphPlaceholderReplacer.
      Parameters:
      placeholderReplacer - the ParagraphPlaceholderReplacer used to replace expressions in the comment text

  • Method Details

    • getCurrentCommentWrapper

      public Comment getCurrentCommentWrapper()

      Getter for the field currentCommentWrapper.

      Returns:
      a Comment object

    • setCurrentCommentWrapper

      public void setCurrentCommentWrapper(Comment currentComment)
      Passes the comment range wrapper that is currently being processed (i.e., the start and end of comment that in the .docx template). This method is always called BEFORE the custom methods of the custom comment processor interface are called.
      Specified by:
      setCurrentCommentWrapper in interface CommentProcessor
      Parameters:
      currentComment - of the currently processed comment within the template.

    • getParagraph

      public org.docx4j.wml.P getParagraph()

      Getter for the field paragraph.

      Returns:
      a P object

    • setParagraph

      public void setParagraph(org.docx4j.wml.P paragraph)
      Passes the paragraph that is currently being processed (i.e., the paragraph that is commented in the .docx template). This method is always called BEFORE the custom methods of the custom comment processor interface are called.
      Specified by:
      setParagraph in interface CommentProcessor
      Parameters:
      paragraph - coordinates of the currently processed paragraph within the template.

    • getCurrentRun

      public org.docx4j.wml.R getCurrentRun()

      Getter for the field currentRun.

      Returns:
      a R object

    • setCurrentRun

      public void setCurrentRun(org.docx4j.wml.R run)
      Passes the run that is currently being processed (i.e., the run that is commented in the .docx template). This method is always called BEFORE the custom methods of the custom comment processor interface are called.
      Specified by:
      setCurrentRun in interface CommentProcessor
      Parameters:
      run - coordinates of the currently processed run within the template.

    • getDocument

      @Deprecated(since="1.6.5", forRemoval=true) public org.docx4j.openpackaging.packages.WordprocessingMLPackage getDocument()
      Deprecated, for removal: This API element is subject to removal in a future version.
      the document is passed to the processor through the commitChange method now and will probably pe passed through the constructor in the future

      Getter for the field document.

      Returns:
      a WordprocessingMLPackage object

    • setDocument

      @Deprecated(since="1.6.5", forRemoval=true) public void setDocument(org.docx4j.openpackaging.packages.WordprocessingMLPackage document)
      Deprecated, for removal: This API element is subject to removal in a future version.
      the document is passed to the processor through the commitChange method now, and will probably pe passed through the constructor in the future
      Passes the processed document, to make all linked data (images, etc.) available to processors that need it (example: repeatDocPart)
      Specified by:
      setDocument in interface CommentProcessor
      Parameters:
      document - DocX template being processed.