Index (OfficeStamper engine 2.6.0-SNAPSHOT API)

A B C D E F G H I L M N O P R S T U V 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 interface pro.verron.officestamper.api.OfficeStamperConfiguration: Adds a comment processor to the OfficeStamperConfiguration.
addPreprocessor(PreProcessor) - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Adds a pre-processor to the OfficeStamperConfiguration.
addResolver(ObjectResolver) - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Adds an ObjectResolver to the OfficeStamperConfiguration.
asString() - Method in interface pro.verron.officestamper.api.Paragraph: Returns the paragraph as a string.
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

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

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.
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.
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.
CommentProcessorFactory.IDisplayIfProcessor - Interface in pro.verron.officestamper.preset: Interface for processors that may be used to delete commented paragraphs or tables from the document, depending on a given condition.
CommentProcessorFactory.IParagraphRepeatProcessor - Interface in pro.verron.officestamper.preset: Implementations of this interface are responsible for processing the repeat paragraph instruction.
CommentProcessorFactory.IRepeatDocPartProcessor - Interface in pro.verron.officestamper.preset: Interface for processors which may be called to mark a document part to be copied once for each element in the passed-in list.
CommentProcessorFactory.IRepeatProcessor - Interface in pro.verron.officestamper.preset: Interface for processors that can repeat a table row.
CommentProcessorFactory.IReplaceWithProcessor - Interface in pro.verron.officestamper.preset: Interface for processors that replace a single word with an expression defined in a comment.
CommentProcessorFactory.ITableResolver - Interface in pro.verron.officestamper.preset: This interface is used to resolve a table in the template document.
commentsPart() - Method in interface pro.verron.officestamper.api.DocxDocument
commitChanges(WordprocessingMLPackage) - Method in interface pro.verron.officestamper.api.CommentProcessor: Deprecated, for removal: This API element is subject to removal in a future version.
replaced by CommentProcessor.commitChanges(DocxPart)
commitChanges(DocxPart) - 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 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: Deprecated, for removal: This API element is subject to removal in a future version.
was used by the core to deal with multiline paragraphs
content() - Method in interface pro.verron.officestamper.api.DocxPart
content() - Method in interface pro.verron.officestamper.api.Placeholder: Returns the content of the placeholder.

D

defaultConfigurer() - Static method in class pro.verron.officestamper.preset.EvaluationContextConfigurers: Returns a default EvaluationContextConfigurer instance.
defaulting() - Static method in class pro.verron.officestamper.preset.ExceptionResolvers: The defaulting resolver class will handle exceptions by returning an empty string.
defaulting(String) - Static method in class pro.verron.officestamper.preset.ExceptionResolvers: The defaulting resolver class will handle exceptions by returning a default value.
displayIf(ParagraphPlaceholderReplacer) - Method in class pro.verron.officestamper.preset.CommentProcessorFactory: Creates a new CommentProcessorFactory with default configuration.
displayParagraphIf(Boolean) - Method in interface pro.verron.officestamper.preset.CommentProcessorFactory.IDisplayIfProcessor: May be called to delete the commented paragraph or not, depending on the given boolean condition.
displayParagraphIfPresent(Object) - Method in interface pro.verron.officestamper.preset.CommentProcessorFactory.IDisplayIfProcessor: May be called to delete the commented paragraph or not, depending on the presence of the given data.
displayTableIf(Boolean) - Method in interface pro.verron.officestamper.preset.CommentProcessorFactory.IDisplayIfProcessor: May be called to delete the table surrounding the commented paragraph, depending on the given boolean condition.
displayTableRowIf(Boolean) - Method in interface pro.verron.officestamper.preset.CommentProcessorFactory.IDisplayIfProcessor: May be called to delete the table surrounding the commented paragraph, depending on the given boolean condition.
document() - Method in interface pro.verron.officestamper.api.DocxDocument
DocxDocument - Interface in pro.verron.officestamper.api
DocxPart - Interface in pro.verron.officestamper.api
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.

E

empty() - Static method in class pro.verron.officestamper.preset.StampTable: empty.
endIndex() - Method in record class pro.verron.officestamper.experimental.PowerpointRun: Returns the value of the endIndex record component.
equals(Object) - Method in record class pro.verron.officestamper.experimental.PowerpointRun: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in class pro.verron.officestamper.preset.StampTable
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.
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
ExceptionResolver - Interface in pro.verron.officestamper.api: ExceptionResolver is a functional interface used to resolve the behavior when an exception occurs during the processing of a placeholder.
ExceptionResolvers - Class in pro.verron.officestamper.preset: The ExceptionResolvers class provides a set of static factory methods to create different types of ExceptionResolver implementations.
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.
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.

F

f1123datetime(TemporalAccessor) - Method in interface pro.verron.officestamper.preset.IStamperDateFormatter
fallback() - Static method in class pro.verron.officestamper.preset.Resolvers: Returns an instance of ObjectResolver that can act as a fallback resolver.
fbasicdate(TemporalAccessor) - Method in interface pro.verron.officestamper.preset.IStamperDateFormatter
fdate(TemporalAccessor) - Method in interface pro.verron.officestamper.preset.IStamperDateFormatter
fdatetime(TemporalAccessor) - Method in interface pro.verron.officestamper.preset.IStamperDateFormatter
finstant(TemporalAccessor) - Method in interface pro.verron.officestamper.preset.IStamperDateFormatter
flocaldate(TemporalAccessor) - Method in interface pro.verron.officestamper.preset.IStamperDateFormatter
flocaldate(TemporalAccessor, String) - Method in interface pro.verron.officestamper.preset.IStamperDateFormatter
flocaldatetime(TemporalAccessor) - Method in interface pro.verron.officestamper.preset.IStamperDateFormatter
flocaldatetime(TemporalAccessor, String) - Method in interface pro.verron.officestamper.preset.IStamperDateFormatter
flocaldatetime(TemporalAccessor, String, String) - Method in interface pro.verron.officestamper.preset.IStamperDateFormatter
flocaltime(TemporalAccessor) - Method in interface pro.verron.officestamper.preset.IStamperDateFormatter
flocaltime(TemporalAccessor, String) - Method in interface pro.verron.officestamper.preset.IStamperDateFormatter
foffsetdate(TemporalAccessor) - Method in interface pro.verron.officestamper.preset.IStamperDateFormatter
foffsetdatetime(TemporalAccessor) - Method in interface pro.verron.officestamper.preset.IStamperDateFormatter
foffsettime(TemporalAccessor) - Method in interface pro.verron.officestamper.preset.IStamperDateFormatter
fordinaldate(TemporalAccessor) - Method in interface pro.verron.officestamper.preset.IStamperDateFormatter
fpattern(TemporalAccessor, String) - Method in interface pro.verron.officestamper.preset.IStamperDateFormatter
fpattern(TemporalAccessor, String, String) - Method in interface pro.verron.officestamper.preset.IStamperDateFormatter
from(ContentAccessor) - Method in interface pro.verron.officestamper.api.DocxPart
ftime(TemporalAccessor) - Method in interface pro.verron.officestamper.preset.IStamperDateFormatter
fweekdate(TemporalAccessor) - Method in interface pro.verron.officestamper.preset.IStamperDateFormatter
fzoneddatetime(TemporalAccessor) - Method in interface pro.verron.officestamper.preset.IStamperDateFormatter

G

getChildren() - Method in interface pro.verron.officestamper.api.Comment: Retrieves the children of the comment.
getComment() - Method in interface pro.verron.officestamper.api.Comment: Retrieves the comment associated with this object.
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.
getCommentRangeStart() - Method in interface pro.verron.officestamper.api.Comment: Retrieves the CommentRangeStart object associated with this comment.
getCommentReference() - Method in interface pro.verron.officestamper.api.Comment: Retrieves the R.CommentReference object associated with this comment.
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.
getDocument() - Method in interface pro.verron.officestamper.api.Comment: Retrieves the WordprocessingMLPackage document.
getElements() - Method in interface pro.verron.officestamper.api.Comment: Retrieves the elements in the document that are between the comment range anchors.
getEvaluationContextConfigurer() - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Retrieves the EvaluationContextConfigurer for configuring the Spring Expression Language (SPEL) EvaluationContext used by the docxstamper.
getExceptionResolver() - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration
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 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.
getParagraph() - Method in class pro.verron.officestamper.api.AbstractCommentProcessor: Getter for the field paragraph.
getParent() - Method in interface pro.verron.officestamper.api.Comment: Retrieves the parent of the comment.
getPreprocessors() - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Retrieves the list of pre-processors.
getResolvers() - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Retrieves the list of ObjectResolvers.
getSpelParserConfiguration() - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Retrieves the SpelParserConfiguration used by the OfficeStamperConfiguration.
getUnresolvedExpressionsDefaultValue() - 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 deprecated because it offers limited functionality by just checking a flag. It is replaced by OfficeStamperConfiguration.setExceptionResolver(ExceptionResolver) , which provides complete customization over the behavior during resolution failures. The new method allows you to define how unresolved expressions are handled in a more flexible and comprehensive manner.

H

hashCode() - Method in record class pro.verron.officestamper.experimental.PowerpointRun: Returns a hash code value for this object.
hashCode() - Method in class pro.verron.officestamper.preset.StampTable
headers() - Method in class pro.verron.officestamper.preset.StampTable: headers.

I

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.
indexInParent() - Method in record class pro.verron.officestamper.experimental.PowerpointRun: Returns the value of the indexInParent record component.
isFailOnUnresolvedExpression() - 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 deprecated because it offers limited functionality by just checking a flag. It is replaced by OfficeStamperConfiguration.setExceptionResolver(ExceptionResolver) , which provides complete customization over the behavior during resolution failures. The new method allows you to define how unresolved expressions are handled in a more flexible and comprehensive manner.
isLeaveEmptyOnExpressionError() - 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 deprecated because it offers limited functionality by just checking a flag. It is replaced by OfficeStamperConfiguration.setExceptionResolver(ExceptionResolver) , which provides complete customization over the behavior during resolution failures. The new method allows you to define how unresolved expressions are handled in a more flexible and comprehensive manner.
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.
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.
isReplaceUnresolvedExpressions() - 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 deprecated because it offers limited functionality by just checking a flag. It is replaced by OfficeStamperConfiguration.setExceptionResolver(ExceptionResolver) , which provides complete customization over the behavior during resolution failures. The new method allows you to define how unresolved expressions are handled in a more flexible and comprehensive manner.
IStamperDateFormatter - Interface in pro.verron.officestamper.preset
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.

L

leaveEmptyOnExpressionError(boolean) - 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 deprecated because it offers limited functionality by just checking a flag. It is replaced by OfficeStamperConfiguration.setExceptionResolver(ExceptionResolver) , which provides complete customization over the behavior during resolution failures. The new method allows you to define how unresolved expressions are handled in a more flexible and comprehensive manner.
legacyBehavior(boolean, boolean, boolean, String) - Static method in class pro.verron.officestamper.preset.ExceptionResolvers: Deprecated, for removal: This API element is subject to removal in a future version.
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
LOGGER - Static variable in interface pro.verron.officestamper.api.ObjectResolver

M

mergeSimilarRuns() - Static method in class pro.verron.officestamper.preset.Preprocessors: Returns a PreProcessor object that merges same style runs that are next to each other in a WordprocessingMLPackage document.

N

noopConfigurer() - Static method in class pro.verron.officestamper.preset.EvaluationContextConfigurers: Returns a EvaluationContextConfigurer instance that does no customization.
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.

O

ObjectResolver - Interface in pro.verron.officestamper.api: The ObjectResolver interface provides a contract for resolving objects to create a run with the resolved content.
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: Interface representing the configuration for the Office Stamper functionality.
OfficeStamperConfigurations - Class in pro.verron.officestamper.preset: The OfficeStamperConfigurations class provides static methods to create different configurations for the OfficeStamper.
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.

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.
part() - Method in interface pro.verron.officestamper.api.DocxPart
passing() - Static method in class pro.verron.officestamper.preset.ExceptionResolvers: The passing resolver will handle exceptions by returning the placeholder expression.
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.
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.
Preprocessors - Class in pro.verron.officestamper.preset: A helper class that provides pre-processing functionality for WordprocessingMLPackage documents.
pro.verron.officestamper - module pro.verron.officestamper: This module serves as the main module for the "pro.verron.officestamper" application.
pro.verron.officestamper.api - package pro.verron.officestamper.api
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() - Static method in class pro.verron.officestamper.preset.OfficeStamperConfigurations: Creates a new standard OfficeStamperConfiguration.
removeLanguageProof() - Static method in class pro.verron.officestamper.preset.Preprocessors: Returns a PreProcessor object that removes all ProofErr elements from the WordprocessingMLPackage document.
repeat(ParagraphPlaceholderReplacer) - Method in class pro.verron.officestamper.preset.CommentProcessorFactory: Creates a new CommentProcessorFactory with default configuration.
repeatDocPart(List<Object>) - Method in interface pro.verron.officestamper.preset.CommentProcessorFactory.IRepeatDocPartProcessor: May be called to mark a document part to be copied once for each element in the passed-in list.
repeatDocPart(ParagraphPlaceholderReplacer) - Method in class pro.verron.officestamper.preset.CommentProcessorFactory: Creates a new CommentProcessorFactory with default configuration.
repeatParagraph(List<Object>) - Method in interface pro.verron.officestamper.preset.CommentProcessorFactory.IParagraphRepeatProcessor: May be called to mark a paragraph to be copied once for each element in the passed-in list.
repeatParagraph(ParagraphPlaceholderReplacer) - Method in class pro.verron.officestamper.preset.CommentProcessorFactory: Creates a new CommentProcessorFactory with default configuration.
repeatTableRow(List<Object>) - Method in interface pro.verron.officestamper.preset.CommentProcessorFactory.IRepeatProcessor: 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 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.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: Deprecated, for removal: This API element is subject to removal in a future version.
was used by the core to deal with multiline paragraphs, users should fallback to Paragraph.replace(Placeholder, Object) only
replaceUnresolvedExpressions(boolean) - 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 deprecated because it offers limited functionality by just checking a flag. It is replaced by OfficeStamperConfiguration.setExceptionResolver(ExceptionResolver) , which provides complete customization over the behavior during resolution failures. The new method allows you to define how unresolved expressions are handled in a more flexible and comprehensive manner.
replaceWith(ParagraphPlaceholderReplacer) - Method in class pro.verron.officestamper.preset.CommentProcessorFactory: Creates a new CommentProcessorFactory with default configuration.
replaceWordWith(String) - Method in interface pro.verron.officestamper.preset.CommentProcessorFactory.IReplaceWithProcessor: May be called to replace a single word inside a paragraph with an expression defined in a comment.
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: Deprecated, for removal: This API element is subject to removal in a future version.
replaced by ObjectResolver.resolve(DocxPart, String, Object)
resolve(DocxPart, String, Object) - Method in interface pro.verron.officestamper.api.ObjectResolver: Resolves the expression in the given document with the provided object.
resolve(DocxPart, 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(DocxPart, Placeholder, Object) - Method in interface pro.verron.officestamper.api.ObjectResolver: Resolves the expression in the given document with the provided object.
resolve(Placeholder, String, Exception) - Method in interface pro.verron.officestamper.api.ExceptionResolver
resolve(T) - Method in class pro.verron.officestamper.api.StringResolver: Resolves an object to a string.
resolveExpressionsForParagraph(DocxPart, Paragraph, Object) - 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 interface pro.verron.officestamper.api.ParagraphPlaceholderReplacer: Deprecated, for removal: This API element is subject to removal in a future version.
replaced by ParagraphPlaceholderReplacer.resolveExpressionsForParagraph(DocxPart, Paragraph, Object)
Resolvers - Class in pro.verron.officestamper.preset: This class provides static methods to create different types of ObjectResolver.
resolveTable(StampTable) - Method in interface pro.verron.officestamper.preset.CommentProcessorFactory.ITableResolver: Resolves the given table by manipulating the given table in the template
run() - Method in record class pro.verron.officestamper.experimental.PowerpointRun: Returns the value of the run record component.

S

setChildren(Set<Comment>) - Method in interface pro.verron.officestamper.api.Comment: Sets the children of the comment.
setComment(Comments.Comment) - Method in interface pro.verron.officestamper.api.Comment: Sets the comment for this object.
setCommentRangeEnd(CommentRangeEnd) - Method in interface pro.verron.officestamper.api.Comment: Sets the CommentRangeEnd object associated with this comment.
setCommentRangeStart(CommentRangeStart) - Method in interface pro.verron.officestamper.api.Comment: Sets the CommentRangeStart object associated with this comment.
setCommentReference(R.CommentReference) - Method in interface pro.verron.officestamper.api.Comment: Sets the comment reference for this comment.
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).
setEvaluationContextConfigurer(EvaluationContextConfigurer) - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Sets the EvaluationContextConfigurer for configuring the Spring Expression Language (SPEL) EvaluationContext.
setExceptionResolver(ExceptionResolver) - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration
setFailOnUnresolvedExpression(boolean) - 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 deprecated because it offers limited functionality by just checking a flag. It is replaced by OfficeStamperConfiguration.setExceptionResolver(ExceptionResolver) , which provides complete customization over the behavior during resolution failures. The new method allows you to define how unresolved expressions are handled in a more flexible and comprehensive manner.
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 interface pro.verron.officestamper.api.OfficeStamperConfiguration: Sets the list of object resolvers for the OfficeStamper configuration.
setSpelParserConfiguration(SpelParserConfiguration) - Method in interface pro.verron.officestamper.api.OfficeStamperConfiguration: Sets the SpelParserConfiguration used by the OfficeStamperConfiguration.
size() - Method in class pro.verron.officestamper.preset.StampTable
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(T, Object, OutputStream) - Method in interface pro.verron.officestamper.api.OfficeStamper: Stamps the template with the context and writes the result to the outputStream.
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 pro.verron.officestamper.preset.StampTable: Instantiate an empty table
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.
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 pro.verron.officestamper.experimental.PowerpointRun: Returns the value of the startIndex record component.
streamParagraphs() - Method in interface pro.verron.officestamper.api.DocxPart
streamParts(String) - Method in interface pro.verron.officestamper.api.DocxDocument
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

tableResolver(ParagraphPlaceholderReplacer) - Method in class pro.verron.officestamper.preset.CommentProcessorFactory: Creates a new CommentProcessorFactory with default configuration.
throwing() - Static method in class pro.verron.officestamper.preset.ExceptionResolvers: The throwing resolver will handle exceptions by immediately throwing an OfficeStamperException.
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.

U

unresolvedExpressionsDefaultValue(String) - 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 deprecated because it offers limited functionality by just checking a flag. It is replaced by OfficeStamperConfiguration.setExceptionResolver(ExceptionResolver) , which provides complete customization over the behavior during resolution failures. The new method allows you to define how unresolved expressions are handled in a more flexible and comprehensive manner.

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.

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 X
All Classes and Interfaces|All Packages|Serialized Form