A B C D E F G H I M O P R S T W

A

AbstractCoordinates - Class in org.wickedsource.docxstamper.walk.coordinates

AbstractCoordinates() - Constructor for class org.wickedsource.docxstamper.walk.coordinates.AbstractCoordinates

AbstractToTextResolver<S> - Class in org.wickedsource.docxstamper.replace.typeresolver

Abstract ITypeResolver that takes a String from the implementing sub class and creates a Run of text from it.

AbstractToTextResolver() - Constructor for class org.wickedsource.docxstamper.replace.typeresolver.AbstractToTextResolver

addEmptyParagraph(Tc) - Static method in class org.wickedsource.docxstamper.util.TableCellUtil

B

BaseCommentProcessor - Class in org.wickedsource.docxstamper.processor

BaseCommentProcessor() - Constructor for class org.wickedsource.docxstamper.processor.BaseCommentProcessor

BaseCoordinatesWalker - Class in org.wickedsource.docxstamper.walk.coordinates

BaseCoordinatesWalker(WordprocessingMLPackage) - Constructor for class org.wickedsource.docxstamper.walk.coordinates.BaseCoordinatesWalker

BaseDocumentWalker - Class in org.wickedsource.docxstamper.walk

BaseDocumentWalker(ContentAccessor) - Constructor for class org.wickedsource.docxstamper.walk.BaseDocumentWalker

C

cleanPlaceholder(String) - Method in class org.wickedsource.docxstamper.replace.ParagraphWrapper

Removes the specified placeholder from the runs that are touched by it and returns the index at which a replacement for the placeholder may be inserted into the paragraph.

CommentProcessingException - Exception in org.wickedsource.docxstamper.processor

CommentProcessingException(String, ParagraphCoordinates) - Constructor for exception org.wickedsource.docxstamper.processor.CommentProcessingException

CommentProcessingException(String, TableCoordinates) - Constructor for exception org.wickedsource.docxstamper.processor.CommentProcessingException

CommentProcessorRegistry - Class in org.wickedsource.docxstamper.api.commentprocessor

Allows registration of ICommentProcessor objects.

CommentProcessorRegistry() - Constructor for class org.wickedsource.docxstamper.api.commentprocessor.CommentProcessorRegistry

CommentUtil - Class in org.wickedsource.docxstamper.util

CommentUtil() - Constructor for class org.wickedsource.docxstamper.util.CommentUtil

commitChanges(WordprocessingMLPackage) - Method in interface org.wickedsource.docxstamper.api.commentprocessor.ICommentProcessor

This method is called after all comments in the .docx template have been passed to the comment processor.

commitChanges(WordprocessingMLPackage) - Method in class org.wickedsource.docxstamper.processor.displayif.DisplayIfProcessor

commitChanges(WordprocessingMLPackage) - Method in class org.wickedsource.docxstamper.processor.repeat.RepeatProcessor

ContextFactory<T> - Class in org.wickedsource.docxstamper.proxy

ContextFactory() - Constructor for class org.wickedsource.docxstamper.proxy.ContextFactory

CoordinatesWalker - Class in org.wickedsource.docxstamper.walk.coordinates

CoordinatesWalker(WordprocessingMLPackage) - Constructor for class org.wickedsource.docxstamper.walk.coordinates.CoordinatesWalker

create(String...) - Static method in class org.wickedsource.docxstamper.util.ParagraphUtil

Creates a new paragraph.

create(String) - Static method in class org.wickedsource.docxstamper.util.RunUtil

Creates a new run with the specified text.

createProxy(T, Class<?>, ICommentProcessor) - Method in class org.wickedsource.docxstamper.proxy.ContextFactory

Creates a proxy object that is able to answer calls to all methods defined in the specified root object as well as all methods defined in the specified interface class.

createRunWithImage(WordprocessingMLPackage, byte[], String, String) - Static method in class org.wickedsource.docxstamper.replace.typeresolver.image.ImageResolver

D

DateResolver - Class in org.wickedsource.docxstamper.replace.typeresolver

This ITypeResolver creates a formatted date String for expressions that return a Date object.

DateResolver(String) - Constructor for class org.wickedsource.docxstamper.replace.typeresolver.DateResolver

