Class CalcModeRecord

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

public class CalcModeRecord extends Record
Title: Calc Mode Record

Description: Tells the gui whether to calculate formulas automatically, manually or automatically except for tables.

REFERENCE: PG 292 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)
See Also:
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final short
    automatically calculate formulas (1)
    static final short
    automatically calculate formulas except for tables (-1)
    static final short
    manually calculate formulas (0)
    static final short
     
  • Constructor Summary

    Constructors
    Constructor
    Description
     
    Constructs a CalcModeRecord 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 calc mode flag for formulas
    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
    setCalcMode(short calcmode)
    set the calc mode flag for formulas
    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

    • sid

      public static final short sid
      See Also:
    • MANUAL

      public static final short MANUAL
      manually calculate formulas (0)
      See Also:
    • AUTOMATIC

      public static final short AUTOMATIC
      automatically calculate formulas (1)
      See Also:
    • AUTOMATIC_EXCEPT_TABLES

      public static final short AUTOMATIC_EXCEPT_TABLES
      automatically calculate formulas except for tables (-1)
      See Also:
  • Constructor Details

    • CalcModeRecord

      public CalcModeRecord()
    • CalcModeRecord

      public CalcModeRecord(RecordInputStream in)
      Constructs a CalcModeRecord 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
    • setCalcMode

      public void setCalcMode(short calcmode)
      set the calc mode flag for formulas
      Parameters:
      calcmode - one of the three flags above
      See Also:
    • getCalcMode

      public short getCalcMode()
      get the calc mode flag for formulas
      Returns:
      calcmode one of the three flags above
      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