org.apache.poi.hssf.record
Class FooterRecord

java.lang.Object
  extended by org.apache.poi.hssf.record.RecordBase
      extended by org.apache.poi.hssf.record.Record
          extended by org.apache.poi.hssf.record.StandardRecord
              extended by org.apache.poi.hssf.record.FooterRecord

public final class FooterRecord
extends StandardRecord

Title: Footer Record (0x0015)

Description: Specifies the footer for a sheet

REFERENCE: PG 317 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

Author:
Andrew C. Oliver (acoliver at apache dot org), Shawn Laubach (slaubach at apache dot org) Modified 3/14/02, Jason Height (jheight at chariot dot net dot au)

Field Summary
static short sid
           
 
Constructor Summary
FooterRecord(RecordInputStream in)
           
FooterRecord(java.lang.String text)
           
 
Method Summary
 java.lang.Object clone()
           
protected  int getDataSize()
           
 java.lang.String getFooter()
          get the footer string
 short getSid()
          return the non static version of the id for this record.
 java.lang.String getText()
           
 void serialize(LittleEndianOutput out)
          Write the data content of this BIFF record.
 void setFooter(java.lang.String footer)
          set the footer string
 void setText(java.lang.String text)
          set the footer string
 java.lang.String toString()
          get a string representation of the record (for biffview/debugging)
 
Methods inherited from class org.apache.poi.hssf.record.StandardRecord
getRecordSize, serialize
 
Methods inherited from class org.apache.poi.hssf.record.Record
cloneViaReserialise, serialize
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

sid

public static final short sid
See Also:
Constant Field Values
Constructor Detail

FooterRecord

public FooterRecord(java.lang.String text)

FooterRecord

public FooterRecord(RecordInputStream in)
Method Detail

setFooter

public void setFooter(java.lang.String footer)
set the footer string

Parameters:
footer - string to display

getFooter

public java.lang.String getFooter()
get the footer string

Returns:
footer string to display

toString

public java.lang.String toString()
Description copied from class: Record
get a string representation of the record (for biffview/debugging)

Overrides:
toString in class Record

getSid

public short getSid()
Description copied from class: Record
return the non static version of the id for this record.

Specified by:
getSid in class Record

clone

public java.lang.Object clone()
Overrides:
clone in class Record

setText

public final void setText(java.lang.String text)
set the footer string

Parameters:
text - string to display

getText

public final java.lang.String getText()

serialize

public final void serialize(LittleEndianOutput out)
Description copied from class: StandardRecord
Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields have already been written by the superclass.
The subclass must write the exact number of bytes as reported by Record#getDataSize()

Specified by:
serialize in class StandardRecord

getDataSize

protected final int getDataSize()
Specified by:
getDataSize in class StandardRecord


Copyright 2009 The Apache Software Foundation or its licensors, as applicable.