org.apache.poi.hssf.record

Class RefreshAllRecord

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.RefreshAllRecord

public final class RefreshAllRecord
extends StandardRecord

Title: Refresh All Record (0x01B7)

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)

Field Summary

Fields

Modifier and Type	Field and Description
static short	sid

Constructor Summary

Constructors

Constructor and Description
RefreshAllRecord(boolean refreshAll)
RefreshAllRecord(RecordInputStream in)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone()
boolean	getRefreshAll() get whether to refresh all external data when loading a sheet
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	setRefreshAll(boolean refreshAll) set whether to refresh all external data when loading a sheet
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, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

sid

public static final short sid

See Also:

Constant Field Values

Constructor Detail

RefreshAllRecord

public RefreshAllRecord(RecordInputStream in)

RefreshAllRecord

public RefreshAllRecord(boolean refreshAll)

Method Detail

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 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 consiting of a 'ushort sid' and 'ushort reclength' has already been written by thye superclass).

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

clone

public java.lang.Object clone()

Overrides:

clone in class Record