Index (docx-stamper 1.6.8 API)

A B C D E F G H I L M N O P R S T U V W X
All Classes and Interfaces|All Packages|Serialized Form

A

AbstractCommentProcessor - Class in pro.verron.officestamper.api: AbstractCommentProcessor is an abstract base class for comment processors.
AbstractCommentProcessor(ParagraphPlaceholderReplacer) - Constructor for class pro.verron.officestamper.api.AbstractCommentProcessor: Creates an instance of AbstractCommentProcessor with the given ParagraphPlaceholderReplacer.
addCommentProcessor(Class<?>, Function<ParagraphPlaceholderReplacer, CommentProcessor>) - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration: Deprecated.

Registers the specified ICommentProcessor as an implementation of the specified interface.
addCommentProcessor(Class<?>, Function<ParagraphPlaceholderReplacer, CommentProcessor>) - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Adds a comment processor to the OfficeStamperConfiguration.
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: Deprecated.

Adds a preprocessor to the configuration.
addPreprocessor(PreProcessor) - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Adds a pre-processor to the OfficeStamperConfiguration.
addResolver(ObjectResolver) - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration: Deprecated.

Adds a resolver to the list of resolvers in the `DocxStamperConfiguration` object.
addResolver(ObjectResolver) - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Adds an ObjectResolver to the OfficeStamperConfiguration.
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.
This method has been deprecated since version 1.6.7, and it is scheduled for removal. It's recommended to use the DocxStamperConfiguration.addResolver(ObjectResolver) method for adding resolvers.
addTypeResolver(Class<T>, ITypeResolver<T>) - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: 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.
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.
asString() - Method in interface pro.verron.officestamper.api.Paragraph: Returns the paragraph as a string.
asString() - Method in class pro.verron.officestamper.core.StandardParagraph: Returns the aggregated text over all runs.
asString() - Method in class pro.verron.officestamper.experimental.ExcelParagraph: Returns the aggregated text over all runs.
asString() - Method in class pro.verron.officestamper.experimental.PowerpointParagraph: Returns the aggregated text over all runs.

B

BaseCommentProcessor - Class in org.wickedsource.docxstamper.processor: Base class for comment processors.
BaseCommentProcessor(ParagraphPlaceholderReplacer) - Constructor for class org.wickedsource.docxstamper.processor.BaseCommentProcessor: Constructor for BaseCommentProcessor.
before(Object) - Method in class pro.verron.officestamper.experimental.ExcelCollector: This method is called before visiting an object in the ExcelCollector class.
before(Object) - Method in class pro.verron.officestamper.experimental.PowerpointCollector
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(OfficeStamperConfiguration)} instead
build() - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Deprecated, for removal: This API element is subject to removal in a future version.
This method is marked for removal and should not be used. Consider using a different method instead.

C

canResolve(Object) - Method in interface pro.verron.officestamper.api.ObjectResolver: Checks if the given object can be resolved.
canResolve(Object) - Method in class pro.verron.officestamper.api.StringResolver: Determines if the given object can be resolved by the StringResolver.
canResolve(Object) - Method in class pro.verron.officestamper.preset.Resolvers.Null2DefaultResolver: Deprecated.
collect() - Method in class pro.verron.officestamper.experimental.ExcelCollector: Returns a List containing the collected objects.
collect() - Method in class pro.verron.officestamper.experimental.PowerpointCollector: Retrieves the collected instances of a specific class.
collect(Object, Class<T>) - Static method in class pro.verron.officestamper.experimental.ExcelCollector: Collects objects of a specific type from an Excel file.
collect(Object, Class<T>) - Static method in class pro.verron.officestamper.experimental.PowerpointCollector: Collects instances of a specific class in a PowerPoint presentation.
Comment - Interface in pro.verron.officestamper.api: The Comment interface provides methods for managing comments in a document.
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.
CommentProcessor - Interface in pro.verron.officestamper.api: CommentProcessor is an interface that defines the methods for processing comments in a .docx template.
CommentProcessorFactory - Class in pro.verron.officestamper.preset: Factory class to create the correct comment processor for a given comment.
CommentProcessorFactory(OfficeStamperConfiguration) - Constructor for class pro.verron.officestamper.preset.CommentProcessorFactory: Creates a new CommentProcessorFactory.
CommentProcessorRegistry - Class in org.wickedsource.docxstamper.processor: Allows registration of ICommentProcessor objects.
CommentProcessorRegistry(ExpressionResolver, Map<Class<?>, Object>, boolean) - Constructor for class org.wickedsource.docxstamper.processor.CommentProcessorRegistry: Creates a new CommentProcessorRegistry.
CommentUtil - Class in org.wickedsource.docxstamper.util: Deprecated, for removal: This API element is subject to removal in a future version.
since 1.6.8, This class has been deprecated in the effort of the library modularization. It is recommended to use the CommentUtil class instead. This class will be removed in the future releases of the module.
CommentUtil - Class in pro.verron.officestamper.core: Utility class for working with comments in a DOCX document.
CommentUtil() - Constructor for class pro.verron.officestamper.core.CommentUtil: Utility class for handling comments in a DOCX document.
CommentWrapper - Class in org.wickedsource.docxstamper.util: Deprecated, for removal: This API element is subject to removal in a future version.
since 1.6.8, This class has been deprecated in the effort of the library modularization. It is recommended to use the StandardComment class and Comment interface instead. This class will be moved to internals in the future releases of the module.
CommentWrapper() - Constructor for class org.wickedsource.docxstamper.util.CommentWrapper: Deprecated.

The CommentWrapper class is a subclass of StandardComment that represents a comment wrapper in a Word document.
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.
commitChanges(WordprocessingMLPackage) - Method in interface pro.verron.officestamper.api.CommentProcessor: This method is called after all comments in the .docx template have been passed to the comment processor.
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.
configureEvaluationContext(StandardEvaluationContext) - Method in interface pro.verron.officestamper.api.EvaluationContextConfigurer: Configure the context before it's used by docxstamper.
contains(String) - Method in interface pro.verron.officestamper.api.Paragraph: Returns true if the given expression is found within the paragraph, otherwise returns false.
content() - Method in interface pro.verron.officestamper.api.Placeholder: Returns the content of the placeholder.
content() - Method in record class pro.verron.officestamper.core.StandardPlaceholder: Returns the inner part of the expression by stripping the prefix and suffix.
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.
createRunWithImage(Integer, BinaryPartAbstractImage) - Static method in class org.wickedsource.docxstamper.util.RunUtil: Creates a run containing the given image.
createSubWordDocument(Comment) - Static method in class pro.verron.officestamper.core.CommentUtil: Creates a sub Word document by extracting a specified comment and its associated content from the original document.
createText(String) - Static method in class org.wickedsource.docxstamper.util.RunUtil: Creates a text object with the given text.