Creates a new DateResolver.

deleteCommentFromParagraph(P, Comments.Comment) - Static method in class org.wickedsource.docxstamper.util.CommentUtil

deleteParagraph(ParagraphCoordinates) - Method in class org.wickedsource.docxstamper.util.ObjectDeleter

deleteTable(TableCoordinates) - Method in class org.wickedsource.docxstamper.util.ObjectDeleter

deleteTableRow(TableRowCoordinates) - Method in class org.wickedsource.docxstamper.util.ObjectDeleter

DisplayIfProcessor - Class in org.wickedsource.docxstamper.processor.displayif

DisplayIfProcessor() - Constructor for class org.wickedsource.docxstamper.processor.displayif.DisplayIfProcessor

displayParagraphIf(Boolean) - Method in class org.wickedsource.docxstamper.processor.displayif.DisplayIfProcessor

displayParagraphIf(Boolean) - Method in interface org.wickedsource.docxstamper.processor.displayif.IDisplayIfProcessor

May be called to delete the commented paragraph or not, depending on the given boolean condition.

displayTableIf(Boolean) - Method in class org.wickedsource.docxstamper.processor.displayif.DisplayIfProcessor

displayTableIf(Boolean) - Method in interface org.wickedsource.docxstamper.processor.displayif.IDisplayIfProcessor

May be called to delete the table surrounding the commented paragraph, depending on the given boolean condition.

displayTableRowIf(Boolean) - Method in class org.wickedsource.docxstamper.processor.displayif.DisplayIfProcessor

displayTableRowIf(Boolean) - Method in interface org.wickedsource.docxstamper.processor.displayif.IDisplayIfProcessor

May be called to delete the table surrounding the commented paragraph, depending on the given boolean condition.

DocumentWalker - Class in org.wickedsource.docxstamper.walk

DocumentWalker(ContentAccessor) - Constructor for class org.wickedsource.docxstamper.walk.DocumentWalker

DocxStamper<T> - Class in org.wickedsource.docxstamper

Main class of the docx-stamper library.

DocxStamper() - Constructor for class org.wickedsource.docxstamper.DocxStamper

DocxStamperException - Exception in org.wickedsource.docxstamper.api

This exception is thrown when DocxStamper encounters an error.

DocxStamperException() - Constructor for exception org.wickedsource.docxstamper.api.DocxStamperException

DocxStamperException(String) - Constructor for exception org.wickedsource.docxstamper.api.DocxStamperException

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

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

DocxStamperException(String, Throwable, boolean, boolean) - Constructor for exception org.wickedsource.docxstamper.api.DocxStamperException

E

equals(Object) - Method in class org.wickedsource.docxstamper.replace.IndexedRun

equals(Object) - Method in class org.wickedsource.docxstamper.walk.coordinates.AbstractCoordinates

ExpressionResolver - Class in org.wickedsource.docxstamper.el

ExpressionResolver() - Constructor for class org.wickedsource.docxstamper.el.ExpressionResolver

ExpressionUtil - Class in org.wickedsource.docxstamper.el

ExpressionUtil() - Constructor for class org.wickedsource.docxstamper.el.ExpressionUtil

F

FallbackResolver - Class in org.wickedsource.docxstamper.replace.typeresolver

This ITypeResolver may serve as a fallback when there is no ITypeResolver available for a certain type.

FallbackResolver() - Constructor for class org.wickedsource.docxstamper.replace.typeresolver.FallbackResolver

findExpressions(String) - Method in class org.wickedsource.docxstamper.el.ExpressionUtil

Finds all expressions in a text and returns them as list.

G

getAltText() - Method in class org.wickedsource.docxstamper.replace.typeresolver.image.Image

getCell() - Method in class org.wickedsource.docxstamper.walk.coordinates.TableCellCoordinates

getCommentFor(ContentAccessor, WordprocessingMLPackage) - Static method in class org.wickedsource.docxstamper.util.CommentUtil

Returns the first comment found for the given docx object.

getCommentProcessorRegistry() - Method in class org.wickedsource.docxstamper.DocxStamper

Returns the registry in which all ICommentProcessors are registeres.

getCommentString(Comments.Comment) - Static method in class org.wickedsource.docxstamper.util.CommentUtil

