rst.pdfbox.layout.text

Class TextLine

java.lang.Object

rst.pdfbox.layout.text.TextLine

All Implemented Interfaces:

Iterable<TextFragment>, Area, DrawableText, TextSequence

public class TextLine
extends Object
implements TextSequence

A text of line containing only StyledTexts. It may be terminated by a new line.

Constructor Summary

Constructors

Constructor and Description
TextLine()

Method Summary

Modifier and Type	Method and Description
void	add(StyledText fragment) Adds a styled text.
void	add(TextLine textLine) Adds all styled texts of the given text line.
void	drawAligned(org.apache.pdfbox.pdmodel.PDPageContentStream contentStream, Position upperLeft, Alignment alignment, float availableLineWidth, DrawListener drawListener)
void	drawText(org.apache.pdfbox.pdmodel.PDPageContentStream contentStream, Position upperLeft, Alignment alignment, DrawListener drawListener) Draws the text of the (PdfBox-) cursor position.
protected float	getAscent()
float	getHeight()
NewLine	getNewLine()
List<StyledText>	getStyledTexts()
float	getWidth()
boolean	isEmpty()
Iterator<TextFragment>	iterator()
void	setNewLine(NewLine newLine) Sets the new line.
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

Constructor Detail

TextLine

public TextLine()

Method Detail

add

public void add(StyledText fragment)

Adds a styled text.

Parameters:

fragment - the fagment to add.

add

public void add(TextLine textLine)

Adds all styled texts of the given text line.

Parameters:

textLine - the text line to add.

getNewLine

public NewLine getNewLine()

Returns:

the terminating new line, may be null.

setNewLine

public void setNewLine(NewLine newLine)

Sets the new line.

Parameters:

newLine - the new line.

getStyledTexts

public List<StyledText> getStyledTexts()

Returns:

the styled texts building up this line.

iterator

public Iterator<TextFragment> iterator()

Specified by:

iterator in interface Iterable<TextFragment>

isEmpty

public boolean isEmpty()

Returns:

true if the line contains neither styled text nor a new line.

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

getAscent

protected float getAscent()
                   throws IOException

Returns:

the (max) ascent of this line.

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.

drawAligned

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

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object