xl
Class HeaderFooter

System.Object
  extended byxl.biff.HeaderFooter
      extended byxl.HeaderFooter

public final class HeaderFooter
extends xl.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(HeaderFooter hf)
          Copy constructor
HeaderFooter(System.String s)
          Constructor used when reading workbooks to separate the left, right a central part of the strings into their constituent parts
 
Method Summary
 void clear()
          Clears the contents of the header/footer
 HeaderFooter.Contents getCenter()
          Accessor for the contents which in the center 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
 System.String toString()
          Retrieves a Stringified version of this object
 
Methods inherited from class System.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

HeaderFooter

public HeaderFooter()
Default constructor.


HeaderFooter

public HeaderFooter(HeaderFooter hf)
Copy constructor

Parameters:
hf - the item to copy

HeaderFooter

public HeaderFooter(System.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
Method Detail

toString

public System.String toString()
Retrieves a Stringified version of this object

Returns:
the header string

getRight

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

Returns:
the right aligned contents

getCenter

public HeaderFooter.Contents getCenter()
Accessor for the contents which in the center 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

clear

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