com.github.jferard.fastods.odselement

Class StylesContainerImpl

java.lang.Object

com.github.jferard.fastods.odselement.StylesContainerImpl

All Implemented Interfaces:

StylesContainer, StylesModeSetter

public class StylesContainerImpl
extends Object
implements StylesContainer

content.xml/office:document-content

Author:

Julien Férard, Martin Schulz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StylesContainerImpl.Dest A destination.

Method Summary

Modifier and Type	Method and Description
TableCellStyle	addChildCellStyle(TableCellStyle style, DataStyle dataStyle) Add a child style that mixes the cell style with a data style to the container
boolean	addContentFontFaceContainerStyle(FontFaceContainerStyle ffcStyle) Add a cell style to the content container and register the font face
boolean	addContentStyle(ObjectStyle objectStyle) Add an object style (style:style) to content.xml/automatic-styles
boolean	addDataStyle(DataStyle dataStyle) Create a new data style into styles container.
boolean	addMasterPageStyle(MasterPageStyle masterPageStyle) Create a new master page style into styles container.
boolean	addNewDataStyleFromCellStyle(TableCellStyle style) Add the data style taken from a cell style
boolean	addPageLayoutStyle(PageLayoutStyle pageLayoutStyle) Add a page layout style
boolean	addPageStyle(PageStyle ps) Add a page style
boolean	addStylesFontFaceContainerStyle(FontFaceContainerStyle ffcStyle) Add a cell style to the content container and register the font face
boolean	addStylesStyle(ObjectStyle objectStyle) Add an object style to styles.xml/automatic-styles
void	debug() Enable debug mode
void	freeze() Freeze the container: no more add is allowed
com.github.jferard.fastods.odselement.HasFooterHeader	hasFooterHeader()
void	setDataStylesMode(Container.Mode mode) Set the new mode to use for data styles
void	setMasterPageStyleMode(Container.Mode mode) Set the new mode to use for master page style
void	setObjectStyleMode(Container.Mode mode) Set the new mode to use for styles in content.xml/automatic-styles, styles.xml/styles and styles.xml/automatic-styles
void	setPageLayoutStyleMode(Container.Mode mode) Set the new mode to use for page layout style
void	setPageStyleMode(Container.Mode mode) Set the new mode to use for page style
void	writeContentAutomaticStyles(XMLUtil util, Appendable appendable) Write the various styles in the automatic styles.
void	writeFontFaceDecls(XMLUtil util, Appendable appendable)
void	writeHiddenDataStyles(XMLUtil util, Appendable appendable) Write the data styles in the automatic-styles.
void	writeMasterPageStyles(XMLUtil util, Appendable appendable) Write master page styles.
void	writePageLayoutStyles(XMLUtil util, Appendable appendable) Write the page layout styles.
void	writeStylesAutomaticStyles(XMLUtil util, Appendable appendable) Write styles to styles.xml/automatic-styles
void	writeStylesCommonStyles(XMLUtil util, Appendable appendable) Write styles to styles.xml/common-styles
void	writeVisibleDataStyles(XMLUtil util, Appendable appendable) Write data styles to styles.xml/common-styles

Methods inherited from class java.lang.Object

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

Method Detail

addChildCellStyle

public TableCellStyle addChildCellStyle(TableCellStyle style,
                                        DataStyle dataStyle)

Description copied from interface: StylesContainer

Add a child style that mixes the cell style with a data style to the container

Specified by:

addChildCellStyle in interface StylesContainer

Parameters:

style - the cell style

dataStyle - the data style

Returns:

the mixed cell style

addContentFontFaceContainerStyle

public boolean addContentFontFaceContainerStyle(FontFaceContainerStyle ffcStyle)

Description copied from interface: StylesContainer

Add a cell style to the content container and register the font face

Specified by:

addContentFontFaceContainerStyle in interface StylesContainer

Parameters:

ffcStyle - the cell style or the text style

Returns:

true if the style was created or updated

addStylesFontFaceContainerStyle

public boolean addStylesFontFaceContainerStyle(FontFaceContainerStyle ffcStyle)

Description copied from interface: StylesContainer

Add a cell style to the content container and register the font face

Specified by:

addStylesFontFaceContainerStyle in interface StylesContainer

Parameters:

ffcStyle - the cell style or the text style

Returns:

true if the style was created or updated

addDataStyle

public boolean addDataStyle(DataStyle dataStyle)

Description copied from interface: StylesContainer

Create a new data style into styles container. No duplicate style name is allowed. Must be used if the table-cell style already exists.

Specified by:

addDataStyle in interface StylesContainer

Parameters:

dataStyle - the data style to add

Returns:

true if the style was added

setDataStylesMode

public void setDataStylesMode(Container.Mode mode)

Description copied from interface: StylesModeSetter

Set the new mode to use for data styles

Specified by:

setDataStylesMode in interface StylesModeSetter

Parameters:

mode - the mode (CREATE, UPDATE, CREATE_OR_UPDATE)

addMasterPageStyle

