rst.pdfbox.layout.elements

Interface Dividable

All Known Implementing Classes:

Cutter, Frame, ImageElement, Paragraph, VerticalSpacer

public interface Dividable

If a drawable is marked as Dividable, it can be (vertically) divided in case it does not fit on the (remaining) page.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Dividable.Divided A container for the result of a divide(float, float) operation.

Method Summary

Modifier and Type	Method and Description
Dividable.Divided	divide(float remainingHeight, float nextPageHeight) Divides the drawable vetically into pieces where the first part is to respect the given remaining height.

Method Detail

divide

Dividable.Divided divide(float remainingHeight,
                         float nextPageHeight)
                  throws IOException

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.

Parameters:

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

nextPageHeight - 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.