rst.pdfbox.layout.elements

Class VerticalSpacer

java.lang.Object

rst.pdfbox.layout.elements.VerticalSpacer

All Implemented Interfaces:

Dividable, Drawable, Element

public class VerticalSpacer
extends Object
implements Drawable, Element, Dividable

A drawable element that occupies some vertical space without any graphical representation.

Nested Class Summary

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

Dividable.Divided

Constructor Summary

Constructors

Constructor and Description
VerticalSpacer(float height) Creates a vertical space with the given height.

Method Summary

Modifier and Type	Method and Description
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.
float	getHeight()
float	getWidth()
Drawable	removeLeadingEmptyVerticalSpace()

Methods inherited from class java.lang.Object

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

Constructor Detail

VerticalSpacer

public VerticalSpacer(float height)

Creates a vertical space with the given height.

Parameters:

height - the height of the space.

Method Detail

getWidth

public float getWidth()
               throws IOException

Specified by:

getWidth in interface Drawable

Returns:

the width of the drawable.

Throws:

IOException - by pdfbox

getHeight

public float getHeight()
                throws IOException

Specified by:

getHeight in interface Drawable

Returns:

the height of the drawable.

Throws:

IOException - by pdfbox

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.

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 Drawable removeLeadingEmptyVerticalSpace()

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.