org.simpleods

Class Header

java.lang.Object

org.simpleods.Header

public class Header
extends java.lang.Object

Author:

Martin Schulz
Copyright 2008-2013 Martin Schulz
This file Header.java is part of SimpleODS.

Field Summary

Fields

Modifier and Type	Field and Description
static int	FLG_REGION_CENTER The header region in the middle of the page.
static int	FLG_REGION_LEFT The header region on the left page side.
static int	FLG_REGION_RIGHT The header region on the right page side.

Constructor Summary

Constructors

Constructor and Description
Header(OdsFile odsFile) Create a new header object.

Method Summary

Methods

Modifier and Type	Method and Description
void	addPageCount(TextStyle ts, int nFooterRegion, int nParagraph)
void	addPageNumber(TextStyle ts, int nFooterRegion, int nParagraph)
void	addStyledText(TextStyle ts, java.lang.String sText, int nHeaderRegion, int nParagraph) Adds a TextStyle and text to the header region specified by nHeaderRegion.
java.lang.String	getMarginLeft()
java.lang.String	getMarginRight()
java.lang.String	getMarginTop()
java.lang.String	getMinHeight()
void	setMarginLeft(java.lang.String sMarginLeft)
void	setMarginRight(java.lang.String sMarginRight)
void	setMarginTop(java.lang.String sMarginTop)
void	setMinHeight(java.lang.String sMinHeight)

Methods inherited from class java.lang.Object

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

Field Detail

FLG_REGION_LEFT

public static final int FLG_REGION_LEFT

The header region on the left page side.

See Also:

Constant Field Values

FLG_REGION_CENTER

public static final int FLG_REGION_CENTER

The header region in the middle of the page.

See Also:

Constant Field Values

FLG_REGION_RIGHT

public static final int FLG_REGION_RIGHT

The header region on the right page side.

See Also:

Constant Field Values

Constructor Detail

Header

public Header(OdsFile odsFile)

Create a new header object.

Parameters:

odsFile - - The OdsFile to which this header belongs to.

Method Detail

getMinHeight

public java.lang.String getMinHeight()

Returns:

The current minimum height of the header.

setMinHeight

public void setMinHeight(java.lang.String sMinHeight)

getMarginLeft

public java.lang.String getMarginLeft()

Returns:

The current left margin of the header.

setMarginLeft

public void setMarginLeft(java.lang.String sMarginLeft)

getMarginRight

public java.lang.String getMarginRight()

Returns:

The current right margin of the header.

setMarginRight

public void setMarginRight(java.lang.String sMarginRight)

getMarginTop

public java.lang.String getMarginTop()

Returns:

The current top margin of the header.

setMarginTop

public void setMarginTop(java.lang.String sMarginTop)

addStyledText

public void addStyledText(TextStyle ts,
                 java.lang.String sText,
                 int nHeaderRegion,
                 int nParagraph)

Adds a TextStyle and text to the header region specified by nHeaderRegion.
The paragraph to be used is nParagraph.
The text will be shown in the order it was added with this function.

Parameters:

ts - The TextStyle to be used

sText - The string with the text

nHeaderRegion - One of : Header.FLG_REGION_LEFT, Header.FLG_REGION_CENTER or Header.FLG_REGION_RIGHT

nParagraph - The paragraph number to be used

addPageNumber

public void addPageNumber(TextStyle ts,
                 int nFooterRegion,
                 int nParagraph)

addPageCount

public void addPageCount(TextStyle ts,
                int nFooterRegion,
                int nParagraph)