org.apache.poi.hssf.record

Class HeaderFooterBase

java.lang.Object

org.apache.poi.hssf.record.RecordBase

org.apache.poi.hssf.record.Record

org.apache.poi.hssf.record.StandardRecord

org.apache.poi.hssf.record.HeaderFooterBase

Direct Known Subclasses:

FooterRecord, HeaderRecord

public abstract class HeaderFooterBase
extends StandardRecord

Common header/footer base class

Method Summary

Modifier and Type	Method and Description
String	getText()
void	serialize(LittleEndianOutput out) Write the data content of this BIFF record.
void	setText(String text) set the footer string

Methods inherited from class org.apache.poi.hssf.record.StandardRecord

getRecordSize, serialize

Methods inherited from class org.apache.poi.hssf.record.Record

clone, cloneViaReserialise, getSid, serialize, toString

Methods inherited from class java.lang.Object

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

Method Detail

setText

public final void setText(String text)

set the footer string

Parameters:

text - string to display

getText

public final 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 number of bytes written must equal the record size reported by RecordBase.getRecordSize()} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).

Parameters:

out - the output object