Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.apache.poi.hssf.record
Class IterationRecord

java.lang.Object
  extended by org.apache.poi.hssf.record.RecordBase
      extended by org.apache.poi.hssf.record.Record
          extended by org.apache.poi.hssf.record.StandardRecord
              extended by org.apache.poi.hssf.record.IterationRecord
All Implemented Interfaces:
java.lang.Cloneable
public final class IterationRecord
extends StandardRecord
implements java.lang.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
static short sid
           
 
Constructor Summary
IterationRecord(boolean iterateOn)
           
IterationRecord(RecordInputStream in)
           
 
Method Summary
 IterationRecord clone()
           
protected  int getDataSize()
           
 boolean getIteration()
          get whether or not to iterate for calculations
 short getSid()
          return the non static version of the id for this record.
 void serialize(LittleEndianOutput out)
          Write the data content of this BIFF record.
 void setIteration(boolean iterate)
          set whether or not to iterate for calculations
 java.lang.String toString()
          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
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

sid

public static final short sid
See Also:
Constant Field Values
Constructor Detail

IterationRecord

public IterationRecord(boolean iterateOn)

IterationRecord

public IterationRecord(RecordInputStream in)
Method Detail

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

public java.lang.String toString()
Description copied from class: Record
get a string representation of the record (for biffview/debugging)

Overrides:
toString in class Record

serialize

public void serialize(LittleEndianOutput out)
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 class StandardRecord
Parameters:
out - the output object

getDataSize

protected int getDataSize()
Specified by:
getDataSize in class StandardRecord

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
Returns:
he id for this record

clone

public IterationRecord clone()
Overrides:
clone in class Record
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD