org.apache.poi.hssf.record
Class CFHeaderRecord

java.lang.Object
  extended by org.apache.poi.hssf.record.RecordBase
      extended by org.apache.poi.hssf.record.Record
          extended by org.apache.poi.hssf.record.CFHeaderRecord

public final class CFHeaderRecord
extends Record

Conditional Formatting Header record CFHEADER (0x1B0)

Author:
Dmitriy Kumshayev

Field Summary
static short sid
           
 
Constructor Summary
CFHeaderRecord()
          Creates new CFHeaderRecord
CFHeaderRecord(CellRangeAddress[] regions, int nRules)
           
CFHeaderRecord(RecordInputStream in)
           
 
Method Summary
 java.lang.Object clone()
           
 CellRangeAddress[] getCellRanges()
           
 CellRangeAddress 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(CellRangeAddress[] cellRanges)
          Set cell ranges list to a single cell range and modify the enclosing cell range accordingly.
 void setEnclosingCellRange(CellRangeAddress cr)
           
 void setNeedRecalculation(boolean b)
           
 void setNumberOfConditionalFormats(int n)
           
 java.lang.String toString()
          get a string representation of the record (for biffview/debugging)
 
Methods inherited from class org.apache.poi.hssf.record.Record
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

CFHeaderRecord

public CFHeaderRecord()
Creates new CFHeaderRecord


CFHeaderRecord

public CFHeaderRecord(CellRangeAddress[] regions,
                      int nRules)

CFHeaderRecord

public CFHeaderRecord(RecordInputStream in)
Method Detail

getNumberOfConditionalFormats

public int getNumberOfConditionalFormats()

setNumberOfConditionalFormats

public void setNumberOfConditionalFormats(int n)

getNeedRecalculation

public boolean getNeedRecalculation()

setNeedRecalculation

public void setNeedRecalculation(boolean b)

getEnclosingCellRange

public CellRangeAddress getEnclosingCellRange()

setEnclosingCellRange

public void setEnclosingCellRange(CellRangeAddress cr)

setCellRanges

public void setCellRanges(CellRangeAddress[] 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 CellRangeAddress[] 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: RecordBase
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 RecordBase
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

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


Copyright 2008 The Apache Software Foundation or its licensors, as applicable.