rst.pdfbox.layout.text

Class TextFlow

java.lang.Object

rst.pdfbox.layout.text.TextFlow

All Implemented Interfaces:

Iterable<TextFragment>, Area, DrawableText, TextSequence, WidthRespecting

Direct Known Subclasses:

Paragraph

public class TextFlow
extends Object
implements TextSequence, WidthRespecting

A text flow is a text sequence that respects a given width by word wrapping the text. The text may contain line breaks ('\n').
In order to ease creation of styled text, this class supports a kind of markup. The following raw text

 Markup supports *bold*, _italic_, and *even _mixed* markup_.
 

is rendered like this:

 Markup supports bold, italic, and even mixed markup.
 

Use backslash to escape special characters '*', '_' and '\' itself:

 Escape \* with \\\* and \_ with \\\_ in markup.
 

is rendered like this:

 Escape * with \* and _ with \_ in markup.
 

Field Summary

Fields

Modifier and Type	Field and Description
static float	DEFAULT_LINE_SPACING

Constructor Summary

Constructors

Constructor and Description
TextFlow()

Method Summary

Modifier and Type	Method and Description
void	add(TextFragment fragment) Adds a text fragment to this flow.
void	add(TextSequence sequence) Adds a text sequence to this flow.
void	addMarkup(String markup, float fontSize, BaseFont baseFont) Adds some markup to the text flow.
void	addMarkup(String markup, float fontSize, org.apache.pdfbox.pdmodel.font.PDFont plainFont, org.apache.pdfbox.pdmodel.font.PDFont boldFont, org.apache.pdfbox.pdmodel.font.PDFont italicFont, org.apache.pdfbox.pdmodel.font.PDFont boldItalicFont) Adds some markup to the text flow.
void	addText(String text, float fontSize, org.apache.pdfbox.pdmodel.font.PDFont font) Adds some text associated with the font to draw.
protected TextFlow	createInstance()
void	drawText(org.apache.pdfbox.pdmodel.PDPageContentStream contentStream, Position upperLeft, Alignment alignment, DrawListener drawListener) Draws the text of the (PdfBox-) cursor position.
void	drawTextRightAligned(org.apache.pdfbox.pdmodel.PDPageContentStream contentStream, Position endOfFirstLine, DrawListener drawListener)
float	getHeight()
TextFragment	getLast()
float	getLineSpacing()
float	getMaxWidth()
float	getWidth()
boolean	isApplyLineSpacingToFirstLine() Indicates if the line spacing should be applied to the first line.
boolean	isEmpty()
Iterator<TextFragment>	iterator()
TextFragment	removeLast() Removes the last added fragment.
TextFlow	removeLeadingEmptyLines()
void	setApplyLineSpacingToFirstLine(boolean applyLineSpacingToFirstLine) Sets the indicator whether to apply line spacing to the first line.
void	setLineSpacing(float lineSpacing) Sets the factor multiplied with the height to calculate the line spacing.
void	setMaxWidth(float maxWidth) Sets the max width to respect.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

DEFAULT_LINE_SPACING

public static final float DEFAULT_LINE_SPACING

See Also:

Constant Field Values

Constructor Detail

TextFlow

public TextFlow()

Method Detail

addText

public void addText(String text,
                    float fontSize,
                    org.apache.pdfbox.pdmodel.font.PDFont font)
             throws IOException

Adds some text associated with the font to draw. The text may contain line breaks ('\n').

Parameters:

text - the text to add.

fontSize - the size of the font.

font - the font to use to draw the text.

Throws:

IOException - by PDFBox

addMarkup

public void addMarkup(String markup,
                      float fontSize,
                      BaseFont baseFont)
               throws IOException

Adds some markup to the text flow.

Parameters:

markup - the markup to add.

fontSize - the font size to use.

baseFont - the base font describing the bundle of plain/blold/italic/bold-italic fonts.

Throws:

IOException - by PDFBox

addMarkup