Returns the string value of the specified comment object.

getCommentStringFor(ContentAccessor, WordprocessingMLPackage) - Static method in class org.wickedsource.docxstamper.util.CommentUtil

getCurrentParagraphCoordinates() - Method in class org.wickedsource.docxstamper.processor.BaseCommentProcessor

getEndIndex() - Method in class org.wickedsource.docxstamper.replace.IndexedRun

getFilename() - Method in class org.wickedsource.docxstamper.replace.typeresolver.image.Image

getFormatString() - Method in class org.wickedsource.docxstamper.replace.typeresolver.DateResolver

getImageBytes() - Method in class org.wickedsource.docxstamper.replace.typeresolver.image.Image

getIndex() - Method in class org.wickedsource.docxstamper.walk.coordinates.ParagraphCoordinates

getIndex() - Method in class org.wickedsource.docxstamper.walk.coordinates.TableCellCoordinates

getIndex() - Method in class org.wickedsource.docxstamper.walk.coordinates.TableCoordinates

getIndex() - Method in class org.wickedsource.docxstamper.walk.coordinates.TableRowCoordinates

getIndexInParent() - Method in class org.wickedsource.docxstamper.replace.IndexedRun

getLength() - Method in class org.wickedsource.docxstamper.replace.IndexedRun

getParagraph() - Method in class org.wickedsource.docxstamper.walk.coordinates.ParagraphCoordinates

getParentTableCellCoordinates() - Method in class org.wickedsource.docxstamper.walk.coordinates.ParagraphCoordinates

getParentTableCellCoordinates() - Method in class org.wickedsource.docxstamper.walk.coordinates.TableCoordinates

getParentTableCoordinates() - Method in class org.wickedsource.docxstamper.walk.coordinates.TableRowCoordinates

getParentTableRowCoordinates() - Method in class org.wickedsource.docxstamper.walk.coordinates.TableCellCoordinates

getResolverForType(Class<T>) - Method in class org.wickedsource.docxstamper.api.typeresolver.TypeResolverRegistry

Gets the ITypeResolver that was registered for the specified type.

getRow() - Method in class org.wickedsource.docxstamper.walk.coordinates.TableRowCoordinates

getRun() - Method in class org.wickedsource.docxstamper.replace.IndexedRun

getRuns() - Method in class org.wickedsource.docxstamper.replace.ParagraphWrapper

Returns the list of runs that are aggregated.

getStartIndex() - Method in class org.wickedsource.docxstamper.replace.IndexedRun

getTable() - Method in class org.wickedsource.docxstamper.walk.coordinates.TableCoordinates

getText() - Method in class org.wickedsource.docxstamper.replace.ParagraphWrapper

Returns the aggregated text over all runs.

getText(R) - Static method in class org.wickedsource.docxstamper.util.RunUtil

Returns the text string of a run.

getTypeResolverRegistry() - Method in class org.wickedsource.docxstamper.DocxStamper

Returns the registry in which all ITypeResolvers are registered.

H

hasAtLeastOneParagraphOrTable(Tc) - Static method in class org.wickedsource.docxstamper.util.TableCellUtil

hashCode() - Method in class org.wickedsource.docxstamper.replace.IndexedRun

hashCode() - Method in class org.wickedsource.docxstamper.walk.coordinates.AbstractCoordinates

I

ICommentProcessor - Interface in org.wickedsource.docxstamper.api.commentprocessor

In a .docx template used by DocxStamper, you can comment paragraphs of text to manipulate them.

IDisplayIfProcessor - Interface in org.wickedsource.docxstamper.processor.displayif

Image - Class in org.wickedsource.docxstamper.replace.typeresolver.image

Image(InputStream) - Constructor for class org.wickedsource.docxstamper.replace.typeresolver.image.Image

Image(byte[]) - Constructor for class org.wickedsource.docxstamper.replace.typeresolver.image.Image

ImageResolver - Class in org.wickedsource.docxstamper.replace.typeresolver.image

This ITypeResolver allows context objects to return objects of type Image.

ImageResolver() - Constructor for class org.wickedsource.docxstamper.replace.typeresolver.image.ImageResolver