D

defaultConfigurer() - Static method in class pro.verron.officestamper.preset.EvaluationContextConfigurers: Returns a default EvaluationContextConfigurer instance.
DefaultEvaluationContextConfigurer - Class in org.wickedsource.docxstamper.el: EvaluationContextConfigurer that has 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.officestamper.preset.Resolvers.Null2DefaultResolver: Deprecated.

Retrieves the default value of the Resolvers.Null2DefaultResolver object.
deleteComment(Comment) - Static method in class pro.verron.officestamper.core.CommentUtil: Returns the string value of the specified comment object.
deleteCommentFromElements(List<Object>, BigInteger) - Static method in class pro.verron.officestamper.core.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.
depthElementSearch(Object, Object) - Static method in class org.wickedsource.docxstamper.util.DocumentUtil: Recursively searches for an element in a content tree.
displayIf(ParagraphPlaceholderReplacer) - Method in class pro.verron.officestamper.preset.CommentProcessorFactory: Creates a new CommentProcessorFactory with default configuration.
DocumentUtil - Class in org.wickedsource.docxstamper.util: Utility class to retrieve elements from a 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() - Static method in class pro.verron.officestamper.preset.OfficeStampers: Creates a new DocxStamper with the default configuration.
docxStamper(OfficeStamperConfiguration) - Static method in class pro.verron.officestamper.preset.OfficeStampers: Creates a new instance of the DocxStamper class with the specified OfficeStamperConfiguration.
DocxStamper<T> - Class in org.wickedsource.docxstamper: Deprecated, for removal: This API element is subject to removal in a future version.
since 1.6.8, This class has been deprecated in the effort of the library modularization, because it exposes too many implementation details to library users, and makes it hard to extend the library comfortably. It is recommended to use the OfficeStampers methods instead. This class will not be exported in the future releases of the module.
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 OfficeStampers.docxStamper() instead.
DocxStamper(OfficeStamperConfiguration) - Constructor for class org.wickedsource.docxstamper.DocxStamper: Deprecated.

Creates a new DocxStamper with the given configuration.
DocxStamperConfiguration - Class in org.wickedsource.docxstamper: Deprecated, for removal: This API element is subject to removal in a future version.
since 1.6.8, This class has been deprecated in the effort of the library modularization, because it exposes too many implementation details to library users, and makes it hard to extend the library comfortably. It is recommended to use the OfficeStamperConfigurations.standard() method and OfficeStamperConfiguration interface instead. This class will not be exported in the future releases of the module.
DocxStamperConfiguration() - Constructor for class org.wickedsource.docxstamper.DocxStamperConfiguration: Deprecated.

Creates a new configuration with default values.
DocxStamperException - Exception Class in org.wickedsource.docxstamper.api: Deprecated, for removal: This API element is subject to removal in a future version.
since 1.6.8, This class has been deprecated in the effort of the library modularization. It is recommended to use the OfficeStamperException class instead. This class will not be exported in the future releases of the module.
DocxStamperException(String) - Constructor for exception class org.wickedsource.docxstamper.api.DocxStamperException: Deprecated.

Constructor for DocxStamperException.
DocxStamperException(String, Throwable) - Constructor for exception class org.wickedsource.docxstamper.api.DocxStamperException: Deprecated.

Constructor for DocxStamperException.
DocxStamperException(Throwable) - Constructor for exception class org.wickedsource.docxstamper.api.DocxStamperException: Deprecated.

Constructor for DocxStamperException.

E

empty() - Static method in class pro.verron.officestamper.preset.StampTable: empty.
endIndex() - Method in record class org.wickedsource.docxstamper.util.IndexedRun: Returns the value of the endIndex record component.
endIndex() - Method in record class pro.verron.officestamper.experimental.PowerpointRun: Returns the value of the endIndex record component.
equals(Object) - Method in record class org.wickedsource.docxstamper.util.IndexedRun: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class pro.verron.officestamper.core.StandardPlaceholder: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class pro.verron.officestamper.experimental.PowerpointRun: Indicates whether some other object is "equal to" this one.
EvaluationContextConfigurer - Interface in org.wickedsource.docxstamper.api: Deprecated, for removal: This API element is subject to removal in a future version.
since 1.6.8, This class has been deprecated in the effort of the library modularization. It is recommended to use the EvaluationContextConfigurer class instead. This class will not be exported in the future releases of the module.
EvaluationContextConfigurer - Interface in pro.verron.officestamper.api: The EvaluationContextConfigurer interface allows for custom configuration of a Spring Expression Language (SPEL) EvaluationContext.
EvaluationContextConfigurers - Class in pro.verron.officestamper.preset: Utility class for configuring the EvaluationContext used by officestamper.
EvaluationContextConfigurers() - Constructor for class pro.verron.officestamper.preset.EvaluationContextConfigurers
ExcelCollector<T> - Class in pro.verron.officestamper.experimental: The ExcelCollector class is used to collect objects of a specific type from an Excel file.
ExcelCollector(Class<T>) - Constructor for class pro.verron.officestamper.experimental.ExcelCollector: Constructs a new ExcelCollector object with the given type.
ExcelParagraph - Class in pro.verron.officestamper.experimental: The ExcelParagraph class represents a paragraph in an Excel document.
ExcelParagraph(CTRst) - Constructor for class pro.verron.officestamper.experimental.ExcelParagraph: Constructs a new ParagraphWrapper for the given paragraph.
ExcelStamper - Class in pro.verron.officestamper.experimental: The ExcelStamper class is an implementation of the OfficeStamper interface for stamping Excel templates.
ExcelStamper() - Constructor for class pro.verron.officestamper.experimental.ExcelStamper
execute(EvaluationContext, Object, Object...) - Method in class org.wickedsource.docxstamper.el.StandardMethodExecutor
ExperimentalStampers - Class in pro.verron.officestamper.preset: ExperimentalStampers is a class that provides static methods for obtaining instances of OfficeStamper implementations for stamping PowerPoint presentations and Excel templates with context and writing the result to an OutputStream.
ExperimentalStampers() - Constructor for class pro.verron.officestamper.preset.ExperimentalStampers
exposeInterfaceToExpressionLanguage(Class<?>, Object) - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration: Deprecated.

