FileDocCategorySizeDatePackage
SaveRecalcRecord.javaAPI DocApache Poi 3.0.13607Mon Jan 01 12:39:40 GMT 2007org.apache.poi.hssf.record

SaveRecalcRecord

public class SaveRecalcRecord extends Record
Title: Save Recalc Record

Description: defines whether to recalculate before saving (set to true)

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

author
Andrew C. Oliver (acoliver at apache dot org)
author
Jason Height (jheight at chariot dot net dot au)
version
2.0-pre

Fields Summary
public static final short
sid
private short
field_1_recalc
Constructors Summary
public SaveRecalcRecord()


     
    
    
public SaveRecalcRecord(RecordInputStream in)
Constructs an SaveRecalc record and sets its fields appropriately.

param
id id must be 0x5f or an exception will be throw upon validation
param
size the size of the data area of the record
param
data data of the record (should not contain sid/len)

        super(in);
    
Methods Summary
public java.lang.Objectclone()

      SaveRecalcRecord rec = new SaveRecalcRecord();
      rec.field_1_recalc = field_1_recalc;
      return rec;
    
protected voidfillFields(org.apache.poi.hssf.record.RecordInputStream in)

        field_1_recalc = in.readShort();
    
public booleangetRecalc()
get whether to recalculate formulas/etc before saving or not

return
recalc - whether to recalculate or not

        return (field_1_recalc == 1);
    
public intgetRecordSize()

        return 6;
    
public shortgetSid()

        return sid;
    
public intserialize(int offset, byte[] data)

        LittleEndian.putShort(data, 0 + offset, sid);
        LittleEndian.putShort(data, 2 + offset, ( short ) 0x2);
        LittleEndian.putShort(data, 4 + offset, field_1_recalc);
        return getRecordSize();
    
public voidsetRecalc(boolean recalc)
set whether to recalculate formulas/etc before saving or not

param
recalc - whether to recalculate or not

        field_1_recalc = ( short ) ((recalc == true) ? 1
                                                     : 0);
    
public java.lang.StringtoString()

        StringBuffer buffer = new StringBuffer();

        buffer.append("[SAVERECALC]\n");
        buffer.append("    .recalc         = ").append(getRecalc())
            .append("\n");
        buffer.append("[/SAVERECALC]\n");
        return buffer.toString();
    
protected voidvalidateSid(short id)

        if (id != sid)
        {
            throw new RecordFormatException("NOT A Save Recalc RECORD");
        }