IndexedRun - Class in org.wickedsource.docxstamper.replace

IndexedRun(int, int, int, R) - Constructor for class org.wickedsource.docxstamper.replace.IndexedRun

invoke(Object, Method, Method, Object[]) - Method in class org.wickedsource.docxstamper.proxy.ProxyMethodHandler

IRepeatProcessor - Interface in org.wickedsource.docxstamper.processor.repeat

isTouchedByRange(int, int) - Method in class org.wickedsource.docxstamper.replace.IndexedRun

Determines whether the specified range of start and end index touches this run.

ITypeResolver<S,T> - Interface in org.wickedsource.docxstamper.api.typeresolver

A type resolver is responsible for mapping an object of a certain Java class to an object of the DOCX4J api that can be put into the .docx document.

M

methodCanBeHandledByInterface(Method) - Method in class org.wickedsource.docxstamper.proxy.ProxyMethodHandler

O

ObjectDeleter - Class in org.wickedsource.docxstamper.util

ObjectDeleter(WordprocessingMLPackage) - Constructor for class org.wickedsource.docxstamper.util.ObjectDeleter

onParagraph(P) - Method in class org.wickedsource.docxstamper.walk.BaseDocumentWalker

onParagraph(ParagraphCoordinates) - Method in class org.wickedsource.docxstamper.walk.coordinates.BaseCoordinatesWalker

onParagraph(ParagraphCoordinates) - Method in class org.wickedsource.docxstamper.walk.coordinates.CoordinatesWalker

onParagraph(P) - Method in class org.wickedsource.docxstamper.walk.DocumentWalker

onTable(Tbl) - Method in class org.wickedsource.docxstamper.walk.BaseDocumentWalker

onTable(TableCoordinates) - Method in class org.wickedsource.docxstamper.walk.coordinates.BaseCoordinatesWalker

onTable(TableCoordinates) - Method in class org.wickedsource.docxstamper.walk.coordinates.CoordinatesWalker

onTable(Tbl) - Method in class org.wickedsource.docxstamper.walk.DocumentWalker

onTableCell(Tc) - Method in class org.wickedsource.docxstamper.walk.BaseDocumentWalker

onTableCell(TableCellCoordinates) - Method in class org.wickedsource.docxstamper.walk.coordinates.BaseCoordinatesWalker

onTableCell(TableCellCoordinates) - Method in class org.wickedsource.docxstamper.walk.coordinates.CoordinatesWalker

onTableCell(Tc) - Method in class org.wickedsource.docxstamper.walk.DocumentWalker

onTableRow(Tr) - Method in class org.wickedsource.docxstamper.walk.BaseDocumentWalker

onTableRow(TableRowCoordinates) - Method in class org.wickedsource.docxstamper.walk.coordinates.BaseCoordinatesWalker

onTableRow(TableRowCoordinates) - Method in class org.wickedsource.docxstamper.walk.coordinates.CoordinatesWalker

onTableRow(Tr) - Method in class org.wickedsource.docxstamper.walk.DocumentWalker

org.wickedsource.docxstamper - package org.wickedsource.docxstamper

org.wickedsource.docxstamper.api - package org.wickedsource.docxstamper.api

org.wickedsource.docxstamper.api.commentprocessor - package org.wickedsource.docxstamper.api.commentprocessor

org.wickedsource.docxstamper.api.typeresolver - package org.wickedsource.docxstamper.api.typeresolver

org.wickedsource.docxstamper.el - package org.wickedsource.docxstamper.el

org.wickedsource.docxstamper.processor - package org.wickedsource.docxstamper.processor

org.wickedsource.docxstamper.processor.displayif - package org.wickedsource.docxstamper.processor.displayif

org.wickedsource.docxstamper.processor.repeat - package org.wickedsource.docxstamper.processor.repeat

org.wickedsource.docxstamper.proxy - package org.wickedsource.docxstamper.proxy

org.wickedsource.docxstamper.replace - package org.wickedsource.docxstamper.replace

org.wickedsource.docxstamper.replace.typeresolver - package org.wickedsource.docxstamper.replace.typeresolver

org.wickedsource.docxstamper.replace.typeresolver.image - package org.wickedsource.docxstamper.replace.typeresolver.image

