Package org.apache.poi.hssf.record
Class IterationRecord
java.lang.Object
org.apache.poi.hssf.record.RecordBase
org.apache.poi.hssf.record.Record
org.apache.poi.hssf.record.StandardRecord
org.apache.poi.hssf.record.IterationRecord
- All Implemented Interfaces:
Cloneable
Title: Iteration Record (0x0011)
Description: Tells whether to iterate over formula calculations or not (if a formula is dependent upon another formula's result) (odd feature for something that can only have 32 elements in a formula!)
REFERENCE: PG 325 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
protected int
boolean
get whether or not to iterate for calculationsshort
getSid()
return the non static version of the id for this record.void
Write the data content of this BIFF record.void
setIteration
(boolean iterate) set whether or not to iterate for calculationstoString()
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
-
Field Details
-
sid
public static final short sid- See Also:
-
-
Constructor Details
-
IterationRecord
public IterationRecord(boolean iterateOn) -
IterationRecord
-
-
Method Details
-
setIteration
public void setIteration(boolean iterate) set whether or not to iterate for calculations- Parameters:
iterate
- or not
-
getIteration
public boolean getIteration()get whether or not to iterate for calculations- Returns:
- whether iterative calculations are turned off or on
-
toString
Description copied from class:Record
get a string representation of the record (for biffview/debugging) -
serialize
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 number of bytes written must equal the record size reported by
RecordBase.getRecordSize()
} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).- Specified by:
serialize
in classStandardRecord
- Parameters:
out
- the output object
-
getDataSize
protected int getDataSize()- Specified by:
getDataSize
in classStandardRecord
-
getSid
public short getSid()Description copied from class:Record
return the non static version of the id for this record. -
clone
-