Package loci.poi.hssf.record
Class RefreshAllRecord
- java.lang.Object
-
- loci.poi.hssf.record.Record
-
- loci.poi.hssf.record.RefreshAllRecord
-
public class RefreshAllRecord extends Record
Title: Refresh All RecordDescription: 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)
- Version:
- 2.0-pre
- Author:
- Andrew C. Oliver (acoliver at apache dot org)
-
-
Field Summary
Fields Modifier and Type Field Description static short
sid
-
Constructor Summary
Constructors Constructor Description RefreshAllRecord()
RefreshAllRecord(RecordInputStream in)
Constructs a RefreshAll record and sets its fields appropriately.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
fillFields(RecordInputStream in)
called by the constructor, should set class level fields.int
getRecordSize()
gives the current serialized size of the record.boolean
getRefreshAll()
get whether to refresh all external data when loading a sheetshort
getSid()
return the non static version of the id for this record.int
serialize(int offset, byte[] data)
called by the class that is responsible for writing this sucker.void
setRefreshAll(boolean refreshall)
set whether to refresh all external data when loading a sheetString
toString()
get a string representation of the record (for biffview/debugging)protected void
validateSid(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
clone, isInValueSection, isValue, serialize
-
-
-
-
Field Detail
-
sid
public static final short sid
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
RefreshAllRecord
public RefreshAllRecord()
-
RefreshAllRecord
public RefreshAllRecord(RecordInputStream in)
Constructs a RefreshAll record and sets its fields appropriately.- Parameters:
in
- the RecordInputstream to read the record from
-
-
Method Detail
-
validateSid
protected void validateSid(short id)
Description copied from class:Record
called by constructor, should throw runtime exception in the event of a record passed with a differing ID.- Specified by:
validateSid
in classRecord
- Parameters:
id
- alleged id for this record
-
fillFields
protected void fillFields(RecordInputStream in)
Description copied from class:Record
called by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.- Specified by:
fillFields
in classRecord
- Parameters:
in
- the RecordInputstream to read the record from
-
setRefreshAll
public void setRefreshAll(boolean refreshall)
set whether to refresh all external data when loading a sheet- Parameters:
refreshall
- or not
-
getRefreshAll
public boolean getRefreshAll()
get whether to refresh all external data when loading a sheet- Returns:
- refreshall or not
-
toString
public String toString()
Description copied from class:Record
get a string representation of the record (for biffview/debugging)
-
serialize
public int serialize(int offset, byte[] data)
Description copied from class:Record
called 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:Record
gives the current serialized size of the record. Should include the sid and reclength (4 bytes).- Overrides:
getRecordSize
in classRecord
-
-