org.wickedsource.docxstamper.util - package org.wickedsource.docxstamper.util

org.wickedsource.docxstamper.walk - package org.wickedsource.docxstamper.walk

org.wickedsource.docxstamper.walk.coordinates - package org.wickedsource.docxstamper.walk.coordinates

P

ParagraphCoordinates - Class in org.wickedsource.docxstamper.walk.coordinates

ParagraphCoordinates(P, int, TableCellCoordinates) - Constructor for class org.wickedsource.docxstamper.walk.coordinates.ParagraphCoordinates

ParagraphCoordinates(P, int) - Constructor for class org.wickedsource.docxstamper.walk.coordinates.ParagraphCoordinates

ParagraphUtil - Class in org.wickedsource.docxstamper.util

ParagraphWrapper - Class in org.wickedsource.docxstamper.replace

A "Run" defines a region of text within a docx document with a common set of properties.

ParagraphWrapper(P) - Constructor for class org.wickedsource.docxstamper.replace.ParagraphWrapper

PlaceholderReplacer<T> - Class in org.wickedsource.docxstamper.replace

PlaceholderReplacer(TypeResolverRegistry) - Constructor for class org.wickedsource.docxstamper.replace.PlaceholderReplacer

ProxyMethodHandler - Class in org.wickedsource.docxstamper.proxy

ProxyMethodHandler(Object, Class<?>, Object) - Constructor for class org.wickedsource.docxstamper.proxy.ProxyMethodHandler

Constructs a MethodHandler that serves as a Proxy for method calls on the specified root object and a specified interface.

R

recalculateRuns() - Method in class org.wickedsource.docxstamper.replace.ParagraphWrapper

registerCommentProcessor(Class<?>, ICommentProcessor) - Method in class org.wickedsource.docxstamper.api.commentprocessor.CommentProcessorRegistry

Registers the specified ICommentProcessor as an implementation of the specified interface.

registerTypeResolver(Class<T>, ITypeResolver) - Method in class org.wickedsource.docxstamper.api.typeresolver.TypeResolverRegistry

Registers the given ITypeResolver for the given class.

RepeatProcessor - Class in org.wickedsource.docxstamper.processor.repeat

RepeatProcessor(TypeResolverRegistry) - Constructor for class org.wickedsource.docxstamper.processor.repeat.RepeatProcessor

repeatTableRow(List<Object>) - Method in interface org.wickedsource.docxstamper.processor.repeat.IRepeatProcessor

May be called to mark a table row to be copied once for each element in the passed-in list.

repeatTableRow(List<Object>) - Method in class org.wickedsource.docxstamper.processor.repeat.RepeatProcessor

replace(int, int, String) - Method in class org.wickedsource.docxstamper.replace.IndexedRun

Replaces the substring starting at the given index with the given replacement string.

resolve(WordprocessingMLPackage, S) - Method in interface org.wickedsource.docxstamper.api.typeresolver.ITypeResolver

This method is called when a placeholder in the .docx template is to replaced by the result of an expression that was found in the .docx template.

resolve(WordprocessingMLPackage, S) - Method in class org.wickedsource.docxstamper.replace.typeresolver.AbstractToTextResolver

resolve(WordprocessingMLPackage, Object) - Method in class org.wickedsource.docxstamper.replace.typeresolver.image.ImageResolver

resolveExpression(String, Object) - Method in class org.wickedsource.docxstamper.el.ExpressionResolver

Runs the given expression against the given context object and returns the result of the evaluated expression.

resolveExpressions(WordprocessingMLPackage, T) - Method in class org.wickedsource.docxstamper.replace.PlaceholderReplacer

Finds expressions in a document and resolves them against the specified context object.

resolveExpressionsForParagraph(P, T, WordprocessingMLPackage) - Method in class org.wickedsource.docxstamper.replace.PlaceholderReplacer

resolveStringForObject(S) - Method in class org.wickedsource.docxstamper.replace.typeresolver.AbstractToTextResolver

resolveStringForObject(Date) - Method in class org.wickedsource.docxstamper.replace.typeresolver.DateResolver

resolveStringForObject(Object) - Method in class org.wickedsource.docxstamper.replace.typeresolver.FallbackResolver

runProcessors(WordprocessingMLPackage, T) - Method in class org.wickedsource.docxstamper.api.commentprocessor.CommentProcessorRegistry

Lets each registered ICommentProcessor have a run on the specified docx document.

RunUtil - Class in org.wickedsource.docxstamper.util

S

setAltText(String) - Method in class org.wickedsource.docxstamper.replace.typeresolver.image.Image

setCurrentParagraphCoordinates(ParagraphCoordinates) - Method in interface org.wickedsource.docxstamper.api.commentprocessor.ICommentProcessor

Passes the paragraph that is currently being processed (i.e. the paragraph that is commented in the .docx template.

setCurrentParagraphCoordinates(ParagraphCoordinates) - Method in class org.wickedsource.docxstamper.processor.BaseCommentProcessor

setDefaultResolver(ITypeResolver) - Method in class org.wickedsource.docxstamper.api.typeresolver.TypeResolverRegistry

Sets the default ITypeResolver that is used for classes that have no ITypeResolver registered.

setFilename(String) - Method in class org.wickedsource.docxstamper.replace.typeresolver.image.Image

setImageBytes(byte[]) - Method in class org.wickedsource.docxstamper.replace.typeresolver.image.Image

setText(R, String) - Static method in class org.wickedsource.docxstamper.util.RunUtil

Sets the text of the given run to the given value.

stamp(InputStream, T, OutputStream) - Method in class org.wickedsource.docxstamper.DocxStamper

Reads in a .docx template and "stamps" it into the given OutputStream, using the specified context object to fill out any expressions it finds.

stamp(WordprocessingMLPackage, T, OutputStream) - Method in class org.wickedsource.docxstamper.DocxStamper

Same as stamp(InputStream, T, OutputStream) except that you may pass in a DOCX4J document as a template instead of an InputStream.

stripExpression(String) - Method in class org.wickedsource.docxstamper.el.ExpressionUtil

Strips an expression of the leading "${" and the trailing "}".

T

TableCellCoordinates - Class in org.wickedsource.docxstamper.walk.coordinates

TableCellCoordinates(Tc, int, TableRowCoordinates) - Constructor for class org.wickedsource.docxstamper.walk.coordinates.TableCellCoordinates

TableCellUtil - Class in org.wickedsource.docxstamper.util

TableCellUtil() - Constructor for class org.wickedsource.docxstamper.util.TableCellUtil

TableCoordinates - Class in org.wickedsource.docxstamper.walk.coordinates

TableCoordinates(Tbl, int) - Constructor for class org.wickedsource.docxstamper.walk.coordinates.TableCoordinates

TableCoordinates(Tbl, int, TableCellCoordinates) - Constructor for class org.wickedsource.docxstamper.walk.coordinates.TableCoordinates

TableRowCoordinates - Class in org.wickedsource.docxstamper.walk.coordinates

TableRowCoordinates(Tr, int, TableCoordinates) - Constructor for class org.wickedsource.docxstamper.walk.coordinates.TableRowCoordinates

toString() - Method in class org.wickedsource.docxstamper.replace.IndexedRun

toString() - Method in class org.wickedsource.docxstamper.replace.ParagraphWrapper

toString() - Method in class org.wickedsource.docxstamper.walk.coordinates.AbstractCoordinates

toString() - Method in class org.wickedsource.docxstamper.walk.coordinates.ParagraphCoordinates

toString() - Method in class org.wickedsource.docxstamper.walk.coordinates.TableCellCoordinates

toString() - Method in class org.wickedsource.docxstamper.walk.coordinates.TableCoordinates

toString() - Method in class org.wickedsource.docxstamper.walk.coordinates.TableRowCoordinates

TypeResolverRegistry - Class in org.wickedsource.docxstamper.api.typeresolver

Registry for all implementations of ITypeResolver that are used by DocxStamper.

TypeResolverRegistry(ITypeResolver) - Constructor for class org.wickedsource.docxstamper.api.typeresolver.TypeResolverRegistry

W

walk() - Method in class org.wickedsource.docxstamper.walk.coordinates.CoordinatesWalker

walk() - Method in class org.wickedsource.docxstamper.walk.DocumentWalker

A B C D E F G H I M O P R S T W