org.wickedsource.docxstamper.replace

Class ParagraphWrapper

java.lang.Object

org.wickedsource.docxstamper.replace.ParagraphWrapper

public class ParagraphWrapper
extends Object

A "Run" defines a region of text within a docx document with a common set of properties. Word processors are relatively free in splitting a paragraph of text into multiple runs, so there is no strict rule to say over how many runs a word or a string of words is spread.

This class aggregates multiple runs so they can be treated as a single text, no matter how many runs the text spans. Call addRun() to add all runs that should be aggregated. Then, call methods to modify the aggregated text. Finally, call getText() or getRuns() to get the modified text or the list of modified runs.

Constructor Summary

Constructors

Constructor and Description
ParagraphWrapper(org.docx4j.wml.P paragraph)

Method Summary

Methods

Modifier and Type	Method and Description
int	cleanPlaceholder(String placeholder) 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.
List<org.docx4j.wml.R>	getRuns() Returns the list of runs that are aggregated.
String	getText() Returns the aggregated text over all runs.
void	recalculateRuns()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ParagraphWrapper

public ParagraphWrapper(org.docx4j.wml.P paragraph)

Method Detail

recalculateRuns

public void recalculateRuns()

cleanPlaceholder

public int cleanPlaceholder(String placeholder)

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.

Parameters:

placeholder - the placeholder which is to be removed from the paragraph.

getText

public String getText()

Returns the aggregated text over all runs.

Returns:

the text of all runs.

getRuns

public List<org.docx4j.wml.R> getRuns()

Returns the list of runs that are aggregated. Depending on what modifications were done to the aggregated text this list may not return the same runs that were initially added to the aggregator.

Returns:

the list of aggregated runs.

toString

public String toString()

Overrides:

toString in class Object