rst.pdfbox.layout.elements.render

Class VerticalLayoutHint

java.lang.Object

rst.pdfbox.layout.elements.render.VerticalLayoutHint

All Implemented Interfaces:

LayoutHint

Direct Known Subclasses:

ColumnLayoutHint

public class VerticalLayoutHint
extends Object
implements LayoutHint

Layout hint for the VerticalLayout. You may specify margins to define some extra space around the drawable. If there is still some extra space available vertically, the alignment decides where to position the drawable. The reset Y indicates if the Y postion should be reset to the value before drawing. Be aware that this only applies to the current page where the remainder of the element has been drawn to. Means, if the elemenent spawns multiple pages, the position is reset to the begin of the last page.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VerticalLayoutHint.VerticalLayoutHintBuilder A builder for creating a VerticalLayoutHint using a fluent API.

Field Summary

Fields

Modifier and Type	Field and Description
static VerticalLayoutHint	CENTER
static VerticalLayoutHint	LEFT
static VerticalLayoutHint	RIGHT

Constructor Summary

Constructors

Constructor and Description
VerticalLayoutHint() Creates a layout hint with left alignment.
VerticalLayoutHint(Alignment alignment) Creates a layout hint with the given alignment.
VerticalLayoutHint(Alignment alignment, float marginLeft, float marginRight, float marginTop, float marginBottom) Creates a layout hint with the given alignment and margins.
VerticalLayoutHint(Alignment alignment, float marginLeft, float marginRight, float marginTop, float marginBottom, boolean resetY) Creates a layout hint with the given alignment and margins.

Method Summary

Modifier and Type	Method and Description
static VerticalLayoutHint.VerticalLayoutHintBuilder	builder()
Alignment	getAlignment()
float	getMarginBottom()
float	getMarginLeft()
float	getMarginRight()
float	getMarginTop()
boolean	isResetY()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

LEFT

public static final VerticalLayoutHint LEFT

CENTER

public static final VerticalLayoutHint CENTER

RIGHT

public static final VerticalLayoutHint RIGHT

Constructor Detail

VerticalLayoutHint

public VerticalLayoutHint()

Creates a layout hint with left alignment.

VerticalLayoutHint

public VerticalLayoutHint(Alignment alignment)

Creates a layout hint with the given alignment.

Parameters:

alignment - the element alignment.

VerticalLayoutHint

public VerticalLayoutHint(Alignment alignment,
                          float marginLeft,
                          float marginRight,
                          float marginTop,
                          float marginBottom)

Creates a layout hint with the given alignment and margins.

Parameters:

alignment - the element alignment.

marginLeft - the left alignment.

marginRight - the right alignment.

marginTop - the top alignment.

marginBottom - the bottom alignment.

VerticalLayoutHint

public VerticalLayoutHint(Alignment alignment,
                          float marginLeft,
                          float marginRight,
                          float marginTop,
                          float marginBottom,
                          boolean resetY)

Creates a layout hint with the given alignment and margins.

Parameters:

alignment - the element alignment.

marginLeft - the left alignment.

marginRight - the right alignment.

marginTop - the top alignment.

marginBottom - the bottom alignment.

resetY - if true, the y coordinate will be reset to the point before layouting the element.

Method Detail

getAlignment

public Alignment getAlignment()

getMarginLeft

public float getMarginLeft()

getMarginRight

public float getMarginRight()

getMarginTop

public float getMarginTop()

getMarginBottom

public float getMarginBottom()

isResetY

public boolean isResetY()

toString

public String toString()

Overrides:

toString in class Object

builder

public static VerticalLayoutHint.VerticalLayoutHintBuilder builder()

Returns:

a VerticalLayoutHint.VerticalLayoutHintBuilder for creating a VerticalLayoutHint using a fluent API.