public void addMarkup(String markup,
                      float fontSize,
                      org.apache.pdfbox.pdmodel.font.PDFont plainFont,
                      org.apache.pdfbox.pdmodel.font.PDFont boldFont,
                      org.apache.pdfbox.pdmodel.font.PDFont italicFont,
                      org.apache.pdfbox.pdmodel.font.PDFont boldItalicFont)
               throws IOException

Adds some markup to the text flow.

Parameters:

markup - the markup to add.

fontSize - the font size to use.

plainFont - the plain font to use.

boldFont - the bold font to use.

italicFont - the italic font to use.

boldItalicFont - the bold-italic font to use.

Throws:

IOException - by PDFBox

add

public void add(TextSequence sequence)

Adds a text sequence to this flow.

Parameters:

sequence - the sequence to add.

add

public void add(TextFragment fragment)

Adds a text fragment to this flow.

Parameters:

fragment - the fragment to add.

removeLast

public TextFragment removeLast()

Removes the last added fragment.

Returns:

the removed fragment (if any).

getLast

public TextFragment getLast()

Returns:

the last added fragment (if any).

isEmpty

public boolean isEmpty()

Returns:

true if this flow does not contain any fragments.

iterator

public Iterator<TextFragment> iterator()

Specified by:

iterator in interface Iterable<TextFragment>

getMaxWidth

public float getMaxWidth()

Specified by:

getMaxWidth in interface WidthRespecting

Returns:

the max width to respect.

setMaxWidth

public void setMaxWidth(float maxWidth)

Description copied from interface: WidthRespecting

Sets the max width to respect.

Specified by:

setMaxWidth in interface WidthRespecting

Parameters:

maxWidth - the maximum width.

getLineSpacing

public float getLineSpacing()

Returns:

the factor multiplied with the height to calculate the line spacing.

setLineSpacing

public void setLineSpacing(float lineSpacing)

Sets the factor multiplied with the height to calculate the line spacing.

Parameters:

lineSpacing - the line spacing factor.

isApplyLineSpacingToFirstLine

public boolean isApplyLineSpacingToFirstLine()

Indicates if the line spacing should be applied to the first line. Makes sense if there is text above to achieve an equal spacing. In case you want to position the text precisely on top, you may set this value to false. Default is true.

Returns:

true if the line spacing should be applied to the first line.

setApplyLineSpacingToFirstLine

public void setApplyLineSpacingToFirstLine(boolean applyLineSpacingToFirstLine)

Sets the indicator whether to apply line spacing to the first line.

Parameters:

applyLineSpacingToFirstLine - true if the line spacing should be applied to the first line.

See Also:

isApplyLineSpacingToFirstLine()

getWidth

public float getWidth()
               throws IOException

Specified by:

getWidth in interface Area

Returns:

the width of the area.

Throws:

IOException - by pdfbox

getHeight

public float getHeight()
                throws IOException

Specified by:

getHeight in interface Area

Returns:

the height of the area.

Throws:

IOException - by pdfbox

drawText

public void drawText(org.apache.pdfbox.pdmodel.PDPageContentStream contentStream,
                     Position upperLeft,
                     Alignment alignment,
                     DrawListener drawListener)
              throws IOException

Description copied from interface: DrawableText

Draws the text of the (PdfBox-) cursor position.

Specified by:

drawText in interface DrawableText

Parameters:

contentStream - the content stream used to render.

upperLeft - the upper left position to draw to.

alignment - the text alignment.

drawListener - the listener to notify on drawn objects.

Throws:

IOException - by pdfbox.

drawTextRightAligned

public void drawTextRightAligned(org.apache.pdfbox.pdmodel.PDPageContentStream contentStream,
                                 Position endOfFirstLine,
                                 DrawListener drawListener)
                          throws IOException

Throws:

IOException

removeLeadingEmptyLines

public TextFlow removeLeadingEmptyLines()
                                 throws IOException

Returns:

a copy of this text flow where all leading NewLines are removed.

Throws:

IOException - by pdfbox.

createInstance

protected TextFlow createInstance()

toString

public String toString()

Overrides:

toString in class Object