com.github.jferard.fastods

Class PageSectionBuilder<F extends PageSectionBuilder<F>>

java.lang.Object

com.github.jferard.fastods.PageSectionBuilder<F>

Type Parameters:

F - L-bound for the page section builder itself

Direct Known Subclasses:

RegionPageSectionBuilder, SimplePageSectionBuilder

public abstract class PageSectionBuilder<F extends PageSectionBuilder<F>>
extends Object

A builder for a page section. It will build a header or a footer

Author:

Julien Férard

Field Summary

Fields

Modifier and Type	Field and Description
protected Box<Text>	curRegionBox The region box that is currently written
protected MarginsBuilder	marginsBuilder a margins builder
protected Length	minHeight the minimum height of the page section

Method Summary

Modifier and Type	Method and Description
F	allMargins(Length margin) Set the margin at the top, bottom, left and right.
protected abstract PageSection	build() For public calls, see buildFooter or buildHeader
Footer	buildFooter()
Header	buildHeader()
F	content(String string) Set the text content of the section
F	marginBottom(Length margin) Set the bottom margin. margin is a length value
F	marginLeft(Length margin) Set the left margin.
F	marginRight(Length margin) Set the right margin.
F	marginTop(Length margin) Set the top margin.
F	minHeight(Length height) Set the minimum height.
F	styledContent(String text, TextStyle ts)
F	text(Text text)

Methods inherited from class java.lang.Object

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

Field Detail

curRegionBox

protected Box<Text> curRegionBox

The region box that is currently written

marginsBuilder

protected final MarginsBuilder marginsBuilder

a margins builder

minHeight

protected Length minHeight

the minimum height of the page section

Method Detail

allMargins

public F allMargins(Length margin)

Set the margin at the top, bottom, left and right.

Parameters:

margin - the margin size

Returns:

this for fluent style

build

protected abstract PageSection build()

For public calls, see buildFooter or buildHeader

Returns:

the page section

content

public F content(String string)

Set the text content of the section

Parameters:

string - the text

Returns:

this for fluent style

marginBottom

public F marginBottom(Length margin)

Set the bottom margin. margin is a length value

Parameters:

margin - the margin size

Returns:

this for fluent style

marginLeft

public F marginLeft(Length margin)

Set the left margin. Margin is a length value

Parameters:

margin - the margin size

Returns:

this for fluent style

marginRight

public F marginRight(Length margin)

Set the right margin. Margin is a length value

Parameters:

margin - the margin size

Returns:

this for fluent style

marginTop

public F marginTop(Length margin)

Set the top margin. Margin is a length value

Parameters:

margin - the margin size

Returns:

this for fluent style

minHeight

public F minHeight(Length height)

Set the minimum height. Min height is a length value

Parameters:

height - the height of the footer/header

Returns:

this for fluent style

styledContent

public F styledContent(String text,
                       TextStyle ts)

Parameters:

text - The text to write

ts - the text style

Returns:

this for fluent style

text

public F text(Text text)

Parameters:

text - The text to write

Returns:

this for fluent style

buildHeader

public Header buildHeader()

Returns:

the header

buildFooter

public Footer buildFooter()

Returns:

the footer