Exposes all methods of a given interface to the expression language.
exposeInterfaceToExpressionLanguage(Class<?>, Object) - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Exposes an interface to the expression language.
expression() - Method in interface pro.verron.officestamper.api.Placeholder: Retrieves the expression of the placeholder.
expression() - Method in record class pro.verron.officestamper.core.StandardPlaceholder: Returns the value of the expression record component.
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.

F

fallback() - Static method in class pro.verron.officestamper.preset.Resolvers: Returns an instance of ObjectResolver that can act as a fallback resolver.
findComment(WordprocessingMLPackage, BigInteger) - Static method in class pro.verron.officestamper.core.CommentUtil: Finds a comment with the given ID in the specified WordprocessingMLPackage document.
findProcessors(String) - Static method in class pro.verron.officestamper.core.Placeholders: Finds processors expressions in a given text.
findSmallestCommonParent(Object, Object) - Static method in class org.wickedsource.docxstamper.util.DocumentUtil: Finds the smallest common parent between two objects.
findVariables(String) - Static method in class pro.verron.officestamper.core.Placeholders: Finds variable expressions in a given text.
findVariables(Paragraph) - Static method in class pro.verron.officestamper.core.Placeholders: Finds variable expressions in a given paragraph.

G

getChildren() - Method in interface pro.verron.officestamper.api.Comment: Retrieves the children of the comment.
getChildren() - Method in class pro.verron.officestamper.core.StandardComment: Getter for the field children.
getComment() - Method in interface pro.verron.officestamper.api.Comment: Retrieves the comment associated with this object.
getComment() - Method in class pro.verron.officestamper.core.StandardComment: Getter for the field comment.
getCommentAround(R, WordprocessingMLPackage) - Static method in class pro.verron.officestamper.core.CommentUtil: Returns the comment the given DOCX4J object is commented with.
getCommentFor(ContentAccessor, WordprocessingMLPackage) - Static method in class pro.verron.officestamper.core.CommentUtil: Returns the first comment found for the given docx object.
getCommentProcessors() - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration: Deprecated.

Getter for the field commentProcessors.
getCommentProcessors() - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Returns a map of comment processors associated with their respective classes.
getCommentRangeEnd() - Method in interface pro.verron.officestamper.api.Comment: Retrieves the CommentRangeEnd object associated with this comment.
getCommentRangeEnd() - Method in class pro.verron.officestamper.core.StandardComment: Getter for the field commentRangeEnd.
getCommentRangeStart() - Method in interface pro.verron.officestamper.api.Comment: Retrieves the CommentRangeStart object associated with this comment.
getCommentRangeStart() - Method in class pro.verron.officestamper.core.StandardComment: Getter for the field commentRangeStart.
getCommentReference() - Method in interface pro.verron.officestamper.api.Comment: Retrieves the R.CommentReference object associated with this comment.
getCommentReference() - Method in class pro.verron.officestamper.core.StandardComment: Getter for the field commentReference.
getComments(WordprocessingMLPackage) - Static method in class pro.verron.officestamper.core.CommentUtil: Extracts all comments from the given document.
getCommentString(Comments.Comment) - Static method in class pro.verron.officestamper.core.CommentUtil: Returns the string value of the specified comment object.
getCommentStringFor(ContentAccessor, WordprocessingMLPackage) - Static method in class pro.verron.officestamper.core.CommentUtil: Deprecated, for removal: This API element is subject to removal in a future version.
This method's been deprecated since version 1.6.8 and will be removed in the future.
getCurrentCommentWrapper() - Method in class pro.verron.officestamper.api.AbstractCommentProcessor: Getter for the field currentCommentWrapper.
getCurrentRun() - Method in class pro.verron.officestamper.api.AbstractCommentProcessor: 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's been deprecated since version 1.6.7 and is scheduled for removal. You should not have to use it, it was a clutch for previous version of docx-stamper.
getDefaultTypeResolver() - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: 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 will be removed in a future release.
getDocument() - Method in class pro.verron.officestamper.api.AbstractCommentProcessor: 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
getDocument() - Method in interface pro.verron.officestamper.api.Comment: Retrieves the WordprocessingMLPackage document.
getDocument() - Method in class pro.verron.officestamper.core.StandardComment
getElements() - Method in interface pro.verron.officestamper.api.Comment: Retrieves the elements in the document that are between the comment range anchors.
getElements() - Method in class pro.verron.officestamper.core.StandardComment
getEvaluationContextConfigurer() - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration: Deprecated.

Getter for the field evaluationContextConfigurer.
getEvaluationContextConfigurer() - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Retrieves the EvaluationContextConfigurer for configuring the Spring Expression Language (SPEL) EvaluationContext used by the docxstamper.
getExpressionFunctions() - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration: Deprecated.

Getter for the field expressionFunctions.
getExpressionFunctions() - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Retrieves the map of expression functions associated with their corresponding classes.
getImageBytes() - Method in class pro.verron.officestamper.preset.Image: Getter for the field imageBytes.
getLineBreakPlaceholder() - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration: Deprecated.

Getter for the field lineBreakPlaceholder.
getLineBreakPlaceholder() - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Retrieves the line break placeholder used in the OfficeStamper configuration.
getMaxWidth() - Method in class pro.verron.officestamper.preset.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.
getNullValuesDefault() - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: 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 will be removed in a future release.
getParagraph() - Method in class pro.verron.officestamper.api.AbstractCommentProcessor: 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: Deprecated, for removal: This API element is subject to removal in a future version.
method not used internally so will be removed
getParent() - Method in interface pro.verron.officestamper.api.Comment: Retrieves the parent of the comment.
getParent() - Method in class pro.verron.officestamper.core.StandardComment: getParent.
getPreprocessors() - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration: Deprecated.

Getter for the field preprocessors.
getPreprocessors() - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Retrieves the list of pre-processors.
getPreviousSectionBreakIfPresent(Object, ContentAccessor) - Static method in class org.wickedsource.docxstamper.util.SectionUtil: Creates a new section break object.
getRepeatElements() - Method in interface pro.verron.officestamper.api.Comment: Deprecated, for removal: This API element is subject to removal in a future version.
removed for replacement by Comment.getElements() which doesn't imply a specific usage
getResolvers() - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration: Deprecated.

