Index
All Classes and Interfaces|All Packages|Serialized Form
A
- AbstractToTextResolver<S> - Class in org.wickedsource.docxstamper.replace.typeresolver
-
Deprecated, for removal: This API element is subject to removal in a future version.
- AbstractToTextResolver() - Constructor for class org.wickedsource.docxstamper.replace.typeresolver.AbstractToTextResolver
-
Deprecated.Default constructor.
- addCommentProcessor(Class<?>, CommentProcessorBuilder) - 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
-
Checks if a table cell contains a paragraph
- addPreprocessor(PreProcessor) - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration
-
Adds a preprocessor to the configuration.
- addResolver(ObjectResolver) - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration
-
Adds a resolver to the list of resolvers in the `DocxStamperConfiguration` object.
- addTypeResolver(Class<T>, ITypeResolver<T>) - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration
-
Deprecated, for removal: This API element is subject to removal in a future version.
- allElements(WordprocessingMLPackage) - Static method in class org.wickedsource.docxstamper.util.DocumentUtil
-
Retrieve the last element from an object.
- 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
-
Creates a new section break object.
B
- BaseCommentProcessor - Class in org.wickedsource.docxstamper.processor
-
Base class for comment processors.
- BaseCommentProcessor(PlaceholderReplacer) - Constructor for class org.wickedsource.docxstamper.processor.BaseCommentProcessor
-
Constructor for BaseCommentProcessor.
- BaseCoordinatesWalker - Class in org.wickedsource.docxstamper.util.walk
-
A
CoordinatesWalkerthat does nothing in theBaseCoordinatesWalker.onRun(R, P)andBaseCoordinatesWalker.onParagraph(P)methods. - BaseCoordinatesWalker() - Constructor for class org.wickedsource.docxstamper.util.walk.BaseCoordinatesWalker
- BaseDocumentWalker - Class in org.wickedsource.docxstamper.util.walk
-
This class is an abstract implementation of the
DocumentWalkerinterface. - BaseDocumentWalker(ContentAccessor) - Constructor for class org.wickedsource.docxstamper.util.walk.BaseDocumentWalker
-
Creates a new document walker that walks through the given document.
- 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)instead
C
- canResolve(Object) - Method in class org.wickedsource.docxstamper.replace.typeresolver.LegacyFallbackResolver
-
Deprecated.
- canResolve(Object) - Method in record class org.wickedsource.docxstamper.replace.typeresolver.TypeResolver
-
Deprecated.Determines whether the given object can be resolved by the TypeResolver.
- canResolve(Object) - Method in interface pro.verron.docxstamper.api.ObjectResolver
-
Checks if the given object can be resolved.
- canResolve(Object) - Method in class pro.verron.docxstamper.preset.resolver.ImageResolver
- canResolve(Object) - Method in class pro.verron.docxstamper.preset.resolver.Null2DefaultResolver
- canResolve(Object) - Method in class pro.verron.docxstamper.preset.resolver.Null2PlaceholderResolver
- canResolve(Object) - Method in class pro.verron.docxstamper.preset.resolver.StringResolver
-
Determines if the given object can be resolved by the StringResolver.
- canResolve(Object) - Method in class pro.verron.docxstamper.preset.resolver.ToStringResolver
- cleanExpression(String) - Static method in class org.wickedsource.docxstamper.el.ExpressionResolver
-
Cleans the given expression by stripping the prefix and suffix if they match any of the configured matchers.
- CommentProcessingException - Exception Class in org.wickedsource.docxstamper.processor
-
Thrown when an error occurs while processing a comment in the docx template.
- CommentProcessingException(String, P) - Constructor for exception class org.wickedsource.docxstamper.processor.CommentProcessingException
-
Constructor for CommentProcessingException.
- CommentProcessorBuilder - Interface in org.wickedsource.docxstamper
-
Factory interface for creating
ICommentProcessorinstances. - CommentProcessorFactory - Class in org.wickedsource.docxstamper.processor
-
Factory class to create the correct comment processor for a given comment.
- CommentProcessorFactory(DocxStamperConfiguration) - Constructor for class org.wickedsource.docxstamper.processor.CommentProcessorFactory
-
Creates a new 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
-
Creates a new CommentProcessorRegistry.
- CommentUtil - Class in org.wickedsource.docxstamper.util
-
Utility class for working with comments in a DOCX document.
- CommentWrapper - Class in org.wickedsource.docxstamper.util
-
CommentWrapper class.
- 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
-
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.repeat.ParagraphRepeatProcessor
-
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.repeat.RepeatDocPartProcessor
-
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.repeat.RepeatProcessor
-
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.replaceExpression.ReplaceWithProcessor
-
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.table.TableResolver
-
This method is called after all comments in the .docx template have been passed to the comment processor.
- 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.DefaultEvaluationContextConfigurer
-
Configure the context before it's used by docxstamper.
- configureEvaluationContext(StandardEvaluationContext) - Method in class org.wickedsource.docxstamper.el.NoOpEvaluationContextConfigurer
-
Configures the provided StandardEvaluationContext.
- CoordinatesWalker - Class in org.wickedsource.docxstamper.util.walk
-
Walks through a document and calls the methods on each paragraph and run.
- CoordinatesWalker() - 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.
- create(PlaceholderReplacer) - Method in interface org.wickedsource.docxstamper.CommentProcessorBuilder
-
Creates a
ICommentProcessorinstance. - createRunWithImage(Integer, BinaryPartAbstractImage) - Static method in class pro.verron.docxstamper.preset.resolver.ImageResolver
-
Creates a run containing the given image.
- createText(String) - Static method in class org.wickedsource.docxstamper.util.RunUtil
-
Creates a text object with the given text.
D
- DateResolver - Class in pro.verron.docxstamper.preset.resolver
-
This ITypeResolver creates a formatted date String for expressions that return a Date object.
- DateResolver() - Constructor for class pro.verron.docxstamper.preset.resolver.DateResolver
-
Creates a new DateResolver that uses the format "dd.MM.yyyy".
- DateResolver(DateTimeFormatter) - Constructor for class pro.verron.docxstamper.preset.resolver.DateResolver
-
Creates a new DateResolver.
- DefaultEvaluationContextConfigurer - Class in org.wickedsource.docxstamper.el
-
EvaluationContextConfigurerthat has a better default security, especially doesn't allow Especially known injections. - DefaultEvaluationContextConfigurer() - Constructor for class org.wickedsource.docxstamper.el.DefaultEvaluationContextConfigurer
- defaultValue() - Method in class pro.verron.docxstamper.preset.resolver.Null2DefaultResolver
-
Retrieves the default value of the Null2DefaultResolver object.
- deleteComment(CommentWrapper) - Static method in class org.wickedsource.docxstamper.util.CommentUtil
-
Returns the string value of the specified comment object.
- deleteCommentFromElement(List<Object>, BigInteger) - Static method in class org.wickedsource.docxstamper.util.CommentUtil
-
Returns the string value of the specified comment object.
- deleteParagraph(P) - Static method in class org.wickedsource.docxstamper.util.ObjectDeleter
-
Deletes the given paragraph from the document.
- deleteTable(Tbl) - Static method in class org.wickedsource.docxstamper.util.ObjectDeleter
-
Deletes the given table from the document.
- deleteTableRow(Tr) - Static method in class org.wickedsource.docxstamper.util.ObjectDeleter
-
Deletes the given table row from the document.
- displayIf(PlaceholderReplacer) - Method in class org.wickedsource.docxstamper.processor.CommentProcessorFactory
-
Creates a new CommentProcessorFactory with default configuration.
- DisplayIfProcessor - Class in org.wickedsource.docxstamper.processor.displayif
-
Processor for the
IDisplayIfProcessorcomment. - displayParagraphIf(Boolean) - Method in class org.wickedsource.docxstamper.processor.displayif.DisplayIfProcessor
-
May be called to delete the commented paragraph or not, depending on the given boolean condition.
- 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
-
May be called to delete the commented paragraph or not, depending on the presence of the given data.
- 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
-
May be called to delete the table surrounding the commented paragraph, depending on the given boolean condition.
- 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
-
May be called to delete the table surrounding the commented paragraph, depending on the given boolean condition.
- 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
-
Utility class to retrieve elements from a document.
- DocumentWalker - Class in org.wickedsource.docxstamper.util.walk
-
This class walks the document and calls abstract methods for each element it encounters.
- DocumentWalker(ContentAccessor) - Constructor for class org.wickedsource.docxstamper.util.walk.DocumentWalker
-
Creates a new DocumentWalker that will traverse the given document.
- DocxImageExtractor - Class in org.wickedsource.docxstamper.util
-
Extracts images from a docx document.
- DocxImageExtractor(WordprocessingMLPackage) - Constructor for class org.wickedsource.docxstamper.util.DocxImageExtractor
-
Creates a new image extractor for the given docx document.
- DocxStamper<T> - Class in org.wickedsource.docxstamper
-
The DocxStamper class is an implementation of the OpcStamper interface that is used to stamp DOCX templates with a context object and write the result to an output stream.
- 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
-
The
DocxStamperConfigurationclass represents the configuration for theDocxStamperclass. - DocxStamperConfiguration() - Constructor for class org.wickedsource.docxstamper.DocxStamperConfiguration
-
Creates a new configuration with default values.
- DocxStamperException - Exception Class in org.wickedsource.docxstamper.api
-
This class represents an exception that can be thrown during the processing of a Docx file using the DocxStamper library.
- DocxStamperException(String) - Constructor for exception class org.wickedsource.docxstamper.api.DocxStamperException
-
Constructor for DocxStamperException.
- DocxStamperException(String, Throwable) - Constructor for exception class org.wickedsource.docxstamper.api.DocxStamperException
-
Constructor for DocxStamperException.
- DocxStamperException(Throwable) - Constructor for exception class org.wickedsource.docxstamper.api.DocxStamperException
-
Constructor for DocxStamperException.
E
- empty() - Static method in class org.wickedsource.docxstamper.processor.table.StampTable
-
empty.
- endIndex() - Method in record class org.wickedsource.docxstamper.util.IndexedRun
-
Returns the value of the
endIndexrecord component. - equals(Object) - Method in record class org.wickedsource.docxstamper.el.Matcher
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class org.wickedsource.docxstamper.replace.typeresolver.TypeResolver
-
Deprecated.Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class org.wickedsource.docxstamper.util.IndexedRun
-
Indicates whether some other object is "equal to" this one.
- EvaluationContextConfigurer - Interface in org.wickedsource.docxstamper.api
-
Allows for custom configuration of a spring expression language
EvaluationContext. - exception() - Method in class pro.verron.docxstamper.utils.ProcessorExceptionHandler
-
Returns the captured exception if present.
- 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
-
Resolves expressions against a given context object.
- ExpressionResolver(StandardEvaluationContext, SpelParserConfiguration) - Constructor for class org.wickedsource.docxstamper.el.ExpressionResolver
-
Creates a new ExpressionResolver with the given SpEL parser configuration.
- ExpressionUtil - Class in org.wickedsource.docxstamper.el
-
Utility class for working with expressions in a text.
F
- fallback() - Static method in class pro.verron.docxstamper.preset.resolver.Resolvers
-
Returns an instance of ObjectResolver that acts as a fallback resolver.
- findComment(WordprocessingMLPackage, BigInteger) - Static method in class org.wickedsource.docxstamper.util.CommentUtil
-
Finds a comment with the given ID in the specified WordprocessingMLPackage document.
- 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
- getChildren() - Method in class org.wickedsource.docxstamper.util.CommentWrapper
-
Getter for the field
children. - getComment() - Method in class org.wickedsource.docxstamper.util.CommentWrapper
-
Getter for the field
comment. - getCommentAround(R, WordprocessingMLPackage) - Static method in class org.wickedsource.docxstamper.util.CommentUtil
-
Returns the comment the given DOCX4J object 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
-
Getter for the field
commentProcessors. - getCommentRangeEnd() - Method in class org.wickedsource.docxstamper.util.CommentWrapper
-
Getter for the field
commentRangeEnd. - getCommentRangeStart() - Method in class org.wickedsource.docxstamper.util.CommentWrapper
-
Getter for the field
commentRangeStart. - getCommentReference() - Method in class org.wickedsource.docxstamper.util.CommentWrapper
-
Getter for the field
commentReference. - getComments(WordprocessingMLPackage) - Static method in class org.wickedsource.docxstamper.util.CommentUtil
-
Extracts all comments from the given document.
- 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
-
Returns the comment the given DOCX4J object is commented with.
- getCurrentCommentWrapper() - Method in class org.wickedsource.docxstamper.processor.BaseCommentProcessor
-
Getter for the field
currentCommentWrapper. - getCurrentRun() - Method in class org.wickedsource.docxstamper.processor.BaseCommentProcessor
-
Getter for the field
currentRun. - getDefaultTypeResolver() - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration
-
Deprecated, for removal: This API element is subject to removal in a future version.This method is deprecated since version 1.6.7 and is scheduled for removal. You should not have to use it, it was a clutch for previosu version of docx-stamper.
- getDocument() - Method in class org.wickedsource.docxstamper.processor.BaseCommentProcessor
-
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
- getEvaluationContextConfigurer() - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration
-
Getter for the field
evaluationContextConfigurer. - getExpressionFunctions() - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration
-
Getter for the field
expressionFunctions. - getImageBytes() - Method in class org.wickedsource.docxstamper.replace.typeresolver.image.Image
-
Getter for the field
imageBytes. - getLineBreakPlaceholder() - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration
-
Getter for the field
lineBreakPlaceholder. - getMaxWidth() - Method in class org.wickedsource.docxstamper.replace.typeresolver.image.Image
-
Getter for the field
maxWidth. - getNullValuesDefault() - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration
-
Deprecated, for removal: This API element is subject to removal in a future version.This method has been deprecated since version 1.6.7 and is scheduled for removal. You shouldn't have to use it, it was a clutch for docx-stamper workings.
- getParagraph() - Method in class org.wickedsource.docxstamper.processor.BaseCommentProcessor
-
Getter for the field
paragraph. - getParagraph() - Method in class org.wickedsource.docxstamper.util.ParagraphWrapper
-
Getter for the field
paragraph. - getParagraphSectionBreak(P) - Static method in class org.wickedsource.docxstamper.util.SectionUtil
-
Creates a new section break object.
- getParagraphsFromObject(Object) - Static method in class org.wickedsource.docxstamper.util.DocumentUtil
-
Retrieve all the paragraphs from a document
- getParagraphsInsideComment(P) - Static method in class org.wickedsource.docxstamper.processor.repeat.ParagraphRepeatProcessor
-
Returns all paragraphs inside the comment of the given paragraph.
- getParent() - Method in class org.wickedsource.docxstamper.util.CommentWrapper
-
getParent.
- getPreprocessors() - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration
-
Getter for the field
preprocessors. - getPreviousSectionBreakIfPresent(Object, ContentAccessor) - Static method in class org.wickedsource.docxstamper.util.SectionUtil
-
Creates a new section break object.
- getRepeatElements() - Method in class org.wickedsource.docxstamper.util.CommentWrapper
-
getRepeatElements.
- getResolvers() - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration
-
Retrieves the list of resolvers.
- getRunDrawingAltText(R) - Method in class org.wickedsource.docxstamper.util.DocxImageExtractor
-
Extract the content type of the image from an embedded image run.
- getRunDrawingFilename(R) - Method in class org.wickedsource.docxstamper.util.DocxImageExtractor
-
Extract the name of the image from an embedded image run.
- getRunDrawingMaxWidth(R) - Method in class org.wickedsource.docxstamper.util.DocxImageExtractor
-
Extract the width of the image from an embedded image run.
- getRuns() - Method in class org.wickedsource.docxstamper.util.ParagraphWrapper
-
Returns the list of runs that are aggregated.
- getSpelParserConfiguration() - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration
-
Getter for the field
spelParserConfiguration. - getSubTemplate(WordprocessingMLPackage) - Method in class org.wickedsource.docxstamper.util.CommentWrapper
-
Creates a new document containing only the elements between the comment range anchors.
- getTableCellsFromObject(Object) - Static method in class org.wickedsource.docxstamper.util.DocumentUtil
-
Retrieve all the cells from an object.
- getTableFromObject(Object) - Static method in class org.wickedsource.docxstamper.util.DocumentUtil
-
Retrieve all the tables from an object.
- getTableRowsFromObject(Object) - Static method in class org.wickedsource.docxstamper.util.DocumentUtil
-
Retrieve all the rows from an object.
- 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.
- getTypeResolvers() - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration
-
Deprecated, for removal: This API element is subject to removal in a future version.This method is deprecated since version 1.6.7
- getUnresolvedExpressionsDefaultValue() - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration
-
Getter for the field
unresolvedExpressionsDefaultValue.
H
- hashCode() - Method in record class org.wickedsource.docxstamper.el.Matcher
-
Returns a hash code value for this object.
- hashCode() - Method in record class org.wickedsource.docxstamper.replace.typeresolver.TypeResolver
-
Deprecated.Returns a hash code value for this object.
- hashCode() - Method in record class org.wickedsource.docxstamper.util.IndexedRun
-
Returns a hash code value for this object.
- hasNoParagraphOrTable(Tc) - Static method in class org.wickedsource.docxstamper.util.TableCellUtil
-
Checks if a table cell contains a paragraph or a table
- headers() - Method in class org.wickedsource.docxstamper.processor.table.StampTable
-
headers.
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
-
Interface for processors that may be used to delete commented paragraphs or tables from the document, depending on a given condition.
- image() - Static method in class pro.verron.docxstamper.preset.resolver.Resolvers
-
Returns an instance of ImageResolver that allows context objects to return objects of type Image.
- 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
-
Constructor for Image.
- Image(byte[], Integer) - Constructor for class org.wickedsource.docxstamper.replace.typeresolver.image.Image
-
Constructor for Image.
- Image(InputStream) - Constructor for class org.wickedsource.docxstamper.replace.typeresolver.image.Image
-
Constructor for Image.
- Image(InputStream, Integer) - Constructor for class org.wickedsource.docxstamper.replace.typeresolver.image.Image
-
Constructor for Image.
- ImageResolver - Class in pro.verron.docxstamper.preset.resolver
-
This ITypeResolver allows context objects to return objects of type Image.
- ImageResolver() - Constructor for class pro.verron.docxstamper.preset.resolver.ImageResolver
- IndexedRun - Record Class in org.wickedsource.docxstamper.util
-
Represents a run (i.e.
- IndexedRun(int, int, int, R) - Constructor for record class org.wickedsource.docxstamper.util.IndexedRun
-
Creates an instance of a
IndexedRunrecord class. - indexInParent() - Method in record class org.wickedsource.docxstamper.util.IndexedRun
-
Returns the value of the
indexInParentrecord component. - invoke(Object...) - Method in interface org.wickedsource.docxstamper.el.StandardMethodExecutor.Invoker
-
Should call the expected method with the given arguments
- IParagraphRepeatProcessor - Interface in org.wickedsource.docxstamper.processor.repeat
-
Implementations of this interface are responsible for processing the repeat paragraph instruction.
- IRepeatDocPartProcessor - Interface in org.wickedsource.docxstamper.processor.repeat
-
Interface for processors which may be called to mark a document part to be copied once for each element in the passed-in list.
- IRepeatProcessor - Interface in org.wickedsource.docxstamper.processor.repeat
-
Interface for processors that can repeat a table row.
- IReplaceWithProcessor - Interface in org.wickedsource.docxstamper.processor.replaceExpression
-
Interface for processors that replace a single word with an expression defined in a comment.
- isFailOnUnresolvedExpression() - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration
-
isFailOnUnresolvedExpression.
- isLeaveEmptyOnExpressionError() - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration
-
isLeaveEmptyOnExpressionError.
- isoDate() - Static method in class pro.verron.docxstamper.preset.resolver.Resolvers
-
Returns an instance of
LocalDateResolver. - isoDate(DateTimeFormatter) - Static method in class pro.verron.docxstamper.preset.resolver.Resolvers
-
Returns an instance of LocalDateResolver that resolves
LocalDateobjects by formatting them with the givenDateTimeFormatter. - isoDateTime() - Static method in class pro.verron.docxstamper.preset.resolver.Resolvers
-
Returns an instance of LocalTimeResolver.
- isOddNumberOfSectionBreaks(List<Object>) - Static method in class org.wickedsource.docxstamper.util.SectionUtil
-
Creates a new section break object.
- isoTime() - Static method in class pro.verron.docxstamper.preset.resolver.Resolvers
-
Returns an instance of
LocalDateTimeResolver. - isoTime(DateTimeFormatter) - Static method in class pro.verron.docxstamper.preset.resolver.Resolvers
-
Creates a new instance of LocalDateTimeResolver using the given formatter.
- isReplaceNullValues() - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration
-
Deprecated, for removal: This API element is subject to removal in a future version.This method is deprecated since version 1.6.7 and will be removed in a future release. You shouldn't have to use it, it was a clutch for docx-stamper workings.
- isReplaceUnresolvedExpressions() - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration
-
isReplaceUnresolvedExpressions.
- isTouchedByRange(int, int) - Method in record 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
-
Deprecated, for removal: This API element is subject to removal in a future version.as of version 1.6.7, replaced by
ObjectResolver. The new resolver is more versatile, requires less reflection mechanism, and simplifies the internal workings of the docx-stamper project.
L
- lastElement(WordprocessingMLPackage) - Static method in class org.wickedsource.docxstamper.util.DocumentUtil
-
Retrieve the first element from an object.
- 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.
- legacyDate() - Static method in class pro.verron.docxstamper.preset.resolver.Resolvers
-
Returns an instance of DateResolver.
- legacyDate(DateTimeFormatter) - Static method in class pro.verron.docxstamper.preset.resolver.Resolvers
-
This method returns an instance of DateResolver that creates a formatted date string for expressions that return a Date object.
- LegacyFallbackResolver - Class in org.wickedsource.docxstamper.replace.typeresolver
-
Deprecated, for removal: This API element is subject to removal in a future version.as of version 1.6.7, use
Resolvers.fallback()instead. LegacyFallbackResolver was capable of mapping any object to their String representation. Now, this is more streamlined and manageable usingResolvers.fallback(). - LegacyFallbackResolver() - Constructor for class org.wickedsource.docxstamper.replace.typeresolver.LegacyFallbackResolver
-
Deprecated.
- LocalDateResolver - Class in pro.verron.docxstamper.preset.resolver
-
Resolves
LocalDateobjects by formatting them with aDateTimeFormatter. - LocalDateResolver() - Constructor for class pro.verron.docxstamper.preset.resolver.LocalDateResolver
-
Uses
DateTimeFormatter.ISO_LOCAL_DATEfor formatting. - LocalDateResolver(DateTimeFormatter) - Constructor for class pro.verron.docxstamper.preset.resolver.LocalDateResolver
-
Uses the given formatter for formatting.
- LocalDateTimeResolver - Class in pro.verron.docxstamper.preset.resolver
-
Resolves
LocalDateTimevalues to a formatted string. - LocalDateTimeResolver() - Constructor for class pro.verron.docxstamper.preset.resolver.LocalDateTimeResolver
-
Creates a new resolver that uses
DateTimeFormatter.ISO_LOCAL_DATE_TIMEto formatLocalDateTimevalues. - LocalDateTimeResolver(DateTimeFormatter) - Constructor for class pro.verron.docxstamper.preset.resolver.LocalDateTimeResolver
-
Creates a new resolver that uses the given formatter to format
LocalDateTimevalues. - LocalTimeResolver - Class in pro.verron.docxstamper.preset.resolver
-
Resolves
LocalTimevalues to the format specified by theDateTimeFormatterpassed to the constructor. - LocalTimeResolver() - Constructor for class pro.verron.docxstamper.preset.resolver.LocalTimeResolver
-
Uses
DateTimeFormatter.ISO_LOCAL_TIMEfor formatting. - LocalTimeResolver(DateTimeFormatter) - Constructor for class pro.verron.docxstamper.preset.resolver.LocalTimeResolver
-
Constructor for LocalTimeResolver.
M
- Matcher - Record Class in org.wickedsource.docxstamper.el
-
Represents a Matcher that checks if an expression starts with a specified prefix and ends with a specified suffix.
- Matcher(String, String) - Constructor for record class org.wickedsource.docxstamper.el.Matcher
-
Creates an instance of a
Matcherrecord class. - 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
-
Creates a new DisplayIfProcessor instance.
- newInstance(PlaceholderReplacer) - Static method in class org.wickedsource.docxstamper.processor.repeat.ParagraphRepeatProcessor
-
newInstance.
- newInstance(PlaceholderReplacer) - Static method in class org.wickedsource.docxstamper.processor.repeat.RepeatProcessor
-
Creates a new RepeatProcessor.
- newInstance(PlaceholderReplacer) - Static method in class org.wickedsource.docxstamper.processor.replaceExpression.ReplaceWithProcessor
-
Creates a new processor that replaces the current run with the result of the expression.
- newInstance(PlaceholderReplacer) - Static method in class org.wickedsource.docxstamper.processor.table.TableResolver
-
Generate a new
TableResolverinstance where value is replaced by an empty list whennull - newInstance(PlaceholderReplacer, String) - Static method in class org.wickedsource.docxstamper.processor.repeat.ParagraphRepeatProcessor
-
newInstance.
- newInstance(PlaceholderReplacer, String) - Static method in class org.wickedsource.docxstamper.processor.replaceExpression.ReplaceWithProcessor
-
Creates a new processor that replaces the current run with the result of the expression.
- newInstance(PlaceholderReplacer, String) - Static method in class org.wickedsource.docxstamper.processor.table.TableResolver
-
Generate a new
TableResolverinstance - newInstance(PlaceholderReplacer, OpcStamper<WordprocessingMLPackage>) - Static method in class org.wickedsource.docxstamper.processor.repeat.RepeatDocPartProcessor
-
newInstance.
- newInstance(PlaceholderReplacer, OpcStamper<WordprocessingMLPackage>, String) - Static method in class org.wickedsource.docxstamper.processor.repeat.RepeatDocPartProcessor
-
newInstance.
- newInstanceWithNullReplacement(PlaceholderReplacer) - Static method in class org.wickedsource.docxstamper.processor.repeat.RepeatProcessor
-
Creates a new 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.
- Null2DefaultResolver - Class in pro.verron.docxstamper.preset.resolver
-
The Null2DefaultResolver class is an implementation of the ObjectResolver interface that resolves null objects by creating a run with a default text value.
- Null2PlaceholderResolver - Class in pro.verron.docxstamper.preset.resolver
-
The Null2PlaceholderResolver class is an implementation of the ObjectResolver interface.
- nullProof() - Method in record class org.wickedsource.docxstamper.replace.typeresolver.TypeResolver
-
Deprecated.Returns the value of the
nullProofrecord component. - nullReplacementValue() - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration
-
Deprecated.This method is deprecated since version 1.6.7. You shouldn't have to use it, it was a crutch use for inner workinf of docx-stamper
- nullToDefault(String) - Static method in class pro.verron.docxstamper.preset.resolver.Resolvers
-
Returns an instance of ObjectResolver that resolves null objects by creating a run with a default text value.
- nullToEmpty() - Static method in class pro.verron.docxstamper.preset.resolver.Resolvers
-
Returns an instance of ObjectResolver that replaces null values with an empty string.
- nullToPlaceholder() - Static method in class pro.verron.docxstamper.preset.resolver.Resolvers
-
Returns an instance of ObjectResolver that resolves null objects by not replacing their placeholder string.
- nullValuesDefault(String) - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration
-
Deprecated, for removal: This API element is subject to removal in a future version.This method has been deprecated since version 1.6.7. It is recommended to use
DocxStamperConfiguration.addResolver(ObjectResolver)andResolvers.nullToDefault(String)instead.
O
- ObjectDeleter - Class in org.wickedsource.docxstamper.util
-
Utility class for deleting objects from a
Document. - ObjectResolver - Interface in pro.verron.docxstamper.api
-
The ObjectResolver interface provides a contract for resolving objects to create a run with the resolved content.
- ObjectResolverRegistry - Class in org.wickedsource.docxstamper.replace.typeresolver
-
A registry for object resolvers.
- ObjectResolverRegistry(List<ObjectResolver>) - Constructor for class org.wickedsource.docxstamper.replace.typeresolver.ObjectResolverRegistry
-
A registry for object resolvers.
- onCommentRangeEnd(CommentRangeEnd) - Method in class org.wickedsource.docxstamper.util.walk.BaseDocumentWalker
-
This method is called for every
CommentRangeEndelement in the document. - onCommentRangeEnd(CommentRangeEnd) - Method in class org.wickedsource.docxstamper.util.walk.DocumentWalker
-
This method is called for every
CommentRangeEndelement in the document. - onCommentRangeStart(CommentRangeStart) - Method in class org.wickedsource.docxstamper.util.walk.BaseDocumentWalker
-
This method is called for every
CommentRangeStartelement in the document. - onCommentRangeStart(CommentRangeStart) - Method in class org.wickedsource.docxstamper.util.walk.DocumentWalker
-
This method is called for every
CommentRangeStartelement in the document. - onCommentReference(R.CommentReference) - Method in class org.wickedsource.docxstamper.util.walk.BaseDocumentWalker
-
This method is called for every
R.CommentReferenceelement in the document. - onCommentReference(R.CommentReference) - Method in class org.wickedsource.docxstamper.util.walk.DocumentWalker
-
This method is called for every
R.CommentReferenceelement in the document. - onException(ThrowingRunnable) - Method in class pro.verron.docxstamper.utils.ProcessorExceptionHandler
-
Adds a routine to the list of routines that should be run when an exception occurs.
- onParagraph(P) - Method in class org.wickedsource.docxstamper.processor.repeat.ParagraphResolverDocumentWalker
-
This method is called for every
Pelement in the document. - onParagraph(P) - Method in class org.wickedsource.docxstamper.util.walk.BaseCoordinatesWalker
-
called after each paragraph
- onParagraph(P) - Method in class org.wickedsource.docxstamper.util.walk.BaseDocumentWalker
-
This method is called for every
Pelement in the document. - onParagraph(P) - Method in class org.wickedsource.docxstamper.util.walk.CoordinatesWalker
-
called after each paragraph
- onParagraph(P) - Method in class org.wickedsource.docxstamper.util.walk.DocumentWalker
-
This method is called for every
Pelement in the document. - onRun(R) - Method in class org.wickedsource.docxstamper.util.walk.BaseDocumentWalker
-
This method is called for every
Relement in the document. - onRun(R) - Method in class org.wickedsource.docxstamper.util.walk.DocumentWalker
-
This method is called for every
Relement in the document. - onRun(R, P) - Method in class org.wickedsource.docxstamper.util.walk.BaseCoordinatesWalker
-
called for each run
- onRun(R, P) - Method in class org.wickedsource.docxstamper.util.walk.CoordinatesWalker
-
called for each run
- onTable(Tbl) - Method in class org.wickedsource.docxstamper.util.walk.BaseDocumentWalker
-
This method is called for every
Tblelement in the document. - onTable(Tbl) - Method in class org.wickedsource.docxstamper.util.walk.DocumentWalker
-
This method is called for every
Tblelement in the document. - onTableCell(Tc) - Method in class org.wickedsource.docxstamper.util.walk.BaseDocumentWalker
-
This method is called for every
Tcelement in the document. - onTableCell(Tc) - Method in class org.wickedsource.docxstamper.util.walk.DocumentWalker
-
This method is called for every
Tcelement in the document. - onTableRow(Tr) - Method in class org.wickedsource.docxstamper.util.walk.BaseDocumentWalker
-
This method is called for every
Trelement in the document. - onTableRow(Tr) - Method in class org.wickedsource.docxstamper.util.walk.DocumentWalker
-
This method is called for every
Trelement in the document. - OpcStamper<T> - Interface in pro.verron.docxstamper
-
OpcStamper is an interface that defines the contract for stamping templates with context and writing the result to an OutputStream.
- 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
-
This class is used to repeat paragraphs and tables.
- ParagraphResolverDocumentWalker - Class in org.wickedsource.docxstamper.processor.repeat
-
Walks through a document and replaces placeholders with values from the given expression context.
- ParagraphResolverDocumentWalker(Tr, Object, WordprocessingMLPackage, PlaceholderReplacer) - Constructor for class org.wickedsource.docxstamper.processor.repeat.ParagraphResolverDocumentWalker
-
Constructor for ParagraphResolverDocumentWalker.
- ParagraphUtil - Class in org.wickedsource.docxstamper.util
-
Utility class for creating paragraphs.
- 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
-
Constructs a new ParagraphWrapper for the given paragraph.
- placeholderReplacer - Variable in class org.wickedsource.docxstamper.processor.BaseCommentProcessor
-
PlaceholderReplacer used to replace placeholders in the comment text.
- PlaceholderReplacer - Class in org.wickedsource.docxstamper.replace
-
Replaces expressions in a document with the values provided by the
ExpressionResolver. - PlaceholderReplacer(ObjectResolverRegistry, ExpressionResolver, boolean, boolean, String, boolean, String) - Constructor for class org.wickedsource.docxstamper.replace.PlaceholderReplacer
-
Constructor for PlaceholderReplacer.
- prefix() - Method in record class org.wickedsource.docxstamper.el.Matcher
-
Returns the value of the
prefixrecord component. - PreProcessor - Interface in org.wickedsource.docxstamper.api.preprocessor
-
The interface for all pre-processors.
- pro.verron.docxstamper - package pro.verron.docxstamper
- pro.verron.docxstamper.api - package pro.verron.docxstamper.api
- pro.verron.docxstamper.preset.resolver - package pro.verron.docxstamper.preset.resolver
- pro.verron.docxstamper.utils - package pro.verron.docxstamper.utils
- process(WordprocessingMLPackage) - Method in interface org.wickedsource.docxstamper.api.preprocessor.PreProcessor
-
Processes the given document before the actual processing takes place.
- process(WordprocessingMLPackage) - Method in class org.wickedsource.docxstamper.preprocessor.MergeSameStyleRuns
-
Processes the given document before the actual processing takes place.
- process(WordprocessingMLPackage) - Method in class org.wickedsource.docxstamper.preprocessor.RemoveProofErrors
-
Processes the given document before the actual processing takes place.
- ProcessorExceptionHandler - Class in pro.verron.docxstamper.utils
-
The ProcessorExceptionHandler class is responsible for capturing and handling uncaught exceptions that occur in a thread.
- ProcessorExceptionHandler() - Constructor for class pro.verron.docxstamper.utils.ProcessorExceptionHandler
-
Constructs a new ProcessorExceptionHandler for managing thread's uncaught exceptions.
R
- recalculateRuns() - Method in class org.wickedsource.docxstamper.util.ParagraphWrapper
-
Recalculates the runs of the paragraph.
- records() - Method in class org.wickedsource.docxstamper.processor.table.StampTable
-
records.
- 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
-
Creates a new CommentProcessorFactory with default configuration.
- 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
-
May be called to mark a document part to be copied once for each element in the passed-in list.
- repeatDocPart(PlaceholderReplacer) - Method in class org.wickedsource.docxstamper.processor.CommentProcessorFactory
-
Creates a new CommentProcessorFactory with default configuration.
- RepeatDocPartProcessor - Class in org.wickedsource.docxstamper.processor.repeat
-
This class is responsible for processing the <ds:repeat> tag.
- 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
-
May be called to mark a paragraph to be copied once for each element in the passed-in list.
- repeatParagraph(PlaceholderReplacer) - Method in class org.wickedsource.docxstamper.processor.CommentProcessorFactory
-
Creates a new CommentProcessorFactory with default configuration.
- RepeatProcessor - Class in org.wickedsource.docxstamper.processor.repeat
-
Repeats a table row for each element in a list.
- 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
-
May be called to mark a table row to be copied once for each element in the passed-in list.
- replace(int, int, String) - Method in record 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
-
Replaces expressions in the given paragraph and replaces them with the values provided by the expression resolver.
- replaceNullValues(boolean) - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration
-
Deprecated, for removal: This API element is subject to removal in a future version.This method has been deprecated since version 1.6.7. It is recommended to use
DocxStamperConfiguration.addResolver(ObjectResolver)andResolvers.nullToDefault(String)instead. - 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
-
Creates a new CommentProcessorFactory with default configuration.
- ReplaceWithProcessor - Class in org.wickedsource.docxstamper.processor.replaceExpression
-
Processor that replaces the current run with the provided expression.
- 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
-
May be called to replace a single word inside a paragraph with an expression defined in a comment.
- 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
-
Resets all registered ICommentProcessors.
- reset() - Method in class org.wickedsource.docxstamper.processor.displayif.DisplayIfProcessor
-
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.repeat.ParagraphRepeatProcessor
-
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.repeat.RepeatDocPartProcessor
-
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.repeat.RepeatProcessor
-
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.replaceExpression.ReplaceWithProcessor
-
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.table.TableResolver
-
Resets all state in the comment processor so that it can be re-used in another stamping process.
- resolve(LocalDate) - Method in class pro.verron.docxstamper.preset.resolver.LocalDateResolver
-
Resolves an object to a string.
- resolve(LocalDateTime) - Method in class pro.verron.docxstamper.preset.resolver.LocalDateTimeResolver
-
Resolves an object to a string.
- resolve(LocalTime) - Method in class pro.verron.docxstamper.preset.resolver.LocalTimeResolver
-
Resolves an object to a string.
- resolve(Date) - Method in class pro.verron.docxstamper.preset.resolver.DateResolver
-
Resolves a formatted date string for the given Date object.
- resolve(WordprocessingMLPackage, String, Object) - Method in class org.wickedsource.docxstamper.replace.typeresolver.LegacyFallbackResolver
-
Deprecated.
- resolve(WordprocessingMLPackage, String, Object) - Method in class org.wickedsource.docxstamper.replace.typeresolver.ObjectResolverRegistry
-
Resolves the placeholder in the given document with the provided object.
- resolve(WordprocessingMLPackage, String, Object) - Method in record class org.wickedsource.docxstamper.replace.typeresolver.TypeResolver
-
Deprecated.Resolves an object of a specified type to an object of the DOCX4J API that can be placed in a .docx document.
- resolve(WordprocessingMLPackage, String, Object) - Method in interface pro.verron.docxstamper.api.ObjectResolver
-
Resolves the placeholder in the given document with the provided object.
- resolve(WordprocessingMLPackage, String, Object) - Method in class pro.verron.docxstamper.preset.resolver.ImageResolver
- resolve(WordprocessingMLPackage, String, Object) - Method in class pro.verron.docxstamper.preset.resolver.Null2DefaultResolver
- resolve(WordprocessingMLPackage, String, Object) - Method in class pro.verron.docxstamper.preset.resolver.Null2PlaceholderResolver
- resolve(WordprocessingMLPackage, String, Object) - Method in class pro.verron.docxstamper.preset.resolver.StringResolver
-
Resolves an object to a string and creates a new run with the resolved string as content.
- resolve(WordprocessingMLPackage, String, Object) - Method in class pro.verron.docxstamper.preset.resolver.ToStringResolver
- resolve(WordprocessingMLPackage, Image) - Method in class pro.verron.docxstamper.preset.resolver.ImageResolver
-
Resolves an image and adds it to a WordprocessingMLPackage document.
- resolve(WordprocessingMLPackage, S) - Method in class org.wickedsource.docxstamper.replace.typeresolver.AbstractToTextResolver
-
Deprecated.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(WordprocessingMLPackage, T) - Method in interface org.wickedsource.docxstamper.api.typeresolver.ITypeResolver
-
Deprecated.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
- resolve(T) - Method in class pro.verron.docxstamper.preset.resolver.StringResolver
-
Resolves an object to a string.
- resolveExpression(String, Object) - Method in class org.wickedsource.docxstamper.el.ExpressionResolver
-
Resolves the given expression against the given context object.
- 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
-
Finds expressions in the given paragraph and replaces them with the values provided by the expression resolver.
- resolver() - Method in record class org.wickedsource.docxstamper.replace.typeresolver.TypeResolver
-
Deprecated.Returns the value of the
resolverrecord component. - Resolvers - Class in pro.verron.docxstamper.preset.resolver
-
The Resolvers class provides static methods to create different types of ObjectResolvers.
- Resolvers() - Constructor for class pro.verron.docxstamper.preset.resolver.Resolvers
- resolveStringForObject(S) - Method in class org.wickedsource.docxstamper.replace.typeresolver.AbstractToTextResolver
-
Deprecated.Resolves the String for the given object.
- 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
-
Resolves the given table by manipulating the given table in the template
- run() - Method in record class org.wickedsource.docxstamper.util.IndexedRun
-
Returns the value of the
runrecord component. - run() - Method in interface pro.verron.docxstamper.utils.ThrowingRunnable
-
Executes the runnable task, handling any exception by throwing it wrapped inside a
DocxStamperException. - 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
-
Utility class to handle runs.
S
- SectionUtil - Class in org.wickedsource.docxstamper.util
-
Utility class to handle section breaks in paragraphs.
- 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
-
Passes the comment range wrapper that is currently being processed (i.e.
- 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
-
Passes the run that is currently being processed (i.e.
- setDefaultTypeResolver(ITypeResolver<? super Object>) - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration
-
Deprecated, for removal: This API element is subject to removal in a future version.This method is deprecated and scheduled for removal in version 1.6.7. Please set your "default" resolver through
DocxStamperConfiguration.addResolver(ObjectResolver)by putting your default first in the list, or by usingDocxStamperConfiguration.setResolvers(List)} and putting your fallback resolvers in the last place. - setDocument(WordprocessingMLPackage) - Method in interface org.wickedsource.docxstamper.api.commentprocessor.ICommentProcessor
-
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
- setDocument(WordprocessingMLPackage) - Method in class org.wickedsource.docxstamper.processor.BaseCommentProcessor
-
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
- 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
DocxStamperExceptionif 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 replaced 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
-
Passes the paragraph that is currently being processed (i.e.
- setResolvers(List<ObjectResolver>) - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration
-
Sets the resolvers for resolving objects in the DocxStamperConfiguration.
- setSpelParserConfiguration(SpelParserConfiguration) - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration
-
Sets the
SpelParserConfigurationto use for expression parsing. - 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
- stamp(WordprocessingMLPackage, Object, OutputStream) - Method in class org.wickedsource.docxstamper.DocxStamper
-
Stamps the template with the context and writes the result to the outputStream.
- stamp(T, Object, OutputStream) - Method in interface pro.verron.docxstamper.OpcStamper
-
Stamps the template with the context and writes the result to the outputStream.
- stampEmptyContext(PlaceholderReplacer, WordprocessingMLPackage, Tr) - Static method in class org.wickedsource.docxstamper.processor.repeat.RepeatProcessor
-
Creates a new 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
-
Represents a table with several columns, a headers line, and several lines of content
- StampTable() - Constructor for class org.wickedsource.docxstamper.processor.table.StampTable
-
Instantiate an empty table
- StampTable(List<String>, List<List<String>>) - Constructor for class org.wickedsource.docxstamper.processor.table.StampTable
-
Instantiate a table with headers and several lines
- StandardMethodExecutor - Class in org.wickedsource.docxstamper.el
-
This class is a wrapper around a method call which can be executed by the Spring Expression Language.
- StandardMethodExecutor(StandardMethodExecutor.Invoker, Function<ReflectiveOperationException, TypedValue>) - Constructor for class org.wickedsource.docxstamper.el.StandardMethodExecutor
-
Constructor for StandardMethodExecutor.
- StandardMethodExecutor.Invoker - Interface in org.wickedsource.docxstamper.el
-
The invoker is used to call the method in question.
- StandardMethodResolver - Class in org.wickedsource.docxstamper.el
-
Resolves methods that are used as expression functions or comment processors.
- StandardMethodResolver(Map<Class<?>, Object>, Map<Class<?>, Object>, Function<ReflectiveOperationException, TypedValue>) - Constructor for class org.wickedsource.docxstamper.el.StandardMethodResolver
-
Constructor for StandardMethodResolver.
- startIndex() - Method in record class org.wickedsource.docxstamper.util.IndexedRun
-
Returns the value of the
startIndexrecord component. - streamElements(Object, Class<T>) - Static method in class org.wickedsource.docxstamper.util.DocumentUtil
-
Retrieve all the elements of a given class from an object.
- streamParagraphs(WordprocessingMLPackage) - Static method in class org.wickedsource.docxstamper.util.DocumentUtil
-
Retrieve all the runs from a document.
- StringResolver<T> - Class in pro.verron.docxstamper.preset.resolver
-
A StringResolver is an abstract class that provides a generic implementation for resolving objects to strings.
- StringResolver(Class<T>) - Constructor for class pro.verron.docxstamper.preset.resolver.StringResolver
-
Creates a new StringResolver with the given type.
- strip(String) - Method in record class org.wickedsource.docxstamper.el.Matcher
-
Strips the prefix and suffix from the given expression.
- suffix() - Method in record class org.wickedsource.docxstamper.el.Matcher
-
Returns the value of the
suffixrecord component.
T
- TableCellUtil - Class in org.wickedsource.docxstamper.util
-
Utility class for table cells
- tableResolver(PlaceholderReplacer) - Method in class org.wickedsource.docxstamper.processor.CommentProcessorFactory
-
Creates a new CommentProcessorFactory with default configuration.
- TableResolver - Class in org.wickedsource.docxstamper.processor.table
-
TableResolver class.
- throwingRun() - Method in interface pro.verron.docxstamper.utils.ThrowingRunnable
-
Executes the runnable task
- ThrowingRunnable - Interface in pro.verron.docxstamper.utils
-
A functional interface representing runnable task able to throw an exception.
- toString() - Method in record class org.wickedsource.docxstamper.el.Matcher
-
Returns a string representation of this record class.
- toString() - Method in record class org.wickedsource.docxstamper.replace.typeresolver.TypeResolver
-
Deprecated.Returns a string representation of this record class.
- toString() - Method in record class org.wickedsource.docxstamper.util.IndexedRun
-
Returns a string representation of this record class.
- toString() - Method in class org.wickedsource.docxstamper.util.ParagraphWrapper
- ToStringResolver - Class in pro.verron.docxstamper.preset.resolver
-
The ToStringResolver class is an implementation of the ObjectResolver interface that resolves objects by converting them to a string representation using the `toString()` method and creating a new run with the resolved content.
- ToStringResolver() - Constructor for class pro.verron.docxstamper.preset.resolver.ToStringResolver
- tryBuildingSubtemplate(WordprocessingMLPackage) - Method in class org.wickedsource.docxstamper.util.CommentWrapper
-
Creates a new document containing only the elements between the comment range anchors.
- type() - Method in record class org.wickedsource.docxstamper.replace.typeresolver.TypeResolver
-
Deprecated.Returns the value of the
typerecord component. - TypeResolver<T> - Record Class in org.wickedsource.docxstamper.replace.typeresolver
-
Deprecated, for removal: This API element is subject to removal in a future version.This class is deprecated since version 1.6.7 and will be removed in a future release. Use the
ObjectResolverinterface instead. - TypeResolver(Class<T>, ITypeResolver<? super T>) - Constructor for record class org.wickedsource.docxstamper.replace.typeresolver.TypeResolver
-
Deprecated.Constructs a TypeResolver object with the specified type and resolver.
- TypeResolver(Class<T>, ITypeResolver<? super T>, boolean) - Constructor for record class org.wickedsource.docxstamper.replace.typeresolver.TypeResolver
-
Deprecated.Creates an instance of a
TypeResolverrecord class.
U
- uncaughtException(Thread, Throwable) - Method in class pro.verron.docxstamper.utils.ProcessorExceptionHandler
-
Captures and stores an uncaught exception from a thread run and executes all defined routines on occurrence of the exception.
- UnresolvedExpressionException - Exception Class in org.wickedsource.docxstamper.api
-
This exception is thrown if an expression could not be processed by any comment processor.
- UnresolvedExpressionException(String, Throwable) - Constructor for exception class org.wickedsource.docxstamper.api.UnresolvedExpressionException
-
Constructor for 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.DocumentWalker
-
Starts the traversal of the document.
- walk(WordprocessingMLPackage) - Method in class org.wickedsource.docxstamper.util.walk.CoordinatesWalker
-
walks through the document
- 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|Serialized Form
DocxStamperConfiguration.addResolver(ObjectResolver)method for adding resolvers.