rst.pdfbox.layout.elements

Class PageFormat

java.lang.Object

rst.pdfbox.layout.elements.PageFormat

All Implemented Interfaces:

Element

public class PageFormat
extends Object
implements Element

Defines the size and orientation of a page. The default is A4 portrait without margins.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PageFormat.PageFormatBuilder

Constructor Summary

Constructors

Constructor and Description
PageFormat() Creates a PageFormat with A4 portrait without margins.
PageFormat(org.apache.pdfbox.pdmodel.common.PDRectangle mediaBox) Creates a PageFormat with a given size and orientation portrait.
PageFormat(org.apache.pdfbox.pdmodel.common.PDRectangle mediaBox, Orientation orientation) Creates a PageFormat with a given size and orientation.
PageFormat(org.apache.pdfbox.pdmodel.common.PDRectangle mediaBox, Orientation orientation, float marginLeft, float marginRight, float marginTop, float marginBottom) Creates a Document based on the given media box and margins.
PageFormat(org.apache.pdfbox.pdmodel.common.PDRectangle mediaBox, Orientation orientation, int rotation, float marginLeft, float marginRight, float marginTop, float marginBottom) Creates a Document based on the given media box and margins.

Method Summary

Modifier and Type	Method and Description
float	getMarginBottom()
float	getMarginLeft()
float	getMarginRight()
float	getMarginTop()
org.apache.pdfbox.pdmodel.common.PDRectangle	getMediaBox()
Orientation	getOrientation()
int	getRotation()
static PageFormat.PageFormatBuilder	with()

Methods inherited from class java.lang.Object

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

Constructor Detail

PageFormat

public PageFormat()

Creates a PageFormat with A4 portrait without margins.

PageFormat

public PageFormat(org.apache.pdfbox.pdmodel.common.PDRectangle mediaBox)

Creates a PageFormat with a given size and orientation portrait.

Parameters:

mediaBox - the size.

PageFormat

public PageFormat(org.apache.pdfbox.pdmodel.common.PDRectangle mediaBox,
                  Orientation orientation)

Creates a PageFormat with a given size and orientation.

Parameters:

mediaBox - the size.

orientation - the orientation.

PageFormat

public PageFormat(org.apache.pdfbox.pdmodel.common.PDRectangle mediaBox,
                  Orientation orientation,
                  float marginLeft,
                  float marginRight,
                  float marginTop,
                  float marginBottom)

Creates a Document based on the given media box and margins. By default, a VerticalLayout is used.

Parameters:

mediaBox - the media box to use.

orientation - the orientation to use.

marginLeft - the left margin

marginRight - the right margin

marginTop - the top margin

marginBottom - the bottom margin

PageFormat

public PageFormat(org.apache.pdfbox.pdmodel.common.PDRectangle mediaBox,
                  Orientation orientation,
                  int rotation,
                  float marginLeft,
                  float marginRight,
                  float marginTop,
                  float marginBottom)

Creates a Document based on the given media box and margins. By default, a VerticalLayout is used.

Parameters:

mediaBox - the media box to use.

orientation - the orientation to use.

rotation - the rotation to apply to the page after rendering.

marginLeft - the left margin

marginRight - the right margin

marginTop - the top margin

marginBottom - the bottom margin

Method Detail

getOrientation

public Orientation getOrientation()

Returns:

the orientation to use.

getRotation

public int getRotation()

Returns:

the rotation to apply to the page after rendering.

getMarginLeft

public float getMarginLeft()

Returns:

the left document margin.

getMarginRight

public float getMarginRight()

Returns:

the right document margin.

getMarginTop

public float getMarginTop()

Returns:

the top document margin.

getMarginBottom

public float getMarginBottom()

Returns:

the bottom document margin.

getMediaBox

public org.apache.pdfbox.pdmodel.common.PDRectangle getMediaBox()

Returns:

the media box to use.

with

public static PageFormat.PageFormatBuilder with()

Returns:

a page format builder. The default of the builder is A4 portrait without margins.