public boolean addMasterPageStyle(MasterPageStyle masterPageStyle)

Description copied from interface: StylesContainer

Create a new master page style into styles container. No duplicate style name is allowed.

Specified by:

addMasterPageStyle in interface StylesContainer

Parameters:

masterPageStyle - the data style to add

Returns:

true if the style was created

setMasterPageStyleMode

public void setMasterPageStyleMode(Container.Mode mode)

Description copied from interface: StylesModeSetter

Set the new mode to use for master page style

Specified by:

setMasterPageStyleMode in interface StylesModeSetter

Parameters:

mode - the mode (CREATE, UPDATE, CREATE_OR_UPDATE)

addNewDataStyleFromCellStyle

public boolean addNewDataStyleFromCellStyle(TableCellStyle style)

Description copied from interface: StylesContainer

Add the data style taken from a cell style

Specified by:

addNewDataStyleFromCellStyle in interface StylesContainer

Parameters:

style - the cell style

Returns:

true if the style was created

setPageLayoutStyleMode

public void setPageLayoutStyleMode(Container.Mode mode)

Description copied from interface: StylesModeSetter

Set the new mode to use for page layout style

Specified by:

setPageLayoutStyleMode in interface StylesModeSetter

Parameters:

mode - the mode (CREATE, UPDATE, CREATE_OR_UPDATE)

addPageLayoutStyle

public boolean addPageLayoutStyle(PageLayoutStyle pageLayoutStyle)

Description copied from interface: StylesContainer

Add a page layout style

Specified by:

addPageLayoutStyle in interface StylesContainer

Parameters:

pageLayoutStyle - the style

Returns:

true if the style was created or updated

setPageStyleMode

public void setPageStyleMode(Container.Mode mode)

Description copied from interface: StylesModeSetter

Set the new mode to use for page style

Specified by:

setPageStyleMode in interface StylesModeSetter

Parameters:

mode - the mode (CREATE, UPDATE, CREATE_OR_UPDATE)

addPageStyle

public boolean addPageStyle(PageStyle ps)

Description copied from interface: StylesContainer

Add a page style

Specified by:

addPageStyle in interface StylesContainer

Parameters:

ps - the style

Returns:

true if the master page style and the style layout where added

setObjectStyleMode

public void setObjectStyleMode(Container.Mode mode)

Description copied from interface: StylesModeSetter

Set the new mode to use for styles in content.xml/automatic-styles, styles.xml/styles and styles.xml/automatic-styles

Specified by:

setObjectStyleMode in interface StylesModeSetter

Parameters:

mode - the mode (CREATE, UPDATE, CREATE_OR_UPDATE)

addContentStyle

public boolean addContentStyle(ObjectStyle objectStyle)

Description copied from interface: StylesContainer

Add an object style (style:style) to content.xml/automatic-styles

Specified by:

addContentStyle in interface StylesContainer

Parameters:

objectStyle - the style

Returns:

true if the style was created or updated

addStylesStyle

public boolean addStylesStyle(ObjectStyle objectStyle)

Description copied from interface: StylesContainer

Add an object style to styles.xml/automatic-styles

Specified by:

addStylesStyle in interface StylesContainer

Parameters:

objectStyle - the style

Returns:

true if the style was created or updated

debug

public void debug()

Enable debug mode

freeze

public void freeze()

Freeze the container: no more add is allowed

hasFooterHeader

public com.github.jferard.fastods.odselement.HasFooterHeader hasFooterHeader()

Returns:

a "double boolean"

writeContentAutomaticStyles

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

Write the various styles in the automatic styles.

Parameters:

util - an XML util

appendable - the destination

Throws:

IOException - if the styles can't be written

writeHiddenDataStyles

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

Write the data styles in the automatic-styles. They belong to content.xml/automatic-styles

Parameters:

util - an XML util

appendable - the destination

Throws:

IOException - if the styles can't be written

writePageLayoutStyles

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

Write the page layout styles. The page layout will always belong to to styles .xml/automatic-styles, since it's an automatic style (see 16.5) and it is not "used in a document" (3.1.3.2)

Parameters:

util - an util

appendable - the destination

Throws:

IOException - if an I/O error occurs

writeMasterPageStyles

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

Write master page styles. The master page style always belong to to styles .xml/master-styles (3.15.4)

Parameters:

util - an util

appendable - the destination

Throws:

IOException - if an I/O error occurs

writeStylesAutomaticStyles

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

Write styles to styles.xml/automatic-styles

Parameters:

util - an util

appendable - the destination

Throws:

IOException - if an I/O error occurs

writeStylesCommonStyles

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

Write styles to styles.xml/common-styles

Parameters:

util - an util

appendable - the destination

Throws:

IOException - if an I/O error occurs

writeVisibleDataStyles

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

Write data styles to styles.xml/common-styles

Parameters:

util - an util

appendable - the destination

Throws:

IOException - if an I/O error occurs

writeFontFaceDecls

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

Parameters:

util - the util to write XML

appendable - where to write

Throws:

IOException - if the font face declarations were not written