Retrieves the list of resolvers.
getResolvers() - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Retrieves the list of ObjectResolvers.
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.
getSpelParserConfiguration() - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration: Deprecated.

Getter for the field spelParserConfiguration.
getSpelParserConfiguration() - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Retrieves the SpelParserConfiguration used by the OfficeStamperConfiguration.
getSubTemplate(WordprocessingMLPackage) - Method in interface pro.verron.officestamper.api.Comment: Deprecated, for removal: This API element is subject to removal in a future version.
use createSubWordDocument(Comment) instead
getSubTemplate(WordprocessingMLPackage) - Method in class pro.verron.officestamper.core.StandardComment: Deprecated, for removal: This API element is subject to removal in a future version.
use createSubWordDocument(Comment) instead
getTableCellsFromObject(Object) - Static method in class org.wickedsource.docxstamper.util.DocumentUtil: Deprecated, for removal: This API element is subject to removal in a future version.
method not used internally so will be removed
getTableFromObject(Object) - Static method in class org.wickedsource.docxstamper.util.DocumentUtil: Deprecated, for removal: This API element is subject to removal in a future version.
method not used internally so will be removed
getTableRowsFromObject(Object) - Static method in class org.wickedsource.docxstamper.util.DocumentUtil: Deprecated, for removal: This API element is subject to removal in a future version.
method not used internally so will be removed
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's been deprecated since version 1.6.7
getTypeResolvers() - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: 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 will be removed in a future release. Use of this method is discouraged and should be replaced with an alternative implementation.
getUnresolvedExpressionsDefaultValue() - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration: Deprecated.

Getter for the field unresolvedExpressionsDefaultValue.
getUnresolvedExpressionsDefaultValue() - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Retrieves the default value for unresolved expressions.

H

hashCode() - Method in record class org.wickedsource.docxstamper.util.IndexedRun: Returns a hash code value for this object.
hashCode() - Method in record class pro.verron.officestamper.core.StandardPlaceholder: Returns a hash code value for this object.
hashCode() - Method in record class pro.verron.officestamper.experimental.PowerpointRun: 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 pro.verron.officestamper.preset.StampTable: headers.

I

ICommentProcessor - Interface in org.wickedsource.docxstamper.api.commentprocessor: Deprecated, for removal: This API element is subject to removal in a future version.
since 1.6.8, This class has been deprecated in the effort of the library modularization. It is recommended to use the CommentProcessor class instead. This class will not be exported in the future releases of the module.
image() - Static method in class pro.verron.officestamper.preset.Resolvers: Returns an instance of ObjectResolver that resolves Image to an actual image in the resulting .docx document.
Image - Class in pro.verron.officestamper.preset: This class describes an image which will be inserted into a document.
Image(byte[]) - Constructor for class pro.verron.officestamper.preset.Image: Constructor for Image.
Image(byte[], Integer) - Constructor for class pro.verron.officestamper.preset.Image: Constructor for Image.
Image(InputStream) - Constructor for class pro.verron.officestamper.preset.Image: Constructor for Image.
Image(InputStream, Integer) - Constructor for class pro.verron.officestamper.preset.Image: Constructor for Image.
imageBytes - Variable in class pro.verron.officestamper.preset.Image: TODO_LATER: make private asap
IndexedRun - Record Class in org.wickedsource.docxstamper.util: Represents a run (i.e., a text fragment) in a paragraph.
IndexedRun(int, int, int, R) - Constructor for record class org.wickedsource.docxstamper.util.IndexedRun: Creates an instance of a IndexedRun record class.
indexInParent() - Method in record class org.wickedsource.docxstamper.util.IndexedRun: Returns the value of the indexInParent record component.
indexInParent() - Method in record class pro.verron.officestamper.experimental.PowerpointRun: Returns the value of the indexInParent record component.
invoke(Object...) - Method in interface org.wickedsource.docxstamper.el.StandardMethodExecutor.Invoker: Should call the expected method with the given arguments
isFailOnUnresolvedExpression() - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration: Deprecated.

isFailOnUnresolvedExpression.
isFailOnUnresolvedExpression() - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Checks if the failOnUnresolvedExpression flag is set to true or false.
isLeaveEmptyOnExpressionError() - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration: Deprecated.

isLeaveEmptyOnExpressionError.
isLeaveEmptyOnExpressionError() - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Determines whether to leave empty on expression error.
isoDate() - Static method in class pro.verron.officestamper.preset.Resolvers: Returns an instance of ObjectResolver that resolves LocalDate values to a formatted string using the DateTimeFormatter.ISO_LOCAL_DATE pattern.
isoDate(DateTimeFormatter) - Static method in class pro.verron.officestamper.preset.Resolvers: Returns an instance of ObjectResolver that resolves LocalDate values to a formatted string using the given DateTimeFormatter pattern.
isoDateTime() - Static method in class pro.verron.officestamper.preset.Resolvers: Returns an instance of ObjectResolver that resolves LocalDateTime values to a formatted string using the DateTimeFormatter.ISO_LOCAL_DATE_TIME pattern.
isoDateTime(DateTimeFormatter) - Static method in class pro.verron.officestamper.preset.Resolvers: Returns an instance of ObjectResolver that resolves LocalDateTime values to a formatted string using the given DateTimeFormatter pattern.
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.officestamper.preset.Resolvers: Returns an instance of ObjectResolver that resolves LocalTime values to a formatted string using the DateTimeFormatter.ISO_LOCAL_TIME pattern.
isoTime(DateTimeFormatter) - Static method in class pro.verron.officestamper.preset.Resolvers: Returns an instance of ObjectResolver that resolves LocalTime values to a formatted string using the given DateTimeFormatter pattern.
isReplaceNullValues() - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration: Deprecated, for removal: This API element is subject to removal in a future version.
This method's been 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.
isReplaceNullValues() - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Deprecated, for removal: This API element is subject to removal in a future version.
Since version 1.6.7. This method will be removed in a future release.
isReplaceUnresolvedExpressions() - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration: Deprecated.

