rst.pdfbox.layout.elements

Class Paragraph

java.lang.Object

rst.pdfbox.layout.text.TextFlow

rst.pdfbox.layout.elements.Paragraph

All Implemented Interfaces:

Iterable<TextFragment>, Dividable, Drawable, Element, Area, DrawableText, TextSequence, WidthRespecting

public class Paragraph
extends TextFlow
implements Drawable, Element, WidthRespecting, Dividable

A paragraph is used as a container for text that is drawn as one element. A paragraph has a (text-) alignment, and respects a given width by applying word-wrap.

Nested Class Summary

Nested classes/interfaces inherited from interface rst.pdfbox.layout.elements.Dividable

Dividable.Divided

Field Summary

Fields inherited from class rst.pdfbox.layout.text.TextFlow

DEFAULT_LINE_SPACING

Constructor Summary

Constructors

Constructor and Description
Paragraph()

Method Summary

Modifier and Type	Method and Description
protected Paragraph	createInstance()
Dividable.Divided	divide(float remainingHeight, float pageHeight) Divides the drawable vetically into pieces where the first part is to respect the given remaining height.
void	draw(org.apache.pdfbox.pdmodel.PDDocument pdDocument, org.apache.pdfbox.pdmodel.PDPageContentStream contentStream, Position upperLeft, DrawListener drawListener) Draws the object at the given position.
Position	getAbsolutePosition() If an absolute position is given, the drawable will be drawn at this position ignoring any Layout.
Alignment	getAlignment()
Paragraph	removeLeadingEmptyLines()
Paragraph	removeLeadingEmptyVerticalSpace()
void	setAbsolutePosition(Position absolutePosition) Sets the absolute position to render at.
void	setAlignment(Alignment alignment) Sets the alignment to apply.

Methods inherited from class rst.pdfbox.layout.text.TextFlow

add, add, addMarkup, addMarkup, addText, drawText, drawTextRightAligned, getHeight, getLast, getLineSpacing, getMaxWidth, getWidth, isApplyLineSpacingToFirstLine, isEmpty, iterator, removeLast, setApplyLineSpacingToFirstLine, setLineSpacing, setMaxWidth, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface rst.pdfbox.layout.elements.Drawable

getHeight, getWidth

Methods inherited from interface rst.pdfbox.layout.text.WidthRespecting

getMaxWidth, setMaxWidth

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Paragraph

public Paragraph()

Method Detail

getAbsolutePosition

public Position getAbsolutePosition()

Description copied from interface: Drawable

If an absolute position is given, the drawable will be drawn at this position ignoring any Layout.

Specified by:

getAbsolutePosition in interface Drawable

Returns:

the absolute position.

setAbsolutePosition

public void setAbsolutePosition(Position absolutePosition)

Sets the absolute position to render at.

Parameters:

absolutePosition - the absolute position.

getAlignment

public Alignment getAlignment()

Returns:

the text alignment to apply. Default is left.

setAlignment

public void setAlignment(Alignment alignment)

Sets the alignment to apply.

Parameters:

alignment - the text alignment.

draw

public void draw(org.apache.pdfbox.pdmodel.PDDocument pdDocument,
                 org.apache.pdfbox.pdmodel.PDPageContentStream contentStream,
                 Position upperLeft,
                 DrawListener drawListener)
          throws IOException

Description copied from interface: Drawable

Draws the object at the given position.

Specified by:

draw in interface Drawable

Parameters:

pdDocument - the underlying pdfbox document.

contentStream - the stream to draw to.

upperLeft - the upper left position to start drawing.

drawListener - the listener to notify on drawn objects.

Throws:

IOException - by pdfbox

divide

public Dividable.Divided divide(float remainingHeight,
                                float pageHeight)
                         throws IOException

Description copied from interface: Dividable

Divides the drawable vetically into pieces where the first part is to respect the given remaining height. The page height allows to make better decisions on how to divide best.

Specified by:

divide in interface Dividable

Parameters:

remainingHeight - the remaining height on the page dictating the height of the first part.

pageHeight - the height of the next page allows to make better decisions on how to divide best, e.g. maybe the element fits completely on the next page.

Returns:

the Divided containing the first part and the tail.

Throws:

IOException - by pdfbox.

removeLeadingEmptyVerticalSpace

public Paragraph removeLeadingEmptyVerticalSpace()
                                          throws IOException

Specified by:

removeLeadingEmptyVerticalSpace in interface Drawable

Returns:

a copy of this drawable where any leading empty vertical space is removed, if possible. This is useful for avoiding leading empty space on a new page.

Throws:

IOException - by pdfbox

removeLeadingEmptyLines

public Paragraph removeLeadingEmptyLines()
                                  throws IOException

Overrides:

removeLeadingEmptyLines in class TextFlow

Returns:

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

Throws:

IOException - by pdfbox.

createInstance

protected Paragraph createInstance()

Overrides:

createInstance in class TextFlow