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.FooterRecord

public class FooterRecord
extends Record

Title: Footer Record

Description: Specifies the footer for a sheet

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

Version:
2.0-pre
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()
           
FooterRecord(RecordInputStream in)
           
 
Method Summary
 java.lang.Object clone()
           
 java.lang.String getFooter()
          get the footer string
 short getFooterLength()
          get the length of the footer string
 int getRecordSize()
          gives the current serialized size of the record.
 short getSid()
          return the non static version of the id for this record.
 boolean isMultibyte()
          see the unicode flag
 int serialize(int offset, byte[] data)
          called by the class that is responsible for writing this sucker.
 void setFooter(java.lang.String footer)
          set the footer string
 void setFooterLength(byte len)
          set the length of 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.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()

FooterRecord

public FooterRecord(RecordInputStream in)
Method Detail

isMultibyte

public boolean isMultibyte()
see the unicode flag

Returns:
boolean flag true:footer string has at least one multibyte character

setFooterLength

public void setFooterLength(byte len)
set the length of the footer string

Parameters:
len - length of the footer string
See Also:
setFooter(String)

setFooter

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

Parameters:
footer - string to display
See Also:
setFooterLength(byte)

getFooterLength

public short getFooterLength()
get the length of the footer string

Returns:
length of the footer string
See Also:
getFooter()

getFooter

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

Returns:
footer string to display
See Also:
getFooterLength()

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

serialize

public int serialize(int offset,
                     byte[] data)
Description copied from class: RecordBase
called by the class that is responsible for writing this sucker. Subclasses should implement this so that their data is passed back in a byte array.

Specified by:
serialize in class RecordBase
Parameters:
offset - to begin writing at
data - byte array containing instance data
Returns:
number of bytes written

getRecordSize

public int getRecordSize()
Description copied from class: Record
gives the current serialized size of the record. Should include the sid and reclength (4 bytes).

Overrides:
getRecordSize 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


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