Class HeaderRecord

java.lang.Object
loci.poi.hssf.record.Record
loci.poi.hssf.record.HeaderRecord

public class HeaderRecord extends Record
Title: Header Record

Description: Specifies a header for a sheet

REFERENCE: PG 321 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 Details

  • Constructor Details

    • HeaderRecord

      public HeaderRecord()
    • HeaderRecord

      public HeaderRecord(RecordInputStream in)
      Constructs an Header record and sets its fields appropriately.
      Parameters:
      in - the RecordInputstream to read the record from
  • Method Details

    • validateSid

      protected void validateSid(short id)
      Description copied from class: Record
      called by constructor, should throw runtime exception in the event of a record passed with a differing ID.
      Specified by:
      validateSid in class Record
      Parameters:
      id - alleged id for this record
    • fillFields

      protected void fillFields(RecordInputStream in)
      Description copied from class: Record
      called by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.
      Specified by:
      fillFields in class Record
      Parameters:
      in - the RecordInputstream to read the record from
    • isMultibyte

      public boolean isMultibyte()
      see the unicode flag
      Returns:
      boolean flag true:footer string has at least one multibyte character
    • setHeaderLength

      public void setHeaderLength(byte len)
      set the length of the header string
      Parameters:
      len - length of the header string
      See Also:
    • setHeader

      public void setHeader(String header)
      set the header string
      Parameters:
      header - string to display
      See Also:
    • getHeaderLength

      public short getHeaderLength()
      get the length of the header string
      Returns:
      length of the header string
      See Also:
    • getHeader

      public String getHeader()
      get the header string
      Returns:
      header string to display
      See Also:
    • toString

      public 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: Record
      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 Record
      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 Object clone()
      Overrides:
      clone in class Record