rst.pdfbox.layout.text

Class TextSequenceUtil

java.lang.Object

rst.pdfbox.layout.text.TextSequenceUtil

public class TextSequenceUtil
extends Object

Utility methods for dealing with text sequences.

Constructor Summary

Constructors

Constructor and Description
TextSequenceUtil()

Method Summary

Modifier and Type	Method and Description
protected static TextFragment	deriveFromExisting(TextFragment toDeriveFrom, String text, float leftMargin, float rightMargin) Derive a new TextFragment from an existing one, means use attributes like font, color etc.
static TextFlow	deWrap(TextSequence text) De-wraps the given text, means any new lines introduced by wrapping will be removed.
static Dividable.Divided	divide(TextSequence text, float maxWidth, float maxHeight) Word-wraps and divides the given text sequence.
static void	drawText(TextSequence text, org.apache.pdfbox.pdmodel.PDPageContentStream contentStream, Position upperLeft, DrawListener drawListener, Alignment alignment, float maxWidth, float lineSpacing, boolean applyLineSpacingToFirstLine) Draws the given text sequence to the PDPageContentStream at the given position.
static float	getEmWidth(FontDescriptor fontDescriptor) Returns the width of the character M in the given font.
static float	getHeight(TextSequence textSequence, float maxWidth, float lineSpacing, boolean applyLineSpacingToFirstLine) Calculates the height of the text
static List<TextLine>	getLines(TextSequence text) Dissects the given sequence into TextLines.
static float	getMaxWidth(Iterable<TextLine> lines) Calculates the max width of all text lines.
static float	getOffset(TextSequence textLine, float targetWidth, Alignment alignment) Gets the (left) offset of the line with respect to the target width and alignment.
static float	getStringWidth(String text, FontDescriptor fontDescriptor) Returns the width of the given text in the given font.
static float	getWidth(TextSequence textSequence, float maxWidth) Calculates the width of the text
static TextFlow	splitWords(TextFragment text) Splits the fragment into words.
static TextFlow	wordWrap(TextSequence text, float maxWidth) Word-wraps the given text sequence in order to fit the max width.
static List<TextLine>	wordWrapToLines(TextSequence text, float maxWidth) Convencience function that word-wraps into getLines(TextSequence).

Methods inherited from class java.lang.Object

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

Constructor Detail

TextSequenceUtil

public TextSequenceUtil()

Method Detail

getLines

public static List<TextLine> getLines(TextSequence text)
                               throws IOException

Dissects the given sequence into TextLines.

Parameters:

text - the text to extract the lines from.

Returns:

the list of text lines.

Throws:

IOException - by pdfbox

divide

public static Dividable.Divided divide(TextSequence text,
                                       float maxWidth,
                                       float maxHeight)
                                throws IOException

Word-wraps and divides the given text sequence.

Parameters:

text - the text to divide.

maxWidth - the max width used for word-wrapping.

maxHeight - the max height for divide.

Returns:

the Divided element containing the parts.

Throws:

IOException - by pdfbox

wordWrap

public static TextFlow wordWrap(TextSequence text,
                                float maxWidth)
                         throws IOException

Word-wraps the given text sequence in order to fit the max width.

Parameters:

text - the text to word-wrap.

maxWidth - the max width to fit.

Returns:

the word-wrapped text.

Throws:

IOException - by pdfbox

deWrap

public static TextFlow deWrap(TextSequence text)
                       throws IOException

De-wraps the given text, means any new lines introduced by wrapping will be removed. Also all whitespace removed by wrapping are re-introduced.

Parameters:

text - the text to de-wrap.

Returns:

the de-wrapped text.

Throws:

IOException - by PDFBox

wordWrapToLines

public static List<TextLine> wordWrapToLines(TextSequence text,
                                             float maxWidth)
                                      throws IOException

Convencience function that word-wraps into getLines(TextSequence).

Parameters:

text - the text to word-wrap.

maxWidth - the max width to fit.

Returns:

the word-wrapped text lines.

Throws:

IOException - by pdfbox

splitWords

public static TextFlow splitWords(TextFragment text)

Splits the fragment into words.

Parameters:

text - the text to split.

Returns:

the words as a text flow.

deriveFromExisting

protected static TextFragment deriveFromExisting(TextFragment toDeriveFrom,
                                                 String text,
                                                 float leftMargin,
                                                 float rightMargin)

Derive a new TextFragment from an existing one, means use attributes like font, color etc.

Parameters:

toDeriveFrom - the fragment to derive from.

text - the new text.

leftMargin - the new left margin.

rightMargin - the new right margin.

Returns:

the derived text fragment.

getEmWidth

public static float getEmWidth(FontDescriptor fontDescriptor)
                        throws IOException

Returns the width of the character M in the given font.

Parameters:

fontDescriptor - font and size.

Returns:

the width of M.

Throws:

IOException - by pdfbox

getStringWidth

public static float getStringWidth(String text,
                                   FontDescriptor fontDescriptor)
                            throws IOException

Returns the width of the given text in the given font.

Parameters:

text - the text to measure.

fontDescriptor - font and size.

Returns:

the width of given text.

Throws:

IOException - by pdfbox

drawText

public static void drawText(TextSequence text,
                            org.apache.pdfbox.pdmodel.PDPageContentStream contentStream,
                            Position upperLeft,
                            DrawListener drawListener,
                            Alignment alignment,
                            float maxWidth,
                            float lineSpacing,
                            boolean applyLineSpacingToFirstLine)
                     throws IOException

Draws the given text sequence to the PDPageContentStream at the given position.

Parameters:

text - the text to draw.

contentStream - the stream to draw to

upperLeft - the position of the start of the first line.

drawListener - the listener to notify on drawn objects.

alignment - how to align the text lines.

maxWidth - if > 0, the text may be word-wrapped to match the width.

lineSpacing - the line spacing factor.

applyLineSpacingToFirstLine - indicates if the line spacing should be applied to the first line also. Makes sense in most cases to do so.

Throws:

IOException - by pdfbox

getOffset

public static float getOffset(TextSequence textLine,
                              float targetWidth,
                              Alignment alignment)
                       throws IOException

Gets the (left) offset of the line with respect to the target width and alignment.

Parameters:

textLine - the text

targetWidth - the target width

alignment - the alignment of the line.

Returns:

the left offset.

Throws:

IOException - by pdfbox

getMaxWidth

public static float getMaxWidth(Iterable<TextLine> lines)
                         throws IOException

Calculates the max width of all text lines.

Parameters:

lines - the lines for which to calculate the max width.

Returns:

the max width of the lines.

Throws:

IOException - by pdfbox.

getWidth

public static float getWidth(TextSequence textSequence,
                             float maxWidth)
                      throws IOException

Calculates the width of the text

Parameters:

textSequence - the text.

maxWidth - if > 0, the text may be word-wrapped to match the width.

Returns:

the width of the text.

Throws:

IOException - by pdfbox.

getHeight

public static float getHeight(TextSequence textSequence,
                              float maxWidth,
                              float lineSpacing,
                              boolean applyLineSpacingToFirstLine)
                       throws IOException

Calculates the height of the text

Parameters:

textSequence - the text.

maxWidth - if > 0, the text may be word-wrapped to match the width.

lineSpacing - the line spacing factor.

applyLineSpacingToFirstLine - indicates if the line spacing should be applied to the first line also. Makes sense in most cases to do so.

Returns:

the height of the text.

Throws:

IOException - by pdfbox