jxl

Class HeaderFooter


public final class HeaderFooter
extends jxl.biff.HeaderFooter

Class which represents an Excel header or footer.

Nested Class Summary

static class
HeaderFooter.Contents
The contents - a simple wrapper around a string buffer

Constructor Summary

HeaderFooter()
Default constructor.
HeaderFooter(String s)
Constructor used when reading workbooks to separate the left, right a central part of the strings into their constituent parts
HeaderFooter(HeaderFooter hf)
Copy constructor

Method Summary

void
clear()
Clears the contents of the header/footer
HeaderFooter.Contents
getCentre()
Accessor for the contents which in the centre of the page
HeaderFooter.Contents
getLeft()
Accessor for the contents which appear on the left hand side of the page
HeaderFooter.Contents
getRight()
Accessor for the contents which appear on the right hand side of the page
String
toString()
Retrieves a Stringified version of this object

Constructor Details

HeaderFooter

public HeaderFooter()
Default constructor.

HeaderFooter

public HeaderFooter(String s)
Constructor used when reading workbooks to separate the left, right a central part of the strings into their constituent parts
Parameters:
s - the header string

HeaderFooter

public HeaderFooter(HeaderFooter hf)
Copy constructor
Parameters:
hf - the item to copy

Method Details

clear

public void clear()
Clears the contents of the header/footer

getCentre

public HeaderFooter.Contents getCentre()
Accessor for the contents which in the centre of the page
Returns:
the centrally aligned contents

getLeft

public HeaderFooter.Contents getLeft()
Accessor for the contents which appear on the left hand side of the page
Returns:
the left aligned contents

getRight

public HeaderFooter.Contents getRight()
Accessor for the contents which appear on the right hand side of the page
Returns:
the right aligned contents

toString

public String toString()
Retrieves a Stringified version of this object
Returns:
the header string