com.github.jferard.fastods

Class PageSection

java.lang.Object

com.github.jferard.fastods.PageSection

All Implemented Interfaces:

ElementWithEmbeddedStyles

public class PageSection
extends Object
implements ElementWithEmbeddedStyles

16.6 style:header-style 16.7 style:footer-style 16.10 style:header 16.11 style:footer

The PageSection class represents the union of a page section content and a page section style. It may be a footer or a header.

Some styles are embedded in the content (e.g. text styles)

Author:

Julien Férard, Martin Schulz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PageSection.Type Footer or Header ?

Method Summary

Modifier and Type	Method and Description
void	addEmbeddedStyles(StylesContainer stylesContainer) Add the styles of this element to the styles container, in styles.xml/automatic-styles.
static void	appendPageSectionStyleXMLToAutomaticStyle(Footer footer, XMLUtil util, Appendable appendable) Secure version of pageSection.appendPageSectionStyleXMLToAutomaticStyle: if the footer (or header) is null, then the default type is used.
static void	appendPageSectionStyleXMLToAutomaticStyle(Header header, XMLUtil util, Appendable appendable) Secure version of pageSection.appendPageSectionStyleXMLToAutomaticStyle: if the footer (or header) is null, then the default type is used.
void	appendPageSectionStyleXMLToAutomaticStyle(XMLUtil util, Appendable appendable, PageSection.Type pageSectionType)
void	appendXMLToMasterStyle(XMLUtil util, Appendable appendable)
static RegionPageSectionBuilder	regionBuilder() Create a builder for a region builder, ie a builder for a footer/header with left, center and right
static SimplePageSectionBuilder	simpleBuilder() Create a builder for a simple builder, ie a builder for a footer/header with only a center region
static Footer	simpleFooter(String text, TextStyle ts) Create a simple footer, with a styled text
static Header	simpleHeader(String text, TextStyle ts) Create a simple header, with a styled text

Methods inherited from class java.lang.Object

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

Method Detail

appendPageSectionStyleXMLToAutomaticStyle

public static void appendPageSectionStyleXMLToAutomaticStyle(Header header,
                                                             XMLUtil util,
                                                             Appendable appendable)
                                                      throws IOException

Secure version of pageSection.appendPageSectionStyleXMLToAutomaticStyle: if the footer (or header) is null, then the default type is used.

Parameters:

header - the footer or header, could be null

util - an util to write XML data

appendable - the object ot which append footer/header style

Throws:

IOException - if footer/header style wasn't appended.

appendPageSectionStyleXMLToAutomaticStyle

public static void appendPageSectionStyleXMLToAutomaticStyle(Footer footer,
                                                             XMLUtil util,
                                                             Appendable appendable)
                                                      throws IOException

Secure version of pageSection.appendPageSectionStyleXMLToAutomaticStyle: if the footer (or header) is null, then the default type is used.

Parameters:

footer - the footer or header, could be null

util - an util to write XML data

appendable - the object ot which append footer/header style

Throws:

IOException - if footer/header style wasn't appended.

regionBuilder

public static RegionPageSectionBuilder regionBuilder()

Create a builder for a region builder, ie a builder for a footer/header with left, center and right

Returns:

the builder

simpleBuilder

public static SimplePageSectionBuilder simpleBuilder()

Create a builder for a simple builder, ie a builder for a footer/header with only a center region

Returns:

the builder

simpleFooter

public static Footer simpleFooter(String text,
                                  TextStyle ts)

Create a simple footer, with a styled text

Parameters:

text - the text

ts - the style

Returns:

the footer

simpleHeader

public static Header simpleHeader(String text,
                                  TextStyle ts)

Create a simple header, with a styled text

Parameters:

text - the text

ts - the style

Returns:

the header

addEmbeddedStyles

public void addEmbeddedStyles(StylesContainer stylesContainer)

Description copied from interface: ElementWithEmbeddedStyles

Add the styles of this element to the styles container, in styles.xml/automatic-styles.

Specified by:

addEmbeddedStyles in interface ElementWithEmbeddedStyles

Parameters:

stylesContainer - the styles container

appendPageSectionStyleXMLToAutomaticStyle

public void appendPageSectionStyleXMLToAutomaticStyle(XMLUtil util,
                                                      Appendable appendable,
                                                      PageSection.Type pageSectionType)
                                               throws IOException

Parameters:

util - an instance of the util class for XML writing

appendable - the appendable element where the method will write the XML

pageSectionType - the type (FOOTER or HEADER)

Throws:

IOException - If an I/O error occurs

appendXMLToMasterStyle

public void appendXMLToMasterStyle(XMLUtil util,
                                   Appendable appendable)
                            throws IOException

Parameters:

util - an instance of the util class for XML writing

appendable - the appendable element where the method will write the XML

Throws:

IOException - If an I/O error occurs