org.apache.poi.hssf.record
Class HideObjRecord

java.lang.Object
  |
  +--org.apache.poi.hssf.record.Record
        |
        +--org.apache.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

static short	HIDE_ALL
static short	SHOW_ALL
static short	SHOW_PLACEHOLDERS
static short	sid

Constructor Summary

HideObjRecord()

HideObjRecord(short id, short size, byte[] data)
Constructs an HideObj record and sets its fields appropriately.

HideObjRecord(short id, short size, byte[] data, int offset)
Constructs an HideObj record and sets its fields appropriately.

Method Summary

protected void	fillFields(byte[] data, short size, int offset) 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
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

fillFields, isInValueSection, isValue, processContinueRecord, serialize

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

sid

public static final short sid

HIDE_ALL

public static final short HIDE_ALL

SHOW_PLACEHOLDERS

public static final short SHOW_PLACEHOLDERS

SHOW_ALL

public static final short SHOW_ALL

Constructor Detail

HideObjRecord

public HideObjRecord()

HideObjRecord

public HideObjRecord(short id,
                     short size,
                     byte[] data)

Constructs an HideObj record and sets its fields appropriately.

Parameters:

id - id must be 0x8d or an exception will be throw upon validation

size - the size of the data area of the record

data - data of the record (should not contain sid/len)

HideObjRecord

public HideObjRecord(short id,
                     short size,
                     byte[] data,
                     int offset)

Constructs an HideObj record and sets its fields appropriately.

Parameters:

id - id must be 0x8d or an exception will be throw upon validation

size - the size of the data area of the record

data - data of the record (should not contain sid/len)

offset - of the record's data

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.

Overrides:

validateSid in class Record

Following copied from class: org.apache.poi.hssf.record.Record

Parameters:

id - alleged id for this record

fillFields

protected void fillFields(byte[] data,
                          short size,
                          int offset)

Description copied from class: Record

called by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.

Overrides:

fillFields in class Record

Following copied from class: org.apache.poi.hssf.record.Record

Parameters:

data - raw data

size - size of data

offset - of the record's data (provided a big array of the file)

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

Overrides:

serialize in class Record

Following copied from class: org.apache.poi.hssf.record.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.

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.

Overrides:

getSid in class Record