Package org.wickedsource.docxstamper.processor

Class BaseCommentProcessor

java.lang.Object

org.wickedsource.docxstamper.processor.BaseCommentProcessor

All Implemented Interfaces:

ICommentProcessor

Direct Known Subclasses:

DisplayIfProcessor, ParagraphRepeatProcessor, RepeatDocPartProcessor, RepeatProcessor, ReplaceWithProcessor, TableResolver

public abstract class BaseCommentProcessor
extends Object
implements ICommentProcessor

Field Summary

Fields

Modifier and Type	Field	Description
protected DocxStamperConfiguration	configuration
protected PlaceholderReplacer	placeholderReplacer
protected TypeResolverRegistry	typeResolverRegistry

Constructor Summary

Constructors

Constructor	Description
BaseCommentProcessor(DocxStamperConfiguration config, TypeResolverRegistry typeResolverRegistry)

Method Summary

Modifier and Type	Method	Description
CommentWrapper	getCurrentCommentWrapper()
org.docx4j.wml.R	getCurrentRun()
org.docx4j.openpackaging.packages.WordprocessingMLPackage	getDocument()
org.docx4j.wml.P	getParagraph()
void	setCurrentCommentWrapper(CommentWrapper currentCommentWrapper)	Passes the comment range wrapper that is currently being processed (i.e.
void	setCurrentRun(org.docx4j.wml.R run)	Passes the run that is currently being processed (i.e.
void	setDocument(org.docx4j.openpackaging.packages.WordprocessingMLPackage document)	Passes the processed document, in order to make all linked data (images, etc) available to processors that need it (example : repeatDocPart)
void	setParagraph(org.docx4j.wml.P paragraph)	Passes the paragraph that is currently being processed (i.e.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.wickedsource.docxstamper.api.commentprocessor.ICommentProcessor

commitChanges, reset

Field Detail

typeResolverRegistry

protected final TypeResolverRegistry typeResolverRegistry

configuration

protected final DocxStamperConfiguration configuration

placeholderReplacer

protected final PlaceholderReplacer placeholderReplacer

Constructor Detail

BaseCommentProcessor

public BaseCommentProcessor(DocxStamperConfiguration config,
                            TypeResolverRegistry typeResolverRegistry)

Method Detail

getCurrentRun

public org.docx4j.wml.R getCurrentRun()

setCurrentRun

public void setCurrentRun(org.docx4j.wml.R run)

Description copied from interface: ICommentProcessor

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 ICommentProcessor

Parameters:

run - coordinates of the currently processed run within the template.

getParagraph

public org.docx4j.wml.P getParagraph()

setParagraph

public void setParagraph(org.docx4j.wml.P paragraph)

Description copied from interface: ICommentProcessor

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 ICommentProcessor

Parameters:

paragraph - coordinates of the currently processed paragraph within the template.

setCurrentCommentWrapper

public void setCurrentCommentWrapper(CommentWrapper currentCommentWrapper)

Description copied from interface: ICommentProcessor

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 ICommentProcessor

Parameters:

currentCommentWrapper - of the currently processed comment within the template.

getCurrentCommentWrapper

public CommentWrapper getCurrentCommentWrapper()

setDocument

public void setDocument(org.docx4j.openpackaging.packages.WordprocessingMLPackage document)

Description copied from interface: ICommentProcessor

Passes the processed document, in order to make all linked data (images, etc) available to processors that need it (example : repeatDocPart)

Specified by:

setDocument in interface ICommentProcessor

Parameters:

document - DocX template being processed.

getDocument

public org.docx4j.openpackaging.packages.WordprocessingMLPackage getDocument()