rst.pdfbox.layout.elements.render

Class ColumnLayout

java.lang.Object

rst.pdfbox.layout.elements.render.VerticalLayout

rst.pdfbox.layout.elements.render.ColumnLayout

All Implemented Interfaces:

Element, Layout, Renderer

public class ColumnLayout
extends VerticalLayout

The column layout divides the page vertically into columns. You can specify the number of columns and the inter-column spacing. The layouting inside a column is similar to the VerticalLayout. See there for more details on the possiblities.

Field Summary

Fields

Modifier and Type	Field and Description
static ControlElement	NEWCOLUMN Triggers flip to the next column.

Fields inherited from class rst.pdfbox.layout.elements.render.VerticalLayout

removeLeadingEmptyVerticalSpace

Constructor Summary

Constructors

Constructor and Description
ColumnLayout(int columnCount)
ColumnLayout(int columnCount, float columnSpacing)

Method Summary

Modifier and Type	Method and Description
protected float	getTargetWidth(RenderContext renderContext)
protected boolean	isPositionTopOfPage(RenderContext renderContext) Indicates if the current position is the top of page.
void	render(RenderContext renderContext, Drawable drawable, LayoutHint layoutHint)
boolean	render(RenderContext renderContext, Element element, LayoutHint layoutHint) Renders an element.
protected void	turnPage(RenderContext renderContext) Flips to the next column

Methods inherited from class rst.pdfbox.layout.elements.render.VerticalLayout

drawReletivePartAndMovePosition, isRemoveLeadingEmptyVerticalSpace, layoutAndDrawReleative, removeLeadingEmptyVerticalSpace, renderAbsolute, renderReleative, setRemoveLeadingEmptyVerticalSpace

Methods inherited from class java.lang.Object

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

Field Detail

NEWCOLUMN

public static final ControlElement NEWCOLUMN

Triggers flip to the next column.

Constructor Detail

ColumnLayout

public ColumnLayout(int columnCount)

ColumnLayout

public ColumnLayout(int columnCount,
                    float columnSpacing)

Method Detail

getTargetWidth

protected float getTargetWidth(RenderContext renderContext)

Overrides:

getTargetWidth in class VerticalLayout

Parameters:

renderContext - the render context.

Returns:

the target width to draw to.

turnPage

protected void turnPage(RenderContext renderContext)
                 throws IOException

Flips to the next column

Overrides:

turnPage in class VerticalLayout

Parameters:

renderContext - the render context.

Throws:

IOException - by pdfbox.

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

Overrides:

render in class VerticalLayout

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

Overrides:

render in class VerticalLayout

Throws:

IOException

isPositionTopOfPage

protected boolean isPositionTopOfPage(RenderContext renderContext)

Description copied from class: VerticalLayout

Indicates if the current position is the top of page.

Overrides:

isPositionTopOfPage in class VerticalLayout

Parameters:

renderContext - the render context.

Returns:

true if the current position is top of page.