com.github.jferard.fastods.style

Class PageStyle

java.lang.Object

com.github.jferard.fastods.style.PageStyle

All Implemented Interfaces:

ElementWithEmbeddedStyles, AddableToOdsElements, Hidable

public class PageStyle
extends Object
implements AddableToOdsElements, ElementWithEmbeddedStyles, Hidable

OpenDocument 16.5 style:page-layout OpenDocument 16.9 style:master-page

The PageStyle class represents a combination of a master page style and a page layout style: formatting + header and footer. 16.5 style:page-layout The style:page-layout element represents the styles that specify the formatting properties of a page. 16.9 style:master-page In text and spreadsheet documents, the style:master-page element contains the content of headers and footers.

Author:

Julien Férard, Martin Schulz

Field Summary

Fields

Modifier and Type	Field and Description
static PaperFormat	DEFAULT_FORMAT The default format (A4)
static String	DEFAULT_MASTER_PAGE_NAME The classic default master page name
static PageStyle	DEFAULT_MASTER_PAGE_STYLE The default master page style
static PageStyle	DEFAULT_PAGE_STYLE The default style
static PagePrintOrientation	DEFAULT_PRINT_ORIENTATION The default print orientation (VERTICAL)
static PageWritingMode	DEFAULT_WRITING_MODE The default writing mode (left to right and top to bottom)

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.
void	addToElements(OdsElements odsElements) Add this to OdsElements
void	appendXMLToAutomaticStyle(XMLUtil util, Appendable appendable) Write the XML format for this object.
void	appendXMLToMasterStyle(XMLUtil util, Appendable appendable)
static PageStyleBuilder	builder(String name) Create a new builder
String	getMasterName()
MasterPageStyle	getMasterPageStyle()
PageLayoutStyle	getPageLayoutStyle()
boolean	isHidden()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MASTER_PAGE_NAME

public static final String DEFAULT_MASTER_PAGE_NAME

The classic default master page name

See Also:

Constant Field Values

DEFAULT_FORMAT

public static final PaperFormat DEFAULT_FORMAT

The default format (A4)

DEFAULT_PRINT_ORIENTATION

public static final PagePrintOrientation DEFAULT_PRINT_ORIENTATION

The default print orientation (VERTICAL)

DEFAULT_WRITING_MODE

public static final PageWritingMode DEFAULT_WRITING_MODE

The default writing mode (left to right and top to bottom)

DEFAULT_MASTER_PAGE_STYLE

public static final PageStyle DEFAULT_MASTER_PAGE_STYLE

The default master page style

DEFAULT_PAGE_STYLE

public static final PageStyle DEFAULT_PAGE_STYLE

The default style

Method Detail

builder

public static PageStyleBuilder builder(String name)

Create a new builder

Parameters:

name - the name of the style to build

Returns:

the builder

isHidden

public boolean isHidden()

Specified by:

isHidden in interface Hidable

Returns:

true if the style is automatic

getMasterPageStyle

public MasterPageStyle getMasterPageStyle()

Returns:

the contained master style

getPageLayoutStyle

public PageLayoutStyle getPageLayoutStyle()

Returns:

the contained page layout

getMasterName

public String getMasterName()

Returns:

the name of the contained master style

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

addToElements

public void addToElements(OdsElements odsElements)

Description copied from interface: AddableToOdsElements

Add this to OdsElements

Specified by:

addToElements in interface AddableToOdsElements

Parameters:

odsElements - the OdsElements instance where to add this.

appendXMLToAutomaticStyle

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

Write the XML format for this object.
This is used while writing the ODS file.

Parameters:

util - a util to write XML

appendable - where to write

Throws:

IOException - If an I/O error occurs

appendXMLToMasterStyle

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

Parameters:

util - a util to write XML

appendable - where to write

Throws:

IOException - If an I/O error occurs