rst.pdfbox.layout.elements.render

Class VerticalLayout

java.lang.Object

rst.pdfbox.layout.elements.render.VerticalLayout

All Implemented Interfaces:

Element, Layout, Renderer

Direct Known Subclasses:

ColumnLayout

public class VerticalLayout
extends Object
implements Layout

Layout implementation that stacks drawables vertically onto the page. If the remaining height on the page is not sufficient for the drawable, it will be divided. Any given VerticalLayoutHint will be taken into account to calculate the position, width, alignment etc.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	removeLeadingEmptyVerticalSpace

Constructor Summary

Constructors

Constructor and Description
VerticalLayout()

Method Summary

Modifier and Type	Method and Description
protected void	drawReletivePartAndMovePosition(RenderContext renderContext, Drawable drawable, LayoutHint layoutHint, boolean movePosition) Actually draws the (drawble) part at the RenderContext.getCurrentPosition() and - depending on flag movePosition - moves to the new Y position.
protected float	getTargetWidth(RenderContext renderContext)
protected boolean	isPositionTopOfPage(RenderContext renderContext) Indicates if the current position is the top of page.
boolean	isRemoveLeadingEmptyVerticalSpace() See Drawable.removeLeadingEmptyVerticalSpace()
protected void	layoutAndDrawReleative(RenderContext renderContext, Drawable drawable, LayoutHint layoutHint) Adjusts the width of the drawable (if it is WidthRespecting), and divides it onto multiple pages if necessary.
protected Drawable	removeLeadingEmptyVerticalSpace(Drawable drawable, RenderContext renderContext) Removes empty space (e.g.
void	render(RenderContext renderContext, Drawable drawable, LayoutHint layoutHint)
boolean	render(RenderContext renderContext, Element element, LayoutHint layoutHint) Renders an element.
protected void	renderAbsolute(RenderContext renderContext, Drawable drawable, LayoutHint layoutHint, Position position) Draws at the given position, ignoring all layouting rules.
protected void	renderReleative(RenderContext renderContext, Drawable drawable, LayoutHint layoutHint) Renders the drawable at the current position.
void	setRemoveLeadingEmptyVerticalSpace(boolean removeLeadingEmptyLines) Indicates if empty space (e.g.
protected void	turnPage(RenderContext renderContext) Turns to the next area, usually a page.

Methods inherited from class java.lang.Object

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

Field Detail

removeLeadingEmptyVerticalSpace

protected boolean removeLeadingEmptyVerticalSpace

Constructor Detail

VerticalLayout

public VerticalLayout()

Method Detail

isRemoveLeadingEmptyVerticalSpace

public boolean isRemoveLeadingEmptyVerticalSpace()

See Drawable.removeLeadingEmptyVerticalSpace()

Returns:

true if empty space (e.g. empty lines) should be removed at the begin of a page.

setRemoveLeadingEmptyVerticalSpace

public void setRemoveLeadingEmptyVerticalSpace(boolean removeLeadingEmptyLines)

Indicates if empty space (e.g. empty lines) should be removed at the begin of a page. See Drawable.removeLeadingEmptyVerticalSpace()

Parameters:

removeLeadingEmptyLines - true if space should be removed.

turnPage

protected void turnPage(RenderContext renderContext)
                 throws IOException

Turns to the next area, usually a page.

Parameters:

renderContext - the render context.

Throws:

IOException - by pdfbox.

getTargetWidth

protected float getTargetWidth(RenderContext renderContext)

Parameters:

renderContext - the render context.

Returns:

the target width to draw to.

render

public boolean render(RenderContext renderContext,
                      Element element,
                      LayoutHint layoutHint)
               throws IOException

Description copied from interface: Renderer

Renders an element.

Specified by:

render in interface Renderer

Parameters:

renderContext - the render context.

element - the element to draw.

layoutHint - the associated layout hint

Returns:

true if the layout is able to render the element.

Throws:

IOException - by pdfbox

render

public void render(RenderContext renderContext,
                   Drawable drawable,
                   LayoutHint layoutHint)
            throws IOException

Throws:

IOException

renderAbsolute

protected void renderAbsolute(RenderContext renderContext,
                              Drawable drawable,
                              LayoutHint layoutHint,
                              Position position)
                       throws IOException

Draws at the given position, ignoring all layouting rules.

Parameters:

renderContext - the context providing all rendering state.

drawable - the drawable to draw.

layoutHint - the layout hint used to layout.

position - the left upper position to start drawing at.

Throws:

IOException - by pdfbox

renderReleative

protected void renderReleative(RenderContext renderContext,
                               Drawable drawable,
                               LayoutHint layoutHint)
                        throws IOException

Renders the drawable at the current position. This method is responsible taking any top or bottom margin described by the (Vertical-)LayoutHint into account. The actual rendering of the drawable is performed by layoutAndDrawReleative(RenderContext, Drawable, LayoutHint).

Parameters:

renderContext - the context providing all rendering state.

drawable - the drawable to draw.

layoutHint - the layout hint used to layout.

Throws:

IOException - by pdfbox

layoutAndDrawReleative

protected void layoutAndDrawReleative(RenderContext renderContext,
                                      Drawable drawable,
                                      LayoutHint layoutHint)
                               throws IOException

Adjusts the width of the drawable (if it is WidthRespecting), and divides it onto multiple pages if necessary. Actual drawing is delegated to drawReletivePartAndMovePosition(RenderContext, Drawable, LayoutHint, boolean) .

Parameters:

renderContext - the context providing all rendering state.

drawable - the drawable to draw.

layoutHint - the layout hint used to layout.

Throws:

IOException - by pdfbox

drawReletivePartAndMovePosition

protected void drawReletivePartAndMovePosition(RenderContext renderContext,
                                               Drawable drawable,
                                               LayoutHint layoutHint,
                                               boolean movePosition)
                                        throws IOException

Actually draws the (drawble) part at the RenderContext.getCurrentPosition() and - depending on flag movePosition - moves to the new Y position. Any left or right margin is taken into account to calculate the position and alignment.

Parameters:

renderContext - the context providing all rendering state.

drawable - the drawable to draw.

layoutHint - the layout hint used to layout.

movePosition - indicates if the position should be moved (vertically) after drawing.

Throws:

IOException - by pdfbox

isPositionTopOfPage

protected boolean isPositionTopOfPage(RenderContext renderContext)

Indicates if the current position is the top of page.

Parameters:

renderContext - the render context.

Returns:

true if the current position is top of page.

removeLeadingEmptyVerticalSpace

protected Drawable removeLeadingEmptyVerticalSpace(Drawable drawable,
                                                   RenderContext renderContext)
                                            throws IOException

Removes empty space (e.g. empty lines) at the begin of a page. See Drawable.removeLeadingEmptyVerticalSpace()

Parameters:

drawable - the drawable to process.

renderContext - the render context.

Returns:

the processed drawable

Throws:

IOException - by pdfbox