isReplaceUnresolvedExpressions.
isReplaceUnresolvedExpressions() - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Determines whether unresolved expressions in the OfficeStamper configuration should be replaced.
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.
isTouchedByRange(int, int) - Method in record class pro.verron.officestamper.experimental.PowerpointRun: Checks if the given range of indices touches the start or end index of the 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 pro.verron.officestamper.api: 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: Deprecated.

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.
leaveEmptyOnExpressionError(boolean) - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Configures whether to leave empty on expression error.
legacyDate() - Static method in class pro.verron.officestamper.preset.Resolvers: Returns an instance of ObjectResolver that resolves Date values to a formatted string using the "dd.MM.yyyy" pattern.
legacyDate(DateTimeFormatter) - Static method in class pro.verron.officestamper.preset.Resolvers: Returns an instance of ObjectResolver that resolves Date values to a formatted string using the given DateTimeFormatter pattern.
listIterator(int) - Method in class pro.verron.officestamper.preset.StampTable

M

matcher() - Method in record class pro.verron.officestamper.core.StandardPlaceholder: Returns the value of the matcher record component.
maxWidth - Variable in class pro.verron.officestamper.preset.Image: TODO_LATER: make private asap

N

newInstance(ParagraphPlaceholderReplacer) - Static method in class org.wickedsource.docxstamper.processor.table.TableResolver: Generate a new TableResolver instance where value is replaced by an empty list when null
newInstance(PlaceholderReplacer, String) - Static method in class org.wickedsource.docxstamper.processor.table.TableResolver: Deprecated, for removal: This API element is subject to removal in a future version.
should be an internal implementation detail
noopConfigurer() - Static method in class pro.verron.officestamper.preset.EvaluationContextConfigurers: Returns a EvaluationContextConfigurer instance that does no customization.
NoOpEvaluationContextConfigurer - Class in org.wickedsource.docxstamper.el: EvaluationContextConfigurer that does no customization.
NoOpEvaluationContextConfigurer() - Constructor for class org.wickedsource.docxstamper.el.NoOpEvaluationContextConfigurer
Null2DefaultResolver(String) - Constructor for class pro.verron.officestamper.preset.Resolvers.Null2DefaultResolver: Deprecated.
nullReplacementValue() - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration: Deprecated.
This method's been deprecated since version 1.6.7. You shouldn't have to use it, it was a crutch use for inner working of docx-stamper
nullReplacementValue() - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Deprecated, for removal: This API element is subject to removal in a future version.
since version 1.6.7
nullToDefault(String) - Static method in class pro.verron.officestamper.preset.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.officestamper.preset.Resolvers: Returns an instance of ObjectResolver that replaces null values with an empty string.
nullToPlaceholder() - Static method in class pro.verron.officestamper.preset.Resolvers: Returns an instance of ObjectResolver that resolves null objects by not replacing their expression.
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) and Resolvers.nullToDefault(String) instead.
nullValuesDefault(String) - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Deprecated, for removal: This API element is subject to removal in a future version.
since version 1.6.7

O

ObjectDeleter - Class in org.wickedsource.docxstamper.util: Utility class for deleting objects from a Document.
ObjectResolver - Interface in pro.verron.officestamper.api: The ObjectResolver interface provides a contract for resolving objects to create a run with the resolved content.
ObjectResolverRegistry - Class in pro.verron.officestamper.core: A registry for object resolvers.
ObjectResolverRegistry(List<ObjectResolver>) - Constructor for class pro.verron.officestamper.core.ObjectResolverRegistry: A registry for object resolvers.
OfficeStamper<T> - Interface in pro.verron.officestamper.api: This is an interface that defines the contract for stamping templates with context and writing the result to an OutputStream.
OfficeStamperConfiguration - Interface in pro.verron.officestamper.api: Represents the configuration for the OfficeStamper class.
OfficeStamperConfigurations - Class in pro.verron.officestamper.preset: The OfficeStamperConfigurations class provides static methods to create different configurations for the OfficeStamper.
OfficeStamperConfigurations() - Constructor for class pro.verron.officestamper.preset.OfficeStamperConfigurations
OfficeStamperException - Exception Class in pro.verron.officestamper.api: OfficeStamperException is a subclass of RuntimeException that represents an exception that can be thrown during the processing of an Office document using the OfficeStamper library .
OfficeStamperException() - Constructor for exception class pro.verron.officestamper.api.OfficeStamperException: OfficeStamperException is a subclass of RuntimeException that represents an exception that can be thrown during the processing of an Office document using the OfficeStamper library.
OfficeStamperException(String) - Constructor for exception class pro.verron.officestamper.api.OfficeStamperException: OfficeStamperException is a subclass of RuntimeException that represents an exception that can be thrown during the processing of an Office document using the OfficeStamper library.
OfficeStamperException(String, Throwable) - Constructor for exception class pro.verron.officestamper.api.OfficeStamperException: OfficeStamperException is a subclass of RuntimeException that represents an exception that can be thrown during the processing of an Office document using the OfficeStamper library.
OfficeStamperException(Throwable) - Constructor for exception class pro.verron.officestamper.api.OfficeStamperException: OfficeStamperException is a subclass of RuntimeException that represents an exception that can be thrown during the processing of an Office document using the OfficeStamper library.
OfficeStampers - Class in pro.verron.officestamper.preset: Main class of the docx-stamper library.
OfficeStampers() - Constructor for class pro.verron.officestamper.preset.OfficeStampers
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.el - package org.wickedsource.docxstamper.el
org.wickedsource.docxstamper.processor - package org.wickedsource.docxstamper.processor
org.wickedsource.docxstamper.processor.table - package org.wickedsource.docxstamper.processor.table
org.wickedsource.docxstamper.util - package org.wickedsource.docxstamper.util

P

