org.apache.poi.hssf.record
Class BackupRecord

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

public final class BackupRecord
extends StandardRecord

Title: Backup Record

Description: Boolean specifying whether the GUI should store a backup of the file.

REFERENCE: PG 287 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

static short

sid

Constructor Summary

BackupRecord()

BackupRecord(RecordInputStream in)

Method Summary

short	getBackup() get the backup flag
protected int	getDataSize()
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	setBackup(short backup) set the backup flag (0,1)
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

clone, 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

BackupRecord

public BackupRecord()

BackupRecord

public BackupRecord(RecordInputStream in)

Method Detail

setBackup

public void setBackup(short backup)

set the backup flag (0,1)

Parameters:

backup - backup flag

getBackup

public short getBackup()

get the backup flag

Returns:

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

Specified by:

serialize in class StandardRecord

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