rst.pdfbox.layout.elements

Class PageFormat.PageFormatBuilder

java.lang.Object

rst.pdfbox.layout.elements.PageFormat.PageFormatBuilder

Enclosing class:

PageFormat

public static class PageFormat.PageFormatBuilder
extends Object

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PageFormatBuilder()

Method Summary

Modifier and Type	Method and Description
PageFormat.PageFormatBuilder	A0() Sets the media box to size Constants.A0.
PageFormat.PageFormatBuilder	A1() Sets the media box to size Constants.A1.
PageFormat.PageFormatBuilder	A2() Sets the media box to size Constants.A2.
PageFormat.PageFormatBuilder	A3() Sets the media box to size Constants.A3.
PageFormat.PageFormatBuilder	A4() Sets the media box to size Constants.A4.
PageFormat.PageFormatBuilder	A5() Sets the media box to size Constants.A5.
PageFormat.PageFormatBuilder	A6() Sets the media box to size Constants.A6.
PageFormat	build() Actually builds the PageFormat.
PageFormat.PageFormatBuilder	landscape() Sets the orientation to Orientation.Landscape.
PageFormat.PageFormatBuilder	letter() Sets the media box to size Constants.Letter.
PageFormat.PageFormatBuilder	marginBottom(float marginBottom) Sets the bottom margin.
PageFormat.PageFormatBuilder	marginLeft(float marginLeft) Sets the left margin.
PageFormat.PageFormatBuilder	marginRight(float marginRight) Sets the right margin.
PageFormat.PageFormatBuilder	margins(float marginLeft, float marginRight, float marginTop, float marginBottom) Sets the margins.
PageFormat.PageFormatBuilder	marginTop(float marginTop) Sets the top margin.
PageFormat.PageFormatBuilder	mediaBox(org.apache.pdfbox.pdmodel.common.PDRectangle mediaBox) Sets the media box to the given size.
PageFormat.PageFormatBuilder	orientation(Orientation orientation) Sets the orientation to the given one.
PageFormat.PageFormatBuilder	portrait() Sets the orientation to Orientation.Portrait.
PageFormat.PageFormatBuilder	rotation(int angle) Sets the rotation to apply to the page after rendering.

Methods inherited from class java.lang.Object

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

Constructor Detail

PageFormatBuilder

protected PageFormatBuilder()

Method Detail

build

public PageFormat build()

Actually builds the PageFormat.

Returns:

the resulting PageFormat.

marginLeft

public PageFormat.PageFormatBuilder marginLeft(float marginLeft)

Sets the left margin.

Parameters:

marginLeft - the left margin to use.

Returns:

the builder.

marginRight

public PageFormat.PageFormatBuilder marginRight(float marginRight)

Sets the right margin.

Parameters:

marginRight - the right margin to use.

Returns:

the builder.

marginTop

public PageFormat.PageFormatBuilder marginTop(float marginTop)

Sets the top margin.

Parameters:

marginTop - the top margin to use.

Returns:

the builder.

marginBottom

public PageFormat.PageFormatBuilder marginBottom(float marginBottom)

Sets the bottom margin.

Parameters:

marginBottom - the bottom margin to use.

Returns:

the builder.

margins

public PageFormat.PageFormatBuilder margins(float marginLeft,
                                            float marginRight,
                                            float marginTop,
                                            float marginBottom)

Sets the margins.

Parameters:

marginLeft - the left margin to use.

marginRight - the right margin to use.

marginTop - the top margin to use.

marginBottom - the bottom margin to use.

Returns:

the builder.

mediaBox

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

Sets the media box to the given size.

Parameters:

mediaBox - the media box to use.

Returns:

the builder.

A0

public PageFormat.PageFormatBuilder A0()

Sets the media box to size Constants.A0.

Returns:

the builder.

A1

public PageFormat.PageFormatBuilder A1()

Sets the media box to size Constants.A1.

Returns:

the builder.

A2

public PageFormat.PageFormatBuilder A2()

Sets the media box to size Constants.A2.

Returns:

the builder.

A3

public PageFormat.PageFormatBuilder A3()

Sets the media box to size Constants.A3.

Returns:

the builder.

A4

public PageFormat.PageFormatBuilder A4()

Sets the media box to size Constants.A4.

Returns:

the builder.

A5

public PageFormat.PageFormatBuilder A5()

Sets the media box to size Constants.A5.

Returns:

the builder.

A6

public PageFormat.PageFormatBuilder A6()

Sets the media box to size Constants.A6.

Returns:

the builder.

letter

public PageFormat.PageFormatBuilder letter()

Sets the media box to size Constants.Letter.

Returns:

the builder.

orientation

public PageFormat.PageFormatBuilder orientation(Orientation orientation)

Sets the orientation to the given one.

Parameters:

orientation - the orientation to use.

Returns:

the builder.

portrait

public PageFormat.PageFormatBuilder portrait()

Sets the orientation to Orientation.Portrait.

Returns:

the builder.

landscape

public PageFormat.PageFormatBuilder landscape()

Sets the orientation to Orientation.Landscape.

Returns:

the builder.

rotation

public PageFormat.PageFormatBuilder rotation(int angle)

Sets the rotation to apply to the page after rendering.

Parameters:

angle - the angle to rotate.

Returns:

the builder.