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

RefreshAllRecord

public class RefreshAllRecord extends Record
Title: Refresh All Record

Description: Flag whether to refresh all external data when loading a sheet. (which hssf doesn't support anyhow so who really cares?)

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

author
Andrew C. Oliver (acoliver at apache dot org)
version
2.0-pre

Fields Summary
public static final short
sid
private short
field_1_refreshall
Constructors Summary
public RefreshAllRecord()


     
    
    
public RefreshAllRecord(RecordInputStream in)
Constructs a RefreshAll record and sets its fields appropriately.

param
id id must be 0x187 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
protected voidfillFields(org.apache.poi.hssf.record.RecordInputStream in)

        field_1_refreshall = in.readShort();
    
public intgetRecordSize()

        return 6;
    
public booleangetRefreshAll()
get whether to refresh all external data when loading a sheet

return
refreshall or not

        return (field_1_refreshall == 1);
    
public shortgetSid()

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

        LittleEndian.putShort(data, 0 + offset, sid);
        LittleEndian.putShort(data, 2 + offset,
                              (( short ) 0x02));   // 2 bytes (6 total)
        LittleEndian.putShort(data, 4 + offset, field_1_refreshall);
        return getRecordSize();
    
public voidsetRefreshAll(boolean refreshall)
set whether to refresh all external data when loading a sheet

param
refreshall or not

        if (refreshall)
        {
            field_1_refreshall = 1;
        }
        else
        {
            field_1_refreshall = 0;
        }
    
public java.lang.StringtoString()

        StringBuffer buffer = new StringBuffer();

        buffer.append("[REFRESHALL]\n");
        buffer.append("    .refreshall      = ").append(getRefreshAll())
            .append("\n");
        buffer.append("[/REFRESHALL]\n");
        return buffer.toString();
    
protected voidvalidateSid(short id)

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