Top Description Fields Constructors Methods
org.apache.poi.hssf.record

public abstract Class CFHeaderBase

extends StandardRecord
Class Inheritance
Known Direct Subclasses
org.apache.poi.hssf.record.CFHeader12Record, org.apache.poi.hssf.record.CFHeaderRecord
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.ss.util.CellRangeAddress, .CellRangeAddressList, .CellRangeUtil, org.apache.poi.util.GenericRecordUtil, .LittleEndianOutput
Parent of Conditional Formatting Header records, CFHeaderRecord and CFHeader12Record.

Field Summary

Modifier and TypeField and Description
private int
field_1_numcf

private int
field_2_need_recalculation_and_id

private CellRangeAddress
field_3_enclosing_cell_range

private CellRangeAddressList
field_4_cell_ranges

Constructor Summary

AccessConstructor and Description
protected
CFHeaderBase()

protected
CFHeaderBase(CFHeaderBase other)

protected
CFHeaderBase(CellRangeAddress[] regions, int nRules)

Method Summary

Modifier and TypeMethod and Description
public abstract CFHeaderBase
copy()

Redeclares org.apache.poi.common.Duplicatable.copy.

Implements abstract org.apache.poi.hssf.record.StandardRecord.copy.

protected void
createEmpty()

public CellRangeAddress[]
getCellRanges()

protected int
getDataSize()

Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.

public CellRangeAddress
getEnclosingCellRange()

public Map<String, Supplier<?>>
getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

public int
getID()

public boolean
getNeedRecalculation()

public int
getNumberOfConditionalFormats()

protected abstract String
getRecordName()

protected void
read(RecordInputStream in)

public void
serialize(LittleEndianOutput
the output object
out)

Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize.

Write the data content of this BIFF record.

public void
setCellRanges(CellRangeAddress[]
- list of CellRange objects
cellRanges)

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

public void
setEnclosingCellRange(CellRangeAddress cr)

public void
setID(int id)

public void
setNeedRecalculation(boolean b)

public void
setNumberOfConditionalFormats(int n)

Inherited from org.apache.poi.hssf.record.StandardRecord:
getRecordSizeserialize

Field Detail

field_1_numcfback to summary
private int field_1_numcf
field_2_need_recalculation_and_idback to summary
private int field_2_need_recalculation_and_id
field_3_enclosing_cell_rangeback to summary
private CellRangeAddress field_3_enclosing_cell_range
field_4_cell_rangesback to summary
private CellRangeAddressList field_4_cell_ranges

Constructor Detail

CFHeaderBaseback to summary
protected CFHeaderBase()
CFHeaderBaseback to summary
protected CFHeaderBase(CFHeaderBase other)
CFHeaderBaseback to summary
protected CFHeaderBase(CellRangeAddress[] regions, int nRules)

Method Detail

copyback to summary
public abstract CFHeaderBase copy()

Redeclares org.apache.poi.common.Duplicatable.copy.

Implements abstract org.apache.poi.hssf.record.StandardRecord.copy.

Returns:CFHeaderBase

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

Annotations
@Override
createEmptyback to summary
protected void createEmpty()
getCellRangesback to summary
public CellRangeAddress[] getCellRanges()
getDataSizeback to summary
protected int getDataSize()

Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.

getEnclosingCellRangeback to summary
public CellRangeAddress getEnclosingCellRange()
getGenericPropertiesback to summary
public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations
@Override
getIDback to summary
public int getID()
getNeedRecalculationback to summary
public boolean getNeedRecalculation()
getNumberOfConditionalFormatsback to summary
public int getNumberOfConditionalFormats()
getRecordNameback to summary
protected abstract String getRecordName()
readback to summary
protected void read(RecordInputStream in)
serializeback to summary
public void serialize(LittleEndianOutput out)

Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize.

Doc from org.apache.poi.hssf.record.StandardRecord.serialize.

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 org.apache.poi.hssf.record.Record#getRecordSize()} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).

Parameters
out:LittleEndianOutput

the output object

setCellRangesback to summary
public void setCellRanges(CellRangeAddress[] cellRanges)

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

Parameters
cellRanges:CellRangeAddress[]

- list of CellRange objects

setEnclosingCellRangeback to summary
public void setEnclosingCellRange(CellRangeAddress cr)
setIDback to summary
public void setID(int id)
setNeedRecalculationback to summary
public void setNeedRecalculation(boolean b)
setNumberOfConditionalFormatsback to summary
public void setNumberOfConditionalFormats(int n)