com.github.jferard.fastods.style

Class PageStyleBuilder

java.lang.Object

com.github.jferard.fastods.style.PageStyleBuilder

All Implemented Interfaces:

HidableBuilder<PageStyleBuilder>, StyleBuilder<PageStyle>

public class PageStyleBuilder
extends Object
implements StyleBuilder<PageStyle>, HidableBuilder<PageStyleBuilder>

Author:

Julien Férard

Method Summary

Modifier and Type	Method and Description
PageStyleBuilder	allMargins(Length margin) Set the margin at the top, bottom, left and right. margin is a length value
PageStyleBuilder	backgroundColor(Color color) Set the background color to color, a six-digit hex value.
PageStyle	build()
PageStyleBuilder	centering(PageCentering centering) 20.353 style:table-centering
PageStyleBuilder	footer(Footer footer) Set the footer
PageStyleBuilder	header(Header header) Set the header
PageStyleBuilder	hidden() Make this style hidden, ie part of automatic styles
PageStyleBuilder	marginBottom(Length margin) Set the bottom margin. margin is a length value
PageStyleBuilder	marginLeft(Length margin) Set the left margin. margin is a length value
PageStyleBuilder	marginRight(Length margin) Set the right margin. margin is a length value
PageStyleBuilder	marginTop(Length margin) Set the top margin. margin is a length value
PageStyleBuilder	masterPageStyle(MasterPageStyle masterPageStyle) Set a master page style
PageStyleBuilder	pageHeight(Length pageHeight) Set the page height. pageHeight is a length value.
PageStyleBuilder	pageLayoutStyle(PageLayoutStyle pageLayoutStyle) Set a page layout style
PageStyleBuilder	pageWidth(Length pageWidth) Set the page width. pageWidth is a length value.
PageStyleBuilder	paperFormat(PaperFormat paperFormat) Set the paper format to one of: A3, A4, A5, LETTER, LEGAL, USER USER is automatically used if you use setPageHeight() or setPageWidth().
PageStyleBuilder	printOrientationHorizontal() Set the print orientation to horizontal
PageStyleBuilder	printOrientationVertical() Set the print orientation to vertical
PageStyleBuilder	scaleTo(int percentage) 20.344style:scale-to
PageStyleBuilder	scaleToPages(int pages) 20.345style:scale-to-pages
PageStyleBuilder	scaleToX(int pages) (v1.3) 20.354 style:scale-to-X
PageStyleBuilder	scaleToY(int pages) (v1.3) 20.355 style:scale-to-Y
PageStyleBuilder	writingMode(PageWritingMode writingMode) Set the writing mode to one of: LRTB (left to right; top to bottom), RLTB, TBRL, TBLR, LR, RL, TB, PAGE

Methods inherited from class java.lang.Object

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

Method Detail

build

public PageStyle build()

Specified by:

build in interface StyleBuilder<PageStyle>

Returns:

a new S

allMargins

public PageStyleBuilder allMargins(Length margin)

Set the margin at the top, bottom, left and right. margin is a length value

Parameters:

margin - the length of the margin

Returns:

this for fluent style

backgroundColor

public PageStyleBuilder backgroundColor(Color color)

Set the background color to color, a six-digit hex value. Example: #aa32f0.
The background color may also be set to 'transparent' if a background image is used (currently unsupported).

Parameters:

color - the color as an hexadecimal value

Returns:

this for fluent style

masterPageStyle

public PageStyleBuilder masterPageStyle(MasterPageStyle masterPageStyle)

Set a master page style

Parameters:

masterPageStyle - the style

Returns:

this for fluent style

pageLayoutStyle

public PageStyleBuilder pageLayoutStyle(PageLayoutStyle pageLayoutStyle)

Set a page layout style

Parameters:

pageLayoutStyle - the style

Returns:

this for fluent style

footer

public PageStyleBuilder footer(Footer footer)

Set the footer

Parameters:

footer - the footer

Returns:

this for fluent style

header

public PageStyleBuilder header(Header header)

Set the header

Parameters:

header - the header

Returns:

this for fluent style

marginBottom

public PageStyleBuilder marginBottom(Length margin)

Set the bottom margin. margin is a length value

Parameters:

margin - the length of the margin

Returns:

this for fluent style

marginLeft

public PageStyleBuilder marginLeft(Length margin)

Set the left margin. margin is a length value

Parameters:

margin - the length of the margin

Returns:

this for fluent style

marginRight

public PageStyleBuilder marginRight(Length margin)

Set the right margin. margin is a length value

Parameters:

margin - the length of the margin

Returns:

this for fluent style

marginTop

public PageStyleBuilder marginTop(Length margin)

Set the top margin. margin is a length value

Parameters:

margin - the length of the margin

Returns:

this for fluent style

pageHeight

public PageStyleBuilder pageHeight(Length pageHeight)

Set the page height. pageHeight is a length value. Using this method sets the paper format to PaperFormat.USER

Parameters:

pageHeight - the height of the page

Returns:

this for fluent style

pageWidth

public PageStyleBuilder pageWidth(Length pageWidth)

Set the page width. pageWidth is a length value. Using this method sets the paper format to PaperFormat.USER

Parameters:

pageWidth - the page width

Returns:

this for fluent style

paperFormat

public final PageStyleBuilder paperFormat(PaperFormat paperFormat)

Set the paper format to one of: A3, A4, A5, LETTER, LEGAL, USER USER is automatically used if you use setPageHeight() or setPageWidth().

Parameters:

paperFormat - the format of the page

Returns:

this for fluent style

printOrientationHorizontal

public PageStyleBuilder printOrientationHorizontal()

Set the print orientation to horizontal

Returns:

this for fluent style

printOrientationVertical

public PageStyleBuilder printOrientationVertical()

Set the print orientation to vertical

Returns:

this for fluent style

writingMode

public PageStyleBuilder writingMode(PageWritingMode writingMode)

Set the writing mode to one of: LRTB (left to right; top to bottom), RLTB, TBRL, TBLR, LR, RL, TB, PAGE

Parameters:

writingMode - the writing mode

Returns:

this for fluent style

hidden

public PageStyleBuilder hidden()

Description copied from interface: HidableBuilder

Make this style hidden, ie part of automatic styles

Specified by:

hidden in interface HidableBuilder<PageStyleBuilder>

Returns:

this for fluent style

scaleTo

public PageStyleBuilder scaleTo(int percentage)

20.344style:scale-to

Parameters:

percentage - the percentage value to scale

Returns:

this for fluent style

scaleToPages

public PageStyleBuilder scaleToPages(int pages)

20.345style:scale-to-pages

Parameters:

pages - "the number of pages on which a document should be printed."

Returns:

this for fluent style

scaleToX

public PageStyleBuilder scaleToX(int pages)

(v1.3) 20.354 style:scale-to-X

Parameters:

pages - the number of pages

Returns:

this for fluent style

scaleToY

public PageStyleBuilder scaleToY(int pages)

(v1.3) 20.355 style:scale-to-Y

Parameters:

pages - the number of pages

Returns:

this for fluent style

centering

public PageStyleBuilder centering(PageCentering centering)

20.353 style:table-centering

Parameters:

centering - "specifies whether tables are centered horizontally and/or vertically on the page"

Returns:

this for fluent styles