org.apache.poi.hssf.record
Class HeaderRecord

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

public final class HeaderRecord
extends StandardRecord

Title: Header Record

Description: Specifies a header for a sheet

REFERENCE: PG 321 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
HeaderRecord(RecordInputStream in)
           
HeaderRecord(java.lang.String text)
           
 
Method Summary
 java.lang.Object clone()
           
protected  int getDataSize()
           
 java.lang.String getHeader()
          get the header 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 setHeader(java.lang.String header)
          set the header 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

HeaderRecord

public HeaderRecord(java.lang.String text)

HeaderRecord

public HeaderRecord(RecordInputStream in)
Method Detail

setHeader

public void setHeader(java.lang.String header)
set the header string

Parameters:
header - string to display

getHeader

public java.lang.String getHeader()
get the header string

Returns:
header 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.