org.apache.poi.hssf.record

Class BookBoolRecord

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

public final class BookBoolRecord
extends StandardRecord

Title: Save External Links record (BookBool)

Description: Contains a flag specifying whether the Gui should save externally linked values from other workbooks.

REFERENCE: PG 289 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 and Description
static short	sid

Constructor Summary

Constructors

Constructor and Description
BookBoolRecord()
BookBoolRecord(RecordInputStream in)

Method Summary

Modifier and Type	Method and Description
protected int	getDataSize()
short	getSaveLinkValues() get the save ext links flag
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	setSaveLinkValues(short flag) set the save ext links flag
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

BookBoolRecord

public BookBoolRecord()

BookBoolRecord

public BookBoolRecord(RecordInputStream in)

Method Detail

setSaveLinkValues

public void setSaveLinkValues(short flag)

set the save ext links flag

Parameters:

flag - flag (0/1 -off/on)

getSaveLinkValues

public short getSaveLinkValues()

get the save ext links 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 consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).

Specified by:

serialize in class StandardRecord

Parameters:

out - the output object

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

Returns:

he id for this record