Paragraph - Interface in pro.verron.officestamper.api: The Paragraph interface represents a paragraph in a text document.
ParagraphPlaceholderReplacer - Interface in pro.verron.officestamper.api: The ParagraphPlaceholderReplacer interface represents an object that can resolve expressions in a paragraph and replace them with values provided by an expression resolver.
ParagraphUtil - Class in org.wickedsource.docxstamper.util: Utility class for creating paragraphs.
Placeholder - Interface in pro.verron.officestamper.api: The Placeholder interface represents a placeholder in a text document.
placeholderReplacer - Variable in class pro.verron.officestamper.api.AbstractCommentProcessor: PlaceholderReplacer used to replace expressions in the comment text.
PlaceholderReplacer - Class in pro.verron.officestamper.core: Replaces expressions in a document with the values provided by the ExpressionResolver.
PlaceholderReplacer(ObjectResolverRegistry, ExpressionResolver, boolean, boolean, String, boolean, Placeholder) - Constructor for class pro.verron.officestamper.core.PlaceholderReplacer: Constructor for PlaceholderReplacer.
Placeholders - Class in pro.verron.officestamper.core: The Expressions class provides utility methods for finding variables and processors in a given text.
PowerpointCollector<T> - Class in pro.verron.officestamper.experimental: The PowerpointCollector class is used to collect instances of a specific class in a PowerPoint presentation.
PowerpointCollector(Class<T>) - Constructor for class pro.verron.officestamper.experimental.PowerpointCollector: The PowerpointCollector class is used to collect instances of a specific class in a PowerPoint presentation.
PowerpointParagraph - Class in pro.verron.officestamper.experimental: A "Run" defines a region of text within a docx document with a common set of properties.
PowerpointParagraph(CTTextParagraph) - Constructor for class pro.verron.officestamper.experimental.PowerpointParagraph: Constructs a new ParagraphWrapper for the given paragraph.
PowerpointRun - Record Class in pro.verron.officestamper.experimental: Represents a run within a PowerPoint slide.
PowerpointRun(int, int, int, CTRegularTextRun) - Constructor for record class pro.verron.officestamper.experimental.PowerpointRun: Creates an instance of a PowerpointRun record class.
PowerpointStamper - Class in pro.verron.officestamper.experimental: The PowerpointStamper class implements the OfficeStamper interface to provide functionality for stamping Powerpoint presentations with context and writing the result to an OutputStream.
PowerpointStamper() - Constructor for class pro.verron.officestamper.experimental.PowerpointStamper
pptxStamper() - Static method in class pro.verron.officestamper.preset.ExperimentalStampers: Returns a new instance of the OfficeStamper implementation for stamping PowerPoint presentations with context and writing the result to an OutputStream.
PreProcessor - Interface in pro.verron.officestamper.api: An interface for pre-processors that are called before the actual processing of a document takes place.
pro.verron.officestamper - module pro.verron.officestamper: This module serves as the main module for the "pro.verron.officestamper" application.
pro.verron.officestamper - package pro.verron.officestamper
pro.verron.officestamper.api - package pro.verron.officestamper.api
pro.verron.officestamper.core - package pro.verron.officestamper.core: This package provides the core functionality for docxstamper.
pro.verron.officestamper.experimental - package pro.verron.officestamper.experimental
pro.verron.officestamper.preset - package pro.verron.officestamper.preset: This package provides presets and recommended configurations for docxstamper library users;
process(WordprocessingMLPackage) - Method in interface pro.verron.officestamper.api.PreProcessor: Processes the given document before the actual processing takes place.

R

raw(String) - Static method in class pro.verron.officestamper.core.Placeholders: Creates a new raw placeholder with the given text.
repeat(ParagraphPlaceholderReplacer) - Method in class pro.verron.officestamper.preset.CommentProcessorFactory: Creates a new CommentProcessorFactory with default configuration.
repeatDocPart(ParagraphPlaceholderReplacer) - Method in class pro.verron.officestamper.preset.CommentProcessorFactory: Creates a new CommentProcessorFactory with default configuration.
repeatParagraph(ParagraphPlaceholderReplacer) - Method in class pro.verron.officestamper.preset.CommentProcessorFactory: Creates a new CommentProcessorFactory with default configuration.
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(int, int, String) - Method in record class pro.verron.officestamper.experimental.PowerpointRun: Replaces a substring within the run's text.
replace(Placeholder, Object) - Method in interface pro.verron.officestamper.api.Paragraph: Replaces a placeholder in the given paragraph with the specified replacement.
replace(Placeholder, Object) - Method in class pro.verron.officestamper.core.StandardParagraph: Replaces the given expression with the replacement object within the paragraph.
replace(Placeholder, Object) - Method in class pro.verron.officestamper.experimental.PowerpointParagraph: Replaces the given expression with the replacement object within the paragraph.
replace(Placeholder, String) - Method in class pro.verron.officestamper.experimental.ExcelParagraph: Replaces the given expression with the replacement object within the paragraph.
replaceAll(Placeholder, R) - Method in interface pro.verron.officestamper.api.Paragraph: Replaces all occurrences of a placeholder with a specified replacement value within a paragraph.
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) and Resolvers.nullToDefault(String) instead.
replaceNullValues(boolean) - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Deprecated, for removal: This API element is subject to removal in a future version.
since version 1.6.7
replaceUnresolvedExpressions(boolean) - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration: Deprecated.

Indicates if a default value should replace expressions that don't resolve.
replaceUnresolvedExpressions(boolean) - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Replaces unresolved expressions in the OfficeStamperConfiguration object.
replaceWith(ParagraphPlaceholderReplacer) - Method in class pro.verron.officestamper.preset.CommentProcessorFactory: Creates a new CommentProcessorFactory with default configuration.
reset() - Method in class org.wickedsource.docxstamper.processor.CommentProcessorRegistry: Resets all registered ICommentProcessors.
reset() - Method in class org.wickedsource.docxstamper.processor.table.TableResolver: Resets all states in the comment processor so that it can be re-used in another stamping process.
reset() - Method in interface pro.verron.officestamper.api.CommentProcessor: Resets all states in the comment processor so that it can be re-used in another stamping process.
resolve(WordprocessingMLPackage, String, Object) - Method in interface pro.verron.officestamper.api.ObjectResolver: Resolves the expression in the given document with the provided object.
resolve(WordprocessingMLPackage, String, Object) - Method in class pro.verron.officestamper.api.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.officestamper.preset.Resolvers.Null2DefaultResolver: Deprecated.
resolve(WordprocessingMLPackage, Placeholder, Object) - Method in interface pro.verron.officestamper.api.ObjectResolver: Resolves the expression in the given document with the provided object.
resolve(WordprocessingMLPackage, Placeholder, Object) - Method in class pro.verron.officestamper.core.ObjectResolverRegistry: Resolves the expression in the given document with the provided object.
resolve(WordprocessingMLPackage, T) - Method in interface pro.verron.officestamper.api.ITypeResolver: Deprecated.

