loci.poi.hssf.record

Class HideObjRecord

java.lang.Object

loci.poi.hssf.record.Record

loci.poi.hssf.record.HideObjRecord

public class HideObjRecord
extends Record

Title: Hide Object Record

Description: flag defines whether to hide placeholders and object

REFERENCE: PG 321 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
private short	field_1_hide_obj
static short	HIDE_ALL
static short	SHOW_ALL
static short	SHOW_PLACEHOLDERS
static short	sid

Constructor Summary

Constructors

Constructor and Description
HideObjRecord()
HideObjRecord(RecordInputStream in) Constructs an HideObj record and sets its fields appropriately.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	fillFields(RecordInputStream in) called by the constructor, should set class level fields.
short	getHideObj() get hide object options
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	setHideObj(short hide) set hide object options
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 loci.poi.hssf.record.Record

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

HIDE_ALL

public static final short HIDE_ALL

See Also:

Constant Field Values

SHOW_PLACEHOLDERS

public static final short SHOW_PLACEHOLDERS

See Also:

Constant Field Values

SHOW_ALL

public static final short SHOW_ALL

See Also:

Constant Field Values

field_1_hide_obj

private short field_1_hide_obj

Constructor Detail

HideObjRecord

public HideObjRecord()

HideObjRecord

public HideObjRecord(RecordInputStream in)

Constructs an HideObj 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

setHideObj

public void setHideObj(short hide)

set hide object options

Parameters:

hide - options

See Also:

HIDE_ALL, SHOW_PLACEHOLDERS, SHOW_ALL

getHideObj

public short getHideObj()

get hide object options

Returns:

hide options

See Also:

HIDE_ALL, SHOW_PLACEHOLDERS, SHOW_ALL

toString

public 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