org.apache.poi.hssf.record
Class UseSelFSRecord

java.lang.Object
  org.apache.poi.hssf.record.Record
      org.apache.poi.hssf.record.UseSelFSRecord

public class UseSelFSRecord
extends Record

Title: Use Natural Language Formulas Flag

Description: Tells the GUI if this was written by something that can use "natural language" formulas. HSSF can't.

REFERENCE: PG 420 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	FALSE
static short	sid
static short	TRUE

Constructor Summary

UseSelFSRecord()

UseSelFSRecord(RecordInputStream in)
Constructs a UseSelFS record and sets its fields appropriately.

Method Summary

protected void	fillFields(RecordInputStream in) called by the constructor, should set class level fields.
short	getFlag() returns whether we use natural language formulas or not
int	getRecordSize() gives the current serialized size of the record.
short	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	setFlag(short flag) turn the flag on or off
java.lang.String	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 org.apache.poi.hssf.record.Record

clone, cloneViaReserialise, isInValueSection, isValue, 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

TRUE

public static final short TRUE

See Also:

Constant Field Values

FALSE

public static final short FALSE

See Also:

Constant Field Values

Constructor Detail

UseSelFSRecord

public UseSelFSRecord()

UseSelFSRecord

public UseSelFSRecord(RecordInputStream in)

Constructs a UseSelFS 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 class Record

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 class Record

Parameters:

in - the RecordInputstream to read the record from

setFlag

public void setFlag(short flag)

turn the flag on or off

Parameters:

flag - whether to use natural language formulas or not

See Also:

TRUE, FALSE

getFlag

public short getFlag()

returns whether we use natural language formulas or not

Returns:

whether to use natural language formulas or not

See Also:

TRUE, FALSE

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

Specified by:

serialize in class Record

Parameters:

offset - to begin writing at

data - byte array containing instance data

Returns:

number of bytes written

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 class Record

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