org.apache.poi.hssf.record
Class CFHeaderRecord

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

public final class CFHeaderRecord
extends Record

Conditional Formatting Header record (CFHEADER)

Author:

Dmitriy Kumshayev

Field Summary

static short

sid

Constructor Summary

CFHeaderRecord()
Creates new CFHeaderRecord

CFHeaderRecord(RecordInputStream in)

CFHeaderRecord(Region[] regions)

Method Summary

java.lang.Object	clone()
protected void	fillFields(RecordInputStream in) called by the constructor, should set class level fields.
CellRange[]	getCellRanges()
CellRange	getEnclosingCellRange()
boolean	getNeedRecalculation()
int	getNumberOfConditionalFormats()
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	setCellRanges(CellRange[] cellRanges) Set cell ranges list to a single cell range and modify the enclosing cell range accordingly.
void	setEnclosingCellRange(CellRange cr)
void	setNeedRecalculation(boolean b)
void	setNumberOfConditionalFormats(int n)
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

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

Constructor Detail

CFHeaderRecord

public CFHeaderRecord()

Creates new CFHeaderRecord

CFHeaderRecord

public CFHeaderRecord(Region[] regions)

CFHeaderRecord

public CFHeaderRecord(RecordInputStream in)

Method Detail

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

getNumberOfConditionalFormats

public int getNumberOfConditionalFormats()

setNumberOfConditionalFormats

public void setNumberOfConditionalFormats(int n)

getNeedRecalculation

public boolean getNeedRecalculation()

setNeedRecalculation

public void setNeedRecalculation(boolean b)

getEnclosingCellRange

public CellRange getEnclosingCellRange()

setEnclosingCellRange

public void setEnclosingCellRange(CellRange cr)

setCellRanges

public void setCellRanges(CellRange[] cellRanges)

Set cell ranges list to a single cell range and modify the enclosing cell range accordingly.

Parameters:

List - cellRanges - list of CellRange objects

getCellRanges

public CellRange[] getCellRanges()

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:

byte array containing instance data

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

validateSid

protected void validateSid(short id)

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

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

clone

public java.lang.Object clone()

Overrides:

clone in class Record