Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AbstractToTextResolver<S> - Class in org.wickedsource.docxstamper.replace.typeresolver
-
Abstract ITypeResolver that takes a String from the implementing sub class and creates a Run of text from it.
- AbstractToTextResolver() - Constructor for class org.wickedsource.docxstamper.replace.typeresolver.AbstractToTextResolver
- addCommentProcessor(Class<?>, DocxStamperConfiguration.CommentProcessorFactory) - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration
-
Registers the specified ICommentProcessor as an implementation of the specified interface.
- addEmptyParagraph(Tc) - Static method in class org.wickedsource.docxstamper.util.TableCellUtil
- addPreprocessor(PreProcessor) - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration
- addTypeResolver(Class<T>, ITypeResolver) - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration
-
Registers the given ITypeResolver for the given class.
- allElements(WordprocessingMLPackage) - Static method in class org.wickedsource.docxstamper.util.DocumentUtil
- applyParagraphStyle(P, R) - Static method in class org.wickedsource.docxstamper.util.RunUtil
-
Applies the style of the given paragraph to the given content object (if the content object is a Run).
- applySectionBreakToParagraph(SectPr, P) - Static method in class org.wickedsource.docxstamper.util.SectionUtil
B
- BaseCommentProcessor - Class in org.wickedsource.docxstamper.processor
- BaseCommentProcessor(PlaceholderReplacer) - Constructor for class org.wickedsource.docxstamper.processor.BaseCommentProcessor
- BaseCoordinatesWalker - Class in org.wickedsource.docxstamper.util.walk
- BaseCoordinatesWalker(WordprocessingMLPackage) - Constructor for class org.wickedsource.docxstamper.util.walk.BaseCoordinatesWalker
- BaseDocumentWalker - Class in org.wickedsource.docxstamper.util.walk
- BaseDocumentWalker(ContentAccessor) - Constructor for class org.wickedsource.docxstamper.util.walk.BaseDocumentWalker
- build() - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration
-
Deprecated, for removal: This API element is subject to removal in a future version.use new DocxStamper(DocxStamperConfiguration configuration) instead
C
- CommentProcessingException - Exception in org.wickedsource.docxstamper.processor
- CommentProcessingException(String, P) - Constructor for exception org.wickedsource.docxstamper.processor.CommentProcessingException
- CommentProcessorFactory - Class in org.wickedsource.docxstamper.processor
- CommentProcessorFactory(DocxStamperConfiguration) - Constructor for class org.wickedsource.docxstamper.processor.CommentProcessorFactory
- CommentProcessorRegistry - Class in org.wickedsource.docxstamper.processor
-
Allows registration of ICommentProcessor objects.
- CommentProcessorRegistry(PlaceholderReplacer, ExpressionResolver, Map<Class<?>, Object>, boolean) - Constructor for class org.wickedsource.docxstamper.processor.CommentProcessorRegistry
- CommentUtil - Class in org.wickedsource.docxstamper.util
- CommentWrapper - Class in org.wickedsource.docxstamper.util
- CommentWrapper() - Constructor for class org.wickedsource.docxstamper.util.CommentWrapper
- commitChanges(WordprocessingMLPackage) - Method in interface org.wickedsource.docxstamper.api.commentprocessor.ICommentProcessor
-
This method is called after all comments in the .docx template have been passed to the comment processor.
- commitChanges(WordprocessingMLPackage) - Method in class org.wickedsource.docxstamper.processor.displayif.DisplayIfProcessor
- commitChanges(WordprocessingMLPackage) - Method in class org.wickedsource.docxstamper.processor.repeat.ParagraphRepeatProcessor
- commitChanges(WordprocessingMLPackage) - Method in class org.wickedsource.docxstamper.processor.repeat.RepeatDocPartProcessor
- commitChanges(WordprocessingMLPackage) - Method in class org.wickedsource.docxstamper.processor.repeat.RepeatProcessor
- commitChanges(WordprocessingMLPackage) - Method in class org.wickedsource.docxstamper.processor.replaceExpression.ReplaceWithProcessor
- commitChanges(WordprocessingMLPackage) - Method in class org.wickedsource.docxstamper.processor.table.TableResolver
- configureEvaluationContext(StandardEvaluationContext) - Method in interface org.wickedsource.docxstamper.api.EvaluationContextConfigurer
-
Configure the context before it's used by docxstamper.
- configureEvaluationContext(StandardEvaluationContext) - Method in class org.wickedsource.docxstamper.el.NoOpEvaluationContextConfigurer
- CoordinatesWalker - Class in org.wickedsource.docxstamper.util.walk
- CoordinatesWalker(WordprocessingMLPackage) - Constructor for class org.wickedsource.docxstamper.util.walk.CoordinatesWalker
- create(Object) - Static method in class org.wickedsource.docxstamper.util.RunUtil
-
Creates a new run with the given object as content.
- create(String) - Static method in class org.wickedsource.docxstamper.util.RunUtil
-
Creates a new run with the specified text.
- create(String...) - Static method in class org.wickedsource.docxstamper.util.ParagraphUtil
-
Creates a new paragraph.
- create(String, P) - Static method in class org.wickedsource.docxstamper.util.RunUtil
-
Creates a new run with the specified text and inherits the style of the parent paragraph.
- createRun(String) - Static method in class org.wickedsource.docxstamper.util.RunUtil
- createRunWithImage(String, String, Integer, BinaryPartAbstractImage) - Static method in class org.wickedsource.docxstamper.replace.typeresolver.image.ImageResolver
- createText(String) - Static method in class org.wickedsource.docxstamper.util.RunUtil
D
- DateResolver - Class in org.wickedsource.docxstamper.replace.typeresolver
-
This ITypeResolver creates a formatted date String for expressions that return a Date object.
- DateResolver() - Constructor for class org.wickedsource.docxstamper.replace.typeresolver.DateResolver
- DateResolver(DateTimeFormatter) - Constructor for class org.wickedsource.docxstamper.replace.typeresolver.DateResolver
-
Creates a new DateResolver.
- deleteComment(CommentWrapper) - Static method in class org.wickedsource.docxstamper.util.CommentUtil
- deleteCommentFromElement(ContentAccessor, BigInteger) - Static method in class org.wickedsource.docxstamper.util.CommentUtil
- deleteObject(Object) - Method in class org.wickedsource.docxstamper.util.ObjectDeleter
- deleteParagraph(P) - Method in class org.wickedsource.docxstamper.util.ObjectDeleter
- deleteTable(Tbl) - Method in class org.wickedsource.docxstamper.util.ObjectDeleter
- deleteTableRow(Tr) - Method in class org.wickedsource.docxstamper.util.ObjectDeleter
- displayIf(PlaceholderReplacer) - Method in class org.wickedsource.docxstamper.processor.CommentProcessorFactory
- DisplayIfProcessor - Class in org.wickedsource.docxstamper.processor.displayif
- displayParagraphIf(Boolean) - Method in class org.wickedsource.docxstamper.processor.displayif.DisplayIfProcessor
- displayParagraphIf(Boolean) - Method in interface org.wickedsource.docxstamper.processor.displayif.IDisplayIfProcessor
-
May be called to delete the commented paragraph or not, depending on the given boolean condition.
- displayParagraphIfPresent(Object) - Method in class org.wickedsource.docxstamper.processor.displayif.DisplayIfProcessor
- displayParagraphIfPresent(Object) - Method in interface org.wickedsource.docxstamper.processor.displayif.IDisplayIfProcessor
-
May be called to delete the commented paragraph or not, depending on the presence of the given data.
- displayTableIf(Boolean) - Method in class org.wickedsource.docxstamper.processor.displayif.DisplayIfProcessor
- displayTableIf(Boolean) - Method in interface org.wickedsource.docxstamper.processor.displayif.IDisplayIfProcessor
-
May be called to delete the table surrounding the commented paragraph, depending on the given boolean condition.
- displayTableRowIf(Boolean) - Method in class org.wickedsource.docxstamper.processor.displayif.DisplayIfProcessor
- displayTableRowIf(Boolean) - Method in interface org.wickedsource.docxstamper.processor.displayif.IDisplayIfProcessor
-
May be called to delete the table surrounding the commented paragraph, depending on the given boolean condition.
- DocumentUtil - Class in org.wickedsource.docxstamper.util
- DocumentWalker - Class in org.wickedsource.docxstamper.util.walk
- DocumentWalker(ContentAccessor) - Constructor for class org.wickedsource.docxstamper.util.walk.DocumentWalker
- DocxImageExtractor - Class in org.wickedsource.docxstamper.util
- DocxImageExtractor(WordprocessingMLPackage) - Constructor for class org.wickedsource.docxstamper.util.DocxImageExtractor
- DocxStamper<T> - Class in org.wickedsource.docxstamper
-
Main class of the docx-stamper library.
- DocxStamper() - Constructor for class org.wickedsource.docxstamper.DocxStamper
-
Deprecated, for removal: This API element is subject to removal in a future version.since 1.6.4, use
StamperFactory.newDocxStamper()orStamperFactory.nopreprocessingDocxStamper()instead. - DocxStamper(DocxStamperConfiguration) - Constructor for class org.wickedsource.docxstamper.DocxStamper
-
Creates a new DocxStamper with the given configuration.
- DocxStamperConfiguration - Class in org.wickedsource.docxstamper
-
Provides configuration parameters for DocxStamper.
- DocxStamperConfiguration() - Constructor for class org.wickedsource.docxstamper.DocxStamperConfiguration
- DocxStamperException - Exception in org.wickedsource.docxstamper.api
-
This exception is thrown when DocxStamper encounters an error.
- DocxStamperException(String) - Constructor for exception org.wickedsource.docxstamper.api.DocxStamperException
- DocxStamperException(String, Throwable) - Constructor for exception org.wickedsource.docxstamper.api.DocxStamperException
- DocxStamperException(Throwable) - Constructor for exception org.wickedsource.docxstamper.api.DocxStamperException
E
- empty() - Static method in class org.wickedsource.docxstamper.processor.table.StampTable
- equals(Object) - Method in class org.wickedsource.docxstamper.util.IndexedRun
- EvaluationContextConfigurer - Interface in org.wickedsource.docxstamper.api
-
Allows for custom configuration of a spring expression language
EvaluationContext. - execute(EvaluationContext, Object, Object...) - Method in class org.wickedsource.docxstamper.el.StandardMethodExecutor
- exposeInterfaceToExpressionLanguage(Class<?>, Object) - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration
-
Exposes all methods of a given interface to the expression language.
- ExpressionResolver - Class in org.wickedsource.docxstamper.el
- ExpressionResolver(boolean, Map<Class<?>, Object>, Map<Class<?>, Object>, EvaluationContextConfigurer) - Constructor for class org.wickedsource.docxstamper.el.ExpressionResolver
- ExpressionUtil - Class in org.wickedsource.docxstamper.el
- ExpressionUtil() - Constructor for class org.wickedsource.docxstamper.el.ExpressionUtil
- extractElements(Object, Class<T>) - Static method in class org.wickedsource.docxstamper.util.DocumentUtil
F
- FallbackResolver - Class in org.wickedsource.docxstamper.replace.typeresolver
-
This ITypeResolver may serve as a fallback when there is no ITypeResolver available for a certain type.
- FallbackResolver() - Constructor for class org.wickedsource.docxstamper.replace.typeresolver.FallbackResolver
- findProcessorExpressions(String) - Static method in class org.wickedsource.docxstamper.el.ExpressionUtil
-
Finds all processor expressions in a text and returns them as list.
- findVariableExpressions(String) - Static method in class org.wickedsource.docxstamper.el.ExpressionUtil
-
Finds all variable expressions in a text and returns them as list.
G
- getAltText() - Method in class org.wickedsource.docxstamper.replace.typeresolver.image.Image
-
Returns the expected alternative text to display for user that can't see the image itself.
- getChildren() - Method in class org.wickedsource.docxstamper.util.CommentWrapper
- getComment() - Method in class org.wickedsource.docxstamper.util.CommentWrapper
- getCommentAround(R, WordprocessingMLPackage) - Static method in class org.wickedsource.docxstamper.util.CommentUtil
-
Returns the comment the given DOCX4J run is commented with.
- getCommentFor(ContentAccessor, WordprocessingMLPackage) - Static method in class org.wickedsource.docxstamper.util.CommentUtil
-
Returns the first comment found for the given docx object.
- getCommentProcessors() - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration
- getCommentRangeEnd() - Method in class org.wickedsource.docxstamper.util.CommentWrapper
- getCommentRangeStart() - Method in class org.wickedsource.docxstamper.util.CommentWrapper
- getCommentReference() - Method in class org.wickedsource.docxstamper.util.CommentWrapper
- getComments(WordprocessingMLPackage) - Static method in class org.wickedsource.docxstamper.util.CommentUtil
- getCommentString(Comments.Comment) - Static method in class org.wickedsource.docxstamper.util.CommentUtil
-
Returns the string value of the specified comment object.
- getCommentStringFor(ContentAccessor, WordprocessingMLPackage) - Static method in class org.wickedsource.docxstamper.util.CommentUtil
- getCurrentCommentWrapper() - Method in class org.wickedsource.docxstamper.processor.BaseCommentProcessor
- getCurrentRun() - Method in class org.wickedsource.docxstamper.processor.BaseCommentProcessor
- getDefaultResolver() - Method in class org.wickedsource.docxstamper.api.typeresolver.TypeResolverRegistry
- getDocument() - Method in class org.wickedsource.docxstamper.processor.BaseCommentProcessor
- getEndIndex() - Method in class org.wickedsource.docxstamper.util.IndexedRun
- getEvaluationContextConfigurer() - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration
- getExpressionFunctions() - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration
- getFilename() - Method in class org.wickedsource.docxstamper.replace.typeresolver.image.Image
- getImageBytes() - Method in class org.wickedsource.docxstamper.replace.typeresolver.image.Image
- getImageRelationshipId(Drawing) - Static method in class org.wickedsource.docxstamper.util.DocumentUtil
-
Retrieve an embedded drawing relationship id.
- getIndexInParent() - Method in class org.wickedsource.docxstamper.util.IndexedRun
- getLineBreakPlaceholder() - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration
- getMaxWidth() - Method in class org.wickedsource.docxstamper.replace.typeresolver.image.Image
-
The expected max width for this image
- getNullValuesDefault() - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration
- getParagraph() - Method in class org.wickedsource.docxstamper.processor.BaseCommentProcessor
- getParagraph() - Method in class org.wickedsource.docxstamper.util.ParagraphWrapper
- getParagraphSectionBreak(P) - Static method in class org.wickedsource.docxstamper.util.SectionUtil
- getParagraphsFromObject(Object) - Static method in class org.wickedsource.docxstamper.util.DocumentUtil
- getParagraphsInsideComment(P) - Static method in class org.wickedsource.docxstamper.processor.repeat.ParagraphRepeatProcessor
- getParent() - Method in class org.wickedsource.docxstamper.util.CommentWrapper
- getPreprocessors() - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration
- getPreviousSectionBreakIfPresent(Object, ContentAccessor) - Static method in class org.wickedsource.docxstamper.util.SectionUtil
- getRepeatElements() - Method in class org.wickedsource.docxstamper.util.CommentWrapper
- getResolverForType(Class<T>) - Method in class org.wickedsource.docxstamper.api.typeresolver.TypeResolverRegistry
-
Gets the ITypeResolver that was registered for the specified type.
- getRun() - Method in class org.wickedsource.docxstamper.util.IndexedRun
- getRunDrawingAltText(R) - Method in class org.wickedsource.docxstamper.util.DocxImageExtractor
- getRunDrawingFilename(R) - Method in class org.wickedsource.docxstamper.util.DocxImageExtractor
- getRunDrawingMaxWidth(R) - Method in class org.wickedsource.docxstamper.util.DocxImageExtractor
- getRuns() - Method in class org.wickedsource.docxstamper.util.ParagraphWrapper
-
Returns the list of runs that are aggregated.
- getStartIndex() - Method in class org.wickedsource.docxstamper.util.IndexedRun
- getSubTemplate(WordprocessingMLPackage) - Method in class org.wickedsource.docxstamper.util.CommentWrapper
- getTableCellsFromObject(Object) - Static method in class org.wickedsource.docxstamper.util.DocumentUtil
- getTableFromObject(Object) - Static method in class org.wickedsource.docxstamper.util.DocumentUtil
- getTableRowsFromObject(Object) - Static method in class org.wickedsource.docxstamper.util.DocumentUtil
- getText() - Method in class org.wickedsource.docxstamper.util.ParagraphWrapper
-
Returns the aggregated text over all runs.
- getText(R) - Static method in class org.wickedsource.docxstamper.util.RunUtil
-
Returns the text string of a run.
- getUnresolvedExpressionsDefaultValue() - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration
H
- hashCode() - Method in class org.wickedsource.docxstamper.util.IndexedRun
- hasNoParagraphOrTable(Tc) - Static method in class org.wickedsource.docxstamper.util.TableCellUtil
- headers() - Method in class org.wickedsource.docxstamper.processor.table.StampTable
I
- ICommentProcessor - Interface in org.wickedsource.docxstamper.api.commentprocessor
-
In a .docx template used by DocxStamper, you can comment paragraphs of text to manipulate them.
- IDisplayIfProcessor - Interface in org.wickedsource.docxstamper.processor.displayif
- Image - Class in org.wickedsource.docxstamper.replace.typeresolver.image
-
This class describes an image which will be inserted into document.
- Image(byte[]) - Constructor for class org.wickedsource.docxstamper.replace.typeresolver.image.Image
- Image(byte[], Integer) - Constructor for class org.wickedsource.docxstamper.replace.typeresolver.image.Image
- Image(InputStream) - Constructor for class org.wickedsource.docxstamper.replace.typeresolver.image.Image
- Image(InputStream, Integer) - Constructor for class org.wickedsource.docxstamper.replace.typeresolver.image.Image
- ImageResolver - Class in org.wickedsource.docxstamper.replace.typeresolver.image
-
This ITypeResolver allows context objects to return objects of type Image.
- ImageResolver() - Constructor for class org.wickedsource.docxstamper.replace.typeresolver.image.ImageResolver
- IndexedRun - Class in org.wickedsource.docxstamper.util
- IndexedRun(int, int, int, R) - Constructor for class org.wickedsource.docxstamper.util.IndexedRun
- IParagraphRepeatProcessor - Interface in org.wickedsource.docxstamper.processor.repeat
- IRepeatDocPartProcessor - Interface in org.wickedsource.docxstamper.processor.repeat
- IRepeatProcessor - Interface in org.wickedsource.docxstamper.processor.repeat
- IReplaceWithProcessor - Interface in org.wickedsource.docxstamper.processor.replaceExpression
- isFailOnUnresolvedExpression() - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration
- isLeaveEmptyOnExpressionError() - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration
- isOddNumberOfSectionBreaks(List<Object>) - Static method in class org.wickedsource.docxstamper.util.SectionUtil
- isReplaceNullValues() - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration
- isReplaceUnresolvedExpressions() - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration
- isTouchedByRange(int, int) - Method in class org.wickedsource.docxstamper.util.IndexedRun
-
Determines whether the specified range of start and end index touches this run.
- ITableResolver - Interface in org.wickedsource.docxstamper.processor.table
-
This interface is used to resolve a table in the template document.
- ITypeResolver<T> - Interface in org.wickedsource.docxstamper.api.typeresolver
-
A type resolver is responsible for mapping an object of a certain Java class to an object of the DOCX4J api that can be put into the .docx document.
L
- lastElement(WordprocessingMLPackage) - Static method in class org.wickedsource.docxstamper.util.DocumentUtil
- leaveEmptyOnExpressionError(boolean) - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration
-
If an error is caught while evaluating an expression the expression will be replaced with an empty string instead of leaving the original expression in the document.
- LocalDateResolver - Class in org.wickedsource.docxstamper.replace.typeresolver
- LocalDateResolver() - Constructor for class org.wickedsource.docxstamper.replace.typeresolver.LocalDateResolver
- LocalDateResolver(DateTimeFormatter) - Constructor for class org.wickedsource.docxstamper.replace.typeresolver.LocalDateResolver
- LocalDateTimeResolver - Class in org.wickedsource.docxstamper.replace.typeresolver
- LocalDateTimeResolver() - Constructor for class org.wickedsource.docxstamper.replace.typeresolver.LocalDateTimeResolver
- LocalDateTimeResolver(DateTimeFormatter) - Constructor for class org.wickedsource.docxstamper.replace.typeresolver.LocalDateTimeResolver
- LocalTimeResolver - Class in org.wickedsource.docxstamper.replace.typeresolver
- LocalTimeResolver() - Constructor for class org.wickedsource.docxstamper.replace.typeresolver.LocalTimeResolver
- LocalTimeResolver(DateTimeFormatter) - Constructor for class org.wickedsource.docxstamper.replace.typeresolver.LocalTimeResolver
M
- MergeSameStyleRuns - Class in org.wickedsource.docxstamper.preprocessor
-
Merges runs with the same style that are next to each other.
- MergeSameStyleRuns() - Constructor for class org.wickedsource.docxstamper.preprocessor.MergeSameStyleRuns
N
- newDocxStamper() - Method in class pro.verron.docxstamper.StamperFactory
-
Creates a new DocxStamper with the default configuration.
- newInstance(PlaceholderReplacer) - Static method in class org.wickedsource.docxstamper.processor.displayif.DisplayIfProcessor
- newInstance(PlaceholderReplacer) - Static method in class org.wickedsource.docxstamper.processor.repeat.ParagraphRepeatProcessor
- newInstance(PlaceholderReplacer) - Static method in class org.wickedsource.docxstamper.processor.repeat.RepeatProcessor
- newInstance(PlaceholderReplacer) - Static method in class org.wickedsource.docxstamper.processor.replaceExpression.ReplaceWithProcessor
- newInstance(PlaceholderReplacer) - Static method in class org.wickedsource.docxstamper.processor.table.TableResolver
- newInstance(PlaceholderReplacer, String) - Static method in class org.wickedsource.docxstamper.processor.repeat.ParagraphRepeatProcessor
- newInstance(PlaceholderReplacer, String) - Static method in class org.wickedsource.docxstamper.processor.replaceExpression.ReplaceWithProcessor
- newInstance(PlaceholderReplacer, String) - Static method in class org.wickedsource.docxstamper.processor.table.TableResolver
- newInstance(PlaceholderReplacer, OpcStamper<WordprocessingMLPackage>) - Static method in class org.wickedsource.docxstamper.processor.repeat.RepeatDocPartProcessor
- newInstance(PlaceholderReplacer, OpcStamper<WordprocessingMLPackage>, String) - Static method in class org.wickedsource.docxstamper.processor.repeat.RepeatDocPartProcessor
- newInstanceWithNullReplacement(PlaceholderReplacer) - Static method in class org.wickedsource.docxstamper.processor.repeat.RepeatProcessor
- NoOpEvaluationContextConfigurer - Class in org.wickedsource.docxstamper.el
-
EvaluationContextConfigurerthat does no customization. - NoOpEvaluationContextConfigurer() - Constructor for class org.wickedsource.docxstamper.el.NoOpEvaluationContextConfigurer
- nopreprocessingDocxStamper() - Method in class pro.verron.docxstamper.StamperFactory
-
Creates a new DocxStamper with the default configuration.
- nullReplacementValue() - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration
- nullValuesDefault(String) - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration
-
Indicates if expressions that resolve to null should be replaced by a global default value.
O
- ObjectDeleter - Class in org.wickedsource.docxstamper.util
- ObjectDeleter() - Constructor for class org.wickedsource.docxstamper.util.ObjectDeleter
- onCommentRangeEnd(CommentRangeEnd) - Method in class org.wickedsource.docxstamper.util.walk.BaseDocumentWalker
- onCommentRangeEnd(CommentRangeEnd) - Method in class org.wickedsource.docxstamper.util.walk.DocumentWalker
- onCommentRangeStart(CommentRangeStart) - Method in class org.wickedsource.docxstamper.util.walk.BaseDocumentWalker
- onCommentRangeStart(CommentRangeStart) - Method in class org.wickedsource.docxstamper.util.walk.DocumentWalker
- onCommentReference(R.CommentReference) - Method in class org.wickedsource.docxstamper.util.walk.BaseDocumentWalker
- onCommentReference(R.CommentReference) - Method in class org.wickedsource.docxstamper.util.walk.DocumentWalker
- onParagraph(P) - Method in class org.wickedsource.docxstamper.processor.repeat.ParagraphResolverDocumentWalker
- onParagraph(P) - Method in class org.wickedsource.docxstamper.util.walk.BaseCoordinatesWalker
- onParagraph(P) - Method in class org.wickedsource.docxstamper.util.walk.BaseDocumentWalker
- onParagraph(P) - Method in class org.wickedsource.docxstamper.util.walk.CoordinatesWalker
- onParagraph(P) - Method in class org.wickedsource.docxstamper.util.walk.DocumentWalker
- onRun(R) - Method in class org.wickedsource.docxstamper.util.walk.BaseDocumentWalker
- onRun(R) - Method in class org.wickedsource.docxstamper.util.walk.DocumentWalker
- onRun(R, P) - Method in class org.wickedsource.docxstamper.util.walk.BaseCoordinatesWalker
- onRun(R, P) - Method in class org.wickedsource.docxstamper.util.walk.CoordinatesWalker
- onTable(Tbl) - Method in class org.wickedsource.docxstamper.util.walk.BaseDocumentWalker
- onTable(Tbl) - Method in class org.wickedsource.docxstamper.util.walk.DocumentWalker
- onTableCell(Tc) - Method in class org.wickedsource.docxstamper.util.walk.BaseDocumentWalker
- onTableCell(Tc) - Method in class org.wickedsource.docxstamper.util.walk.DocumentWalker
- onTableRow(Tr) - Method in class org.wickedsource.docxstamper.util.walk.BaseDocumentWalker
- onTableRow(Tr) - Method in class org.wickedsource.docxstamper.util.walk.DocumentWalker
- OpcStamper<T extends org.docx4j.openpackaging.packages.OpcPackage> - Interface in pro.verron.docxstamper
- org.wickedsource.docxstamper - package org.wickedsource.docxstamper
- org.wickedsource.docxstamper.api - package org.wickedsource.docxstamper.api
- org.wickedsource.docxstamper.api.commentprocessor - package org.wickedsource.docxstamper.api.commentprocessor
- org.wickedsource.docxstamper.api.preprocessor - package org.wickedsource.docxstamper.api.preprocessor
- org.wickedsource.docxstamper.api.typeresolver - package org.wickedsource.docxstamper.api.typeresolver
- org.wickedsource.docxstamper.el - package org.wickedsource.docxstamper.el
- org.wickedsource.docxstamper.preprocessor - package org.wickedsource.docxstamper.preprocessor
- org.wickedsource.docxstamper.processor - package org.wickedsource.docxstamper.processor
- org.wickedsource.docxstamper.processor.displayif - package org.wickedsource.docxstamper.processor.displayif
- org.wickedsource.docxstamper.processor.repeat - package org.wickedsource.docxstamper.processor.repeat
- org.wickedsource.docxstamper.processor.replaceExpression - package org.wickedsource.docxstamper.processor.replaceExpression
- org.wickedsource.docxstamper.processor.table - package org.wickedsource.docxstamper.processor.table
- org.wickedsource.docxstamper.replace - package org.wickedsource.docxstamper.replace
- org.wickedsource.docxstamper.replace.typeresolver - package org.wickedsource.docxstamper.replace.typeresolver
- org.wickedsource.docxstamper.replace.typeresolver.image - package org.wickedsource.docxstamper.replace.typeresolver.image
- org.wickedsource.docxstamper.util - package org.wickedsource.docxstamper.util
- org.wickedsource.docxstamper.util.walk - package org.wickedsource.docxstamper.util.walk
P
- ParagraphRepeatProcessor - Class in org.wickedsource.docxstamper.processor.repeat
- ParagraphResolverDocumentWalker - Class in org.wickedsource.docxstamper.processor.repeat
- ParagraphResolverDocumentWalker(Tr, Object, WordprocessingMLPackage, PlaceholderReplacer) - Constructor for class org.wickedsource.docxstamper.processor.repeat.ParagraphResolverDocumentWalker
- ParagraphUtil - Class in org.wickedsource.docxstamper.util
- ParagraphUtil() - Constructor for class org.wickedsource.docxstamper.util.ParagraphUtil
- ParagraphWrapper - Class in org.wickedsource.docxstamper.util
-
A "Run" defines a region of text within a docx document with a common set of properties.
- ParagraphWrapper(P) - Constructor for class org.wickedsource.docxstamper.util.ParagraphWrapper
- placeholderReplacer - Variable in class org.wickedsource.docxstamper.processor.BaseCommentProcessor
- PlaceholderReplacer - Class in org.wickedsource.docxstamper.replace
- PlaceholderReplacer(TypeResolverRegistry, ExpressionResolver, boolean, String, boolean, boolean, String, boolean, String) - Constructor for class org.wickedsource.docxstamper.replace.PlaceholderReplacer
- PreProcessor - Interface in org.wickedsource.docxstamper.api.preprocessor
- PRESERVE - Static variable in class org.wickedsource.docxstamper.util.RunUtil
- pro.verron.docxstamper - package pro.verron.docxstamper
- process(WordprocessingMLPackage) - Method in interface org.wickedsource.docxstamper.api.preprocessor.PreProcessor
- process(WordprocessingMLPackage) - Method in class org.wickedsource.docxstamper.preprocessor.MergeSameStyleRuns
- process(WordprocessingMLPackage) - Method in class org.wickedsource.docxstamper.preprocessor.RemoveProofErrors
R
- recalculateRuns() - Method in class org.wickedsource.docxstamper.util.ParagraphWrapper
- records() - Method in class org.wickedsource.docxstamper.processor.table.StampTable
- registerTypeResolver(Class<T>, ITypeResolver<T>) - Method in class org.wickedsource.docxstamper.api.typeresolver.TypeResolverRegistry
- RemoveProofErrors - Class in org.wickedsource.docxstamper.preprocessor
-
Removes all
ProofErrelements from the document. - RemoveProofErrors() - Constructor for class org.wickedsource.docxstamper.preprocessor.RemoveProofErrors
- repeat(PlaceholderReplacer) - Method in class org.wickedsource.docxstamper.processor.CommentProcessorFactory
- repeatDocPart(List<Object>) - Method in interface org.wickedsource.docxstamper.processor.repeat.IRepeatDocPartProcessor
-
May be called to mark a document part to be copied once for each element in the passed-in list.
- repeatDocPart(List<Object>) - Method in class org.wickedsource.docxstamper.processor.repeat.RepeatDocPartProcessor
- repeatDocPart(PlaceholderReplacer) - Method in class org.wickedsource.docxstamper.processor.CommentProcessorFactory
- RepeatDocPartProcessor - Class in org.wickedsource.docxstamper.processor.repeat
- repeatParagraph(List<Object>) - Method in interface org.wickedsource.docxstamper.processor.repeat.IParagraphRepeatProcessor
-
May be called to mark a paragraph to be copied once for each element in the passed-in list.
- repeatParagraph(List<Object>) - Method in class org.wickedsource.docxstamper.processor.repeat.ParagraphRepeatProcessor
- repeatParagraph(PlaceholderReplacer) - Method in class org.wickedsource.docxstamper.processor.CommentProcessorFactory
- RepeatProcessor - Class in org.wickedsource.docxstamper.processor.repeat
- repeatTableRow(List<Object>) - Method in interface org.wickedsource.docxstamper.processor.repeat.IRepeatProcessor
-
May be called to mark a table row to be copied once for each element in the passed-in list.
- repeatTableRow(List<Object>) - Method in class org.wickedsource.docxstamper.processor.repeat.RepeatProcessor
- replace(int, int, String) - Method in class org.wickedsource.docxstamper.util.IndexedRun
-
Replaces the substring starting at the given index with the given replacement string.
- replace(String, R) - Method in class org.wickedsource.docxstamper.util.ParagraphWrapper
-
Replaces the given placeholder String with the replacement object within the paragraph.
- replace(ParagraphWrapper, String, String) - Method in class org.wickedsource.docxstamper.replace.PlaceholderReplacer
- replaceNullValues(boolean) - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration
-
Indicates if expressions that resolve to null should be processed.
- replaceUnresolvedExpressions(boolean) - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration
-
Indicates if expressions that doesn't resolve should be replaced by a default value.
- replaceWith(PlaceholderReplacer) - Method in class org.wickedsource.docxstamper.processor.CommentProcessorFactory
- ReplaceWithProcessor - Class in org.wickedsource.docxstamper.processor.replaceExpression
- replaceWordWith(String) - Method in interface org.wickedsource.docxstamper.processor.replaceExpression.IReplaceWithProcessor
-
May be called to replace a single word inside a paragraph with an expression defined in a comment.
- replaceWordWith(String) - Method in class org.wickedsource.docxstamper.processor.replaceExpression.ReplaceWithProcessor
- reset() - Method in interface org.wickedsource.docxstamper.api.commentprocessor.ICommentProcessor
-
Resets all state in the comment processor so that it can be re-used in another stamping process.
- reset() - Method in class org.wickedsource.docxstamper.processor.CommentProcessorRegistry
- reset() - Method in class org.wickedsource.docxstamper.processor.displayif.DisplayIfProcessor
- reset() - Method in class org.wickedsource.docxstamper.processor.repeat.ParagraphRepeatProcessor
- reset() - Method in class org.wickedsource.docxstamper.processor.repeat.RepeatDocPartProcessor
- reset() - Method in class org.wickedsource.docxstamper.processor.repeat.RepeatProcessor
- reset() - Method in class org.wickedsource.docxstamper.processor.replaceExpression.ReplaceWithProcessor
- reset() - Method in class org.wickedsource.docxstamper.processor.table.TableResolver
- resolve(WordprocessingMLPackage, Image) - Method in class org.wickedsource.docxstamper.replace.typeresolver.image.ImageResolver
- resolve(WordprocessingMLPackage, S) - Method in class org.wickedsource.docxstamper.replace.typeresolver.AbstractToTextResolver
- resolve(WordprocessingMLPackage, T) - Method in interface org.wickedsource.docxstamper.api.typeresolver.ITypeResolver
-
This method is called when a placeholder in the .docx template is to replaced by the result of an expression that was found in the .docx template.
- resolve(EvaluationContext, Object, String, List<TypeDescriptor>) - Method in class org.wickedsource.docxstamper.el.StandardMethodResolver
- resolveExpression(String, Object) - Method in class org.wickedsource.docxstamper.el.ExpressionResolver
-
Runs the given expression against the given context object and returns the result of the evaluated expression.
- resolveExpressions(WordprocessingMLPackage, Object) - Method in class org.wickedsource.docxstamper.replace.PlaceholderReplacer
-
Finds expressions in a document and resolves them against the specified context object.
- resolveExpressionsForParagraph(P, Object, WordprocessingMLPackage) - Method in class org.wickedsource.docxstamper.replace.PlaceholderReplacer
- resolveStringForObject(Object) - Method in class org.wickedsource.docxstamper.replace.typeresolver.FallbackResolver
- resolveStringForObject(LocalDate) - Method in class org.wickedsource.docxstamper.replace.typeresolver.LocalDateResolver
- resolveStringForObject(LocalDateTime) - Method in class org.wickedsource.docxstamper.replace.typeresolver.LocalDateTimeResolver
- resolveStringForObject(LocalTime) - Method in class org.wickedsource.docxstamper.replace.typeresolver.LocalTimeResolver
- resolveStringForObject(Date) - Method in class org.wickedsource.docxstamper.replace.typeresolver.DateResolver
- resolveStringForObject(S) - Method in class org.wickedsource.docxstamper.replace.typeresolver.AbstractToTextResolver
- resolveTable(StampTable) - Method in interface org.wickedsource.docxstamper.processor.table.ITableResolver
-
Resolves the given table by manipulating the given table in the template
- resolveTable(StampTable) - Method in class org.wickedsource.docxstamper.processor.table.TableResolver
- runProcessors(WordprocessingMLPackage, T) - Method in class org.wickedsource.docxstamper.processor.CommentProcessorRegistry
-
Lets each registered ICommentProcessor have a run on the specified docx document.
- RunUtil - Class in org.wickedsource.docxstamper.util
S
- SectionUtil - Class in org.wickedsource.docxstamper.util
- SectionUtil() - Constructor for class org.wickedsource.docxstamper.util.SectionUtil
- setCurrentCommentWrapper(CommentWrapper) - Method in interface org.wickedsource.docxstamper.api.commentprocessor.ICommentProcessor
-
Passes the comment range wrapper that is currently being processed (i.e.
- setCurrentCommentWrapper(CommentWrapper) - Method in class org.wickedsource.docxstamper.processor.BaseCommentProcessor
- setCurrentRun(R) - Method in interface org.wickedsource.docxstamper.api.commentprocessor.ICommentProcessor
-
Passes the run that is currently being processed (i.e.
- setCurrentRun(R) - Method in class org.wickedsource.docxstamper.processor.BaseCommentProcessor
- setDefaultTypeResolver(ITypeResolver) - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration
- setDocument(WordprocessingMLPackage) - Method in interface org.wickedsource.docxstamper.api.commentprocessor.ICommentProcessor
-
Passes the processed document, in order to make all linked data (images, etc) available to processors that need it (example : repeatDocPart)
- setDocument(WordprocessingMLPackage) - Method in class org.wickedsource.docxstamper.processor.BaseCommentProcessor
- setEvaluationContextConfigurer(EvaluationContextConfigurer) - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration
-
Provides an
EvaluationContextConfigurerwhich may change the configuration of a SpringEvaluationContextwhich is used for evaluating expressions in comments and text. - setFailOnUnresolvedExpression(boolean) - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration
-
If set to true, stamper will throw an
UnresolvedExpressionExceptionif a variable expression or processor expression within the document or within the comments is encountered that cannot be resolved. - setLineBreakPlaceholder(String) - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration
-
The String provided as lineBreakPlaceholder will be replaces with a line break when stamping a document.
- setParagraph(P) - Method in interface org.wickedsource.docxstamper.api.commentprocessor.ICommentProcessor
-
Passes the paragraph that is currently being processed (i.e.
- setParagraph(P) - Method in class org.wickedsource.docxstamper.processor.BaseCommentProcessor
- setText(R, String) - Static method in class org.wickedsource.docxstamper.util.RunUtil
-
Sets the text of the given run to the given value.
- stamp(InputStream, Object, OutputStream) - Method in class org.wickedsource.docxstamper.DocxStamper
-
Reads in a .docx template and "stamps" it into the given OutputStream, using the specified context object to fill out any expressions it finds.
- stamp(WordprocessingMLPackage, Object, OutputStream) - Method in class org.wickedsource.docxstamper.DocxStamper
-
Same as stamp(InputStream, T, OutputStream) except that you may pass in a DOCX4J document as a template instead of an InputStream.
- stamp(T, Object, OutputStream) - Method in interface pro.verron.docxstamper.OpcStamper
- stampEmptyContext(PlaceholderReplacer, WordprocessingMLPackage, Tr) - Static method in class org.wickedsource.docxstamper.processor.repeat.RepeatProcessor
- StamperFactory - Class in pro.verron.docxstamper
-
Main class of the docx-stamper library.
- StamperFactory() - Constructor for class pro.verron.docxstamper.StamperFactory
- StampTable - Class in org.wickedsource.docxstamper.processor.table
- StampTable() - Constructor for class org.wickedsource.docxstamper.processor.table.StampTable
- StampTable(List<String>, List<List<String>>) - Constructor for class org.wickedsource.docxstamper.processor.table.StampTable
- StandardMethodExecutor - Class in org.wickedsource.docxstamper.el
- StandardMethodExecutor(StandardMethodExecutor.Invoker, Function<ReflectiveOperationException, TypedValue>) - Constructor for class org.wickedsource.docxstamper.el.StandardMethodExecutor
- StandardMethodResolver - Class in org.wickedsource.docxstamper.el
- StandardMethodResolver(boolean, Map<Class<?>, Object>, Map<Class<?>, Object>) - Constructor for class org.wickedsource.docxstamper.el.StandardMethodResolver
- stripExpression(String) - Static method in class org.wickedsource.docxstamper.el.ExpressionUtil
-
Strips an expression of the leading "${" or "#{" and the trailing "}".
T
- TableCellUtil - Class in org.wickedsource.docxstamper.util
- TableCellUtil() - Constructor for class org.wickedsource.docxstamper.util.TableCellUtil
- tableResolver(PlaceholderReplacer) - Method in class org.wickedsource.docxstamper.processor.CommentProcessorFactory
- TableResolver - Class in org.wickedsource.docxstamper.processor.table
- THREAD_FACTORY - Static variable in class org.wickedsource.docxstamper.processor.repeat.RepeatDocPartProcessor
- toString() - Method in class org.wickedsource.docxstamper.util.IndexedRun
- toString() - Method in class org.wickedsource.docxstamper.util.ParagraphWrapper
- tryBuildingSubtemplate(WordprocessingMLPackage) - Method in class org.wickedsource.docxstamper.util.CommentWrapper
- TypeResolverRegistry - Class in org.wickedsource.docxstamper.api.typeresolver
-
Registry for all implementations of ITypeResolver that are used by DocxStamper.
- TypeResolverRegistry(ITypeResolver<Object>) - Constructor for class org.wickedsource.docxstamper.api.typeresolver.TypeResolverRegistry
U
- UnresolvedExpressionException - Exception in org.wickedsource.docxstamper.api
- UnresolvedExpressionException(String, Throwable) - Constructor for exception org.wickedsource.docxstamper.api.UnresolvedExpressionException
- unresolvedExpressionsDefaultValue(String) - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration
-
Indicates the default value to use for expressions that doesn't resolve.
W
- walk() - Method in class org.wickedsource.docxstamper.util.walk.CoordinatesWalker
- walk() - Method in class org.wickedsource.docxstamper.util.walk.DocumentWalker
- walkObjectsAndImportImages(WordprocessingMLPackage, WordprocessingMLPackage) - Static method in class org.wickedsource.docxstamper.util.DocumentUtil
-
Recursively walk through source to find embedded images and import them in the target document.
- walkObjectsAndImportImages(ContentAccessor, WordprocessingMLPackage, WordprocessingMLPackage) - Static method in class org.wickedsource.docxstamper.util.DocumentUtil
-
Recursively walk through source accessor to find embedded images and import the target document.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form