Package org.apache.poi.hssf.record
Class CFHeaderBase
- java.lang.Object
-
- org.apache.poi.hssf.record.RecordBase
-
- org.apache.poi.hssf.record.Record
-
- org.apache.poi.hssf.record.StandardRecord
-
- org.apache.poi.hssf.record.CFHeaderBase
-
- All Implemented Interfaces:
java.lang.Cloneable
- Direct Known Subclasses:
CFHeader12Record
,CFHeaderRecord
public abstract class CFHeaderBase extends StandardRecord implements java.lang.Cloneable
Parent of Conditional Formatting Header records,CFHeaderRecord
andCFHeader12Record
.
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
CFHeaderBase()
Creates new CFHeaderBaseprotected
CFHeaderBase(CellRangeAddress[] regions, int nRules)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract CFHeaderBase
clone()
protected void
copyTo(CFHeaderBase result)
protected void
createEmpty()
CellRangeAddress[]
getCellRanges()
protected int
getDataSize()
CellRangeAddress
getEnclosingCellRange()
int
getID()
boolean
getNeedRecalculation()
int
getNumberOfConditionalFormats()
protected abstract java.lang.String
getRecordName()
protected void
read(RecordInputStream in)
void
serialize(LittleEndianOutput out)
Write the data content of this BIFF record.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
setID(int id)
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.StandardRecord
getRecordSize, serialize
-
Methods inherited from class org.apache.poi.hssf.record.Record
cloneViaReserialise, getSid, serialize
-
-
-
-
Constructor Detail
-
CFHeaderBase
protected CFHeaderBase()
Creates new CFHeaderBase
-
CFHeaderBase
protected CFHeaderBase(CellRangeAddress[] regions, int nRules)
-
-
Method Detail
-
createEmpty
protected void createEmpty()
-
read
protected void read(RecordInputStream in)
-
getNumberOfConditionalFormats
public int getNumberOfConditionalFormats()
-
setNumberOfConditionalFormats
public void setNumberOfConditionalFormats(int n)
-
getNeedRecalculation
public boolean getNeedRecalculation()
-
setNeedRecalculation
public void setNeedRecalculation(boolean b)
-
getID
public int getID()
-
setID
public void setID(int id)
-
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:
cellRanges
- - list of CellRange objects
-
getCellRanges
public CellRangeAddress[] getCellRanges()
-
getRecordName
protected abstract java.lang.String getRecordName()
-
toString
public java.lang.String toString()
Description copied from class:Record
get a string representation of the record (for biffview/debugging)
-
getDataSize
protected int getDataSize()
- Specified by:
getDataSize
in classStandardRecord
-
serialize
public void serialize(LittleEndianOutput out)
Description copied from class:StandardRecord
Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields have already been written by the superclass.The number of bytes written must equal the record size reported by
RecordBase.getRecordSize()
} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).- Specified by:
serialize
in classStandardRecord
- Parameters:
out
- the output object
-
copyTo
protected void copyTo(CFHeaderBase result)
-
clone
public abstract CFHeaderBase clone()
-
-