Package loci.poi.hssf.record
Class CalcModeRecord
java.lang.Object
loci.poi.hssf.record.Record
loci.poi.hssf.record.CalcModeRecord
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
FieldsModifier and TypeFieldDescriptionstatic final shortautomatically calculate formulas (1)static final shortautomatically calculate formulas except for tables (-1)static final shortmanually calculate formulas (0)static final short -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a CalcModeRecord and sets its fields appropriately -
Method Summary
Modifier and TypeMethodDescriptionclone()protected voidcalled by the constructor, should set class level fields.shortget the calc mode flag for formulasintgives the current serialized size of the record.shortgetSid()return the non static version of the id for this record.intserialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.voidsetCalcMode(short calcmode) set the calc mode flag for formulastoString()get a string representation of the record (for biffview/debugging)protected voidvalidateSid(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
-
Field Details
-
sid
public static final short sid- See Also:
-
MANUAL
public static final short MANUALmanually calculate formulas (0)- See Also:
-
AUTOMATIC
public static final short AUTOMATICautomatically calculate formulas (1)- See Also:
-
AUTOMATIC_EXCEPT_TABLES
public static final short AUTOMATIC_EXCEPT_TABLESautomatically calculate formulas except for tables (-1)- See Also:
-
-
Constructor Details
-
CalcModeRecord
public CalcModeRecord() -
CalcModeRecord
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:Recordcalled by constructor, should throw runtime exception in the event of a record passed with a differing ID.- Specified by:
validateSidin classRecord- Parameters:
id- alleged id for this record
-
fillFields
Description copied from class:Recordcalled by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.- Specified by:
fillFieldsin classRecord- 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
Description copied from class:Recordget a string representation of the record (for biffview/debugging) -
serialize
public int serialize(int offset, byte[] data) Description copied from class:Recordcalled 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. -
getRecordSize
public int getRecordSize()Description copied from class:Recordgives the current serialized size of the record. Should include the sid and reclength (4 bytes).- Overrides:
getRecordSizein classRecord
-
getSid
public short getSid()Description copied from class:Recordreturn the non static version of the id for this record. -
clone
-