This method is called when an expression is found in the .docx template.
resolve(EvaluationContext, Object, String, List<TypeDescriptor>) - Method in class org.wickedsource.docxstamper.el.StandardMethodResolver
resolve(Placeholder, Object) - Method in class org.wickedsource.docxstamper.el.ExpressionResolver: Resolves the given expression against the provided context object.
resolve(T) - Method in class pro.verron.officestamper.api.StringResolver: Resolves an object to a string.
resolveExpressions(WordprocessingMLPackage, Object) - Method in class pro.verron.officestamper.core.PlaceholderReplacer: Finds expressions in a document and resolves them against the specified context object.
resolveExpressionsForParagraph(Paragraph, Object, WordprocessingMLPackage) - Method in interface pro.verron.officestamper.api.ParagraphPlaceholderReplacer: Finds expressions in the given paragraph and replaces them with the values provided by the expression resolver.
resolveExpressionsForParagraph(Paragraph, Object, WordprocessingMLPackage) - Method in class pro.verron.officestamper.core.PlaceholderReplacer: Finds expressions in the given paragraph and replaces them with the values provided by the expression resolver.
Resolvers - Class in pro.verron.officestamper.preset: This class provides static methods to create different types of ObjectResolver.
Resolvers() - Constructor for class pro.verron.officestamper.preset.Resolvers
Resolvers.Null2DefaultResolver - Class in pro.verron.officestamper.preset: Deprecated.
will not be removed, but will be made package-private
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 run record component.
run() - Method in record class pro.verron.officestamper.experimental.PowerpointRun: Returns the value of the run record component.
runProcessors(WordprocessingMLPackage, T) - Method in class org.wickedsource.docxstamper.processor.CommentProcessorRegistry: Lets each registered ICommentProcessor 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.
setChildren(Set<Comment>) - Method in interface pro.verron.officestamper.api.Comment: Sets the children of the comment.
setChildren(Set<Comment>) - Method in class pro.verron.officestamper.core.StandardComment
setComment(Comments.Comment) - Method in interface pro.verron.officestamper.api.Comment: Sets the comment for this object.
setComment(Comments.Comment) - Method in class pro.verron.officestamper.core.StandardComment
setCommentRangeEnd(CommentRangeEnd) - Method in interface pro.verron.officestamper.api.Comment: Sets the CommentRangeEnd object associated with this comment.
setCommentRangeEnd(CommentRangeEnd) - Method in class pro.verron.officestamper.core.StandardComment
setCommentRangeStart(CommentRangeStart) - Method in interface pro.verron.officestamper.api.Comment: Sets the CommentRangeStart object associated with this comment.
setCommentRangeStart(CommentRangeStart) - Method in class pro.verron.officestamper.core.StandardComment
setCommentReference(R.CommentReference) - Method in interface pro.verron.officestamper.api.Comment: Sets the comment reference for this comment.
setCommentReference(R.CommentReference) - Method in class pro.verron.officestamper.core.StandardComment
setCurrentCommentWrapper(Comment) - Method in class pro.verron.officestamper.api.AbstractCommentProcessor: Passes the comment range wrapper that is currently being processed (i.e., the start and end of comment that in the .docx template).
setCurrentCommentWrapper(Comment) - Method in interface pro.verron.officestamper.api.CommentProcessor: Passes the comment range wrapper that is currently being processed (i.e., the start and end of comment that in the .docx template).
setCurrentRun(R) - Method in class pro.verron.officestamper.api.AbstractCommentProcessor: Passes the run that is currently being processed (i.e., the run that is commented in the .docx template).
setCurrentRun(R) - Method in interface pro.verron.officestamper.api.CommentProcessor: Passes the run that is currently being processed (i.e., the run that is commented in the .docx template).
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 using DocxStamperConfiguration.setResolvers(List)} and putting your fallback resolvers in the last place.
setDefaultTypeResolver(ITypeResolver<? super Object>) - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Deprecated, for removal: This API element is subject to removal in a future version.
setDocument(WordprocessingMLPackage) - Method in class pro.verron.officestamper.api.AbstractCommentProcessor: 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 interface pro.verron.officestamper.api.CommentProcessor: 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: Deprecated.

Provides an EvaluationContextConfigurer which may change the configuration of a Spring EvaluationContext which is used for evaluating expressions in comments and text.
setEvaluationContextConfigurer(EvaluationContextConfigurer) - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Sets the EvaluationContextConfigurer for configuring the Spring Expression Language (SPEL) EvaluationContext.
setFailOnUnresolvedExpression(boolean) - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration: Deprecated.

If set to true, stamper will throw an DocxStamperException if a variable expression or processor expression within the document or within the comments is encountered that cannot be resolved.
setFailOnUnresolvedExpression(boolean) - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Sets the failOnUnresolvedExpression flag to determine whether unresolved expressions should cause an exception to be thrown.
setLineBreakPlaceholder(String) - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration: Deprecated.

The String provided as lineBreakPlaceholder will be replaced with a line break when stamping a document.
setLineBreakPlaceholder(String) - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Sets the line break placeholder used in the OfficeStamper configuration.
setParagraph(P) - Method in class pro.verron.officestamper.api.AbstractCommentProcessor: Passes the paragraph that is currently being processed (i.e., the paragraph that is commented in the .docx template).
setParagraph(P) - Method in interface pro.verron.officestamper.api.CommentProcessor: Passes the paragraph that is currently being processed (i.e., the paragraph that is commented in the .docx template).
setResolvers(List<ObjectResolver>) - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration: Deprecated.

Sets the resolvers for resolving objects in the DocxStamperConfiguration.
setResolvers(List<ObjectResolver>) - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Sets the list of object resolvers for the OfficeStamper configuration.
setSpelParserConfiguration(SpelParserConfiguration) - Method in class org.wickedsource.docxstamper.DocxStamperConfiguration: Deprecated.

Sets the SpelParserConfiguration to use for expression parsing.
setSpelParserConfiguration(SpelParserConfiguration) - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Sets the SpelParserConfiguration used by the OfficeStamperConfiguration.
setText(R, String) - Static method in class org.wickedsource.docxstamper.util.RunUtil: Sets the text of the given run to the given value.
size() - Method in class pro.verron.officestamper.preset.StampTable
stamp(InputStream, Object, OutputStream) - Method in class org.wickedsource.docxstamper.DocxStamper: Deprecated.
stamp(InputStream, Object, OutputStream) - Method in class pro.verron.officestamper.api.StreamStamper: Stamps the template present in the given InputStream with the context given and writes the result to the provided OutputStream.
stamp(PresentationMLPackage, Object, OutputStream) - Method in class pro.verron.officestamper.experimental.PowerpointStamper
stamp(SpreadsheetMLPackage, Object, OutputStream) - Method in class pro.verron.officestamper.experimental.ExcelStamper
stamp(WordprocessingMLPackage, Object, OutputStream) - Method in class org.wickedsource.docxstamper.DocxStamper: Deprecated.

Stamps the template with the context and writes the result to the outputStream.
stamp(T, Object, OutputStream) - Method in interface pro.verron.officestamper.api.OfficeStamper: Stamps the template with the context and writes the result to the outputStream.
StamperFactory - Class in pro.verron.officestamper: Deprecated, for removal: This API element is subject to removal in a future version.
since 1.6.8, This class has been deprecated in the effort of the library modularization. It is recommended to use the CommentUtil class instead. This class will be removed in the future releases of the module.
StamperFactory() - Constructor for class pro.verron.officestamper.StamperFactory: Deprecated.
StampTable - Class in org.wickedsource.docxstamper.processor.table: Deprecated, for removal: This API element is subject to removal in a future version.
since 1.6.8, This class has been deprecated in the effort of the library modularization. It is recommended to use the StampTable class instead. This class will be removed in the future releases of the module.
StampTable - Class in pro.verron.officestamper.preset: Represents a table with several columns, a header line, and several lines of content
StampTable() - Constructor for class org.wickedsource.docxstamper.processor.table.StampTable: Deprecated.
StampTable() - Constructor for class pro.verron.officestamper.preset.StampTable: Instantiate an empty table
StampTable(List<String>, List<List<String>>) - Constructor for class org.wickedsource.docxstamper.processor.table.StampTable: Deprecated.
StampTable(List<String>, List<List<String>>) - Constructor for class pro.verron.officestamper.preset.StampTable: Instantiate a table with headers and several lines
standard() - Static method in class pro.verron.officestamper.preset.OfficeStamperConfigurations: Creates a new standard OfficeStamperConfiguration.
StandardComment - Class in pro.verron.officestamper.core: CommentWrapper class.
StandardComment(WordprocessingMLPackage) - Constructor for class pro.verron.officestamper.core.StandardComment: Constructs a new StandardComment object.
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.
StandardParagraph - Class in pro.verron.officestamper.core: A "Run" defines a region of text within a docx document with a common set of properties.
StandardParagraph(P) - Constructor for class pro.verron.officestamper.core.StandardParagraph: Constructs a new ParagraphWrapper for the given paragraph.
StandardPlaceholder - Record Class in pro.verron.officestamper.core: Represents an expression with a configured Matcher.
StandardPlaceholder(Matcher, String) - Constructor for record class pro.verron.officestamper.core.StandardPlaceholder: Creates an instance of a StandardPlaceholder record class.
standardWithPreprocessing() - Static method in class pro.verron.officestamper.preset.OfficeStamperConfigurations: Creates a new OfficeStamperConfiguration with the standard configuration and additional preprocessors.
startIndex() - Method in record class org.wickedsource.docxstamper.util.IndexedRun: Returns the value of the startIndex record component.
startIndex() - Method in record class pro.verron.officestamper.experimental.PowerpointRun: Returns the value of the startIndex record 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.
StreamStamper<T> - Class in pro.verron.officestamper.api: This class implements the functionality of an OfficeStamper meant for dealing with streams of data.
StreamStamper(Function<InputStream, T>, OfficeStamper<T>) - Constructor for class pro.verron.officestamper.api.StreamStamper: Constructs a new StreamStamper with the provided loader and stamper.
StringResolver<T> - Class in pro.verron.officestamper.api: This is an abstract class that provides a generic implementation for resolving objects to strings.
StringResolver(Class<T>) - Constructor for class pro.verron.officestamper.api.StringResolver: Creates a new StringResolver with the given type.

T

TableCellUtil - Class in org.wickedsource.docxstamper.util: Utility class for table cells
tableResolver(ParagraphPlaceholderReplacer) - Method in class pro.verron.officestamper.preset.CommentProcessorFactory: Creates a new CommentProcessorFactory with default configuration.
TableResolver - Class in org.wickedsource.docxstamper.processor.table: TableResolver class.
toString() - Method in record class org.wickedsource.docxstamper.util.IndexedRun: Returns a string representation of this record class.
toString() - Method in class pro.verron.officestamper.core.StandardParagraph
toString() - Method in record class pro.verron.officestamper.core.StandardPlaceholder: Returns a string representation of this record class.
toString() - Method in class pro.verron.officestamper.experimental.ExcelParagraph
toString() - Method in class pro.verron.officestamper.experimental.PowerpointParagraph
toString() - Method in record class pro.verron.officestamper.experimental.PowerpointRun: Returns a string representation of this record class.
tryBuildingSubtemplate(WordprocessingMLPackage) - Method in interface pro.verron.officestamper.api.Comment: Deprecated, for removal: This API element is subject to removal in a future version.
use createSubWordDocument(Comment) instead
tryBuildingSubtemplate(WordprocessingMLPackage) - Method in class pro.verron.officestamper.core.StandardComment: Deprecated, for removal: This API element is subject to removal in a future version.
use createSubWordDocument(Comment) instead

U

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: Deprecated.

Indicates the default value to use for expressions that doesn't resolve.
unresolvedExpressionsDefaultValue(String) - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Sets the default value for unresolved expressions in the OfficeStamperConfiguration object.

V

visit(Object) - Method in class pro.verron.officestamper.experimental.ExcelCollector: Visits the given object and performs specific operations based on its type.
visit(Object) - Method in class pro.verron.officestamper.experimental.PowerpointCollector: Signal the visited object through the before method, then apply logic to know the visit next elements or ignore deeper nesting based on the object type.

W

walkObjectsAndImportImages(WordprocessingMLPackage, WordprocessingMLPackage) - Static method in class org.wickedsource.docxstamper.util.DocumentUtil: Recursively walk through a 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.

X

xlsxStamper() - Static method in class pro.verron.officestamper.preset.ExperimentalStampers: Returns a new instance of the OfficeStamper implementation for stamping Excel templates with context and writing the result to an OutputStream.

A B C D E F G H I L M N O P R S T U V W X
All Classes and Interfaces|All Packages|Serialized Form