Class DimensionsRecord

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

public class DimensionsRecord extends Record
Title: Dimensions Record

Description: provides the minumum and maximum bounds of a sheet.

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

Version:
2.0-pre
Author:
Andrew C. Oliver (acoliver at apache dot org), Jason Height (jheight at chariot dot net dot au)
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final short
     
  • Constructor Summary

    Constructors
    Constructor
    Description
     
    Constructs a Dimensions record and sets its fields appropriately.
  • Method Summary

    Modifier and Type
    Method
    Description
     
    protected void
    called by the constructor, should set class level fields.
    short
    get the first column number for the sheet
    int
    get the first row number for the sheet
    short
    get the last col number for the sheet
    int
    get the last row number for the sheet
    int
    gives the current serialized size of the record.
    short
    return the non static version of the id for this record.
    int
    serialize(int offset, byte[] data)
    called by the class that is responsible for writing this sucker.
    void
    setFirstCol(short col)
    set the first column number for the sheet
    void
    setFirstRow(int row)
    set the first row number for the sheet
    void
    setLastCol(short col)
    set the last col number for the sheet
    void
    setLastRow(int row)
    set the last row number for the sheet
    get a string representation of the record (for biffview/debugging)
    protected void
    validateSid(short id)
    called by constructor, should throw runtime exception in the event of a record passed with a differing ID.

    Methods inherited from class loci.poi.hssf.record.Record

    isInValueSection, isValue, serialize

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
  • Field Details

  • Constructor Details

    • DimensionsRecord

      public DimensionsRecord()
    • DimensionsRecord

      public DimensionsRecord(RecordInputStream in)
      Constructs a Dimensions 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
    • setFirstRow

      public void setFirstRow(int row)
      set the first row number for the sheet
      Parameters:
      row - - first row on the sheet
    • setLastRow

      public void setLastRow(int row)
      set the last row number for the sheet
      Parameters:
      row - - last row on the sheet
    • setFirstCol

      public void setFirstCol(short col)
      set the first column number for the sheet
      Parameters:
      col - first column on the sheet
    • setLastCol

      public void setLastCol(short col)
      set the last col number for the sheet
      Parameters:
      col - last column on the sheet
    • getFirstRow

      public int getFirstRow()
      get the first row number for the sheet
      Returns:
      row - first row on the sheet
    • getLastRow

      public int getLastRow()
      get the last row number for the sheet
      Returns:
      row - last row on the sheet
    • getFirstCol

      public short getFirstCol()
      get the first column number for the sheet
      Returns:
      column - first column on the sheet
    • getLastCol

      public short getLastCol()
      get the last col number for the sheet
      Returns:
      column - last column on the sheet
    • 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