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

public final Class ConditionalFormattingTable

extends RecordAggregate
Class Inheritance
Imports
java.util.ArrayList, .List, org.apache.poi.hssf.model.RecordStream, org.apache.poi.hssf.record.CFHeaderBase, org.apache.poi.ss.formula.FormulaShifter
Holds all the conditional formatting for a workbook sheet.

See OOO exelfileformat.pdf sec 4.12 'Conditional Formatting Table'

Field Summary

Modifier and TypeField and Description
private final List<CFRecordsAggregate>
_cfHeaders

Constructor Summary

AccessConstructor and Description
public
ConditionalFormattingTable()

Creates an empty ConditionalFormattingTable

public
ConditionalFormattingTable(RecordStream rs)

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

index of the newly added CF header aggregate
add(CFRecordsAggregate cfAggregate)

private void
checkIndex(int index)

public CFRecordsAggregate
get(int index)

public void
remove(int index)

public int
size()

public void
updateFormulasAfterCellShift(FormulaShifter shifter, int externSheetIndex)

public void
visitContainedRecords(RecordAggregate.RecordVisitor
The visitor to use for callbacks while walking this object
rv)

Implements abstract org.apache.poi.hssf.record.aggregates.RecordAggregate.visitContainedRecords.

Visit each of the atomic BIFF records contained in this RecordAggregate in the order that they should be written to file.

Inherited from org.apache.poi.hssf.record.aggregates.RecordAggregate:
getRecordSizeserialize

Field Detail

_cfHeadersback to summary
private final List<CFRecordsAggregate> _cfHeaders

Constructor Detail

ConditionalFormattingTableback to summary
public ConditionalFormattingTable()

Creates an empty ConditionalFormattingTable

ConditionalFormattingTableback to summary
public ConditionalFormattingTable(RecordStream rs)

Method Detail

addback to summary
public int add(CFRecordsAggregate cfAggregate)
Returns:int

index of the newly added CF header aggregate

checkIndexback to summary
private void checkIndex(int index)
getback to summary
public CFRecordsAggregate get(int index)
removeback to summary
public void remove(int index)
sizeback to summary
public int size()
updateFormulasAfterCellShiftback to summary
public void updateFormulasAfterCellShift(FormulaShifter shifter, int externSheetIndex)
visitContainedRecordsback to summary
public void visitContainedRecords(RecordAggregate.RecordVisitor rv)

Implements abstract org.apache.poi.hssf.record.aggregates.RecordAggregate.visitContainedRecords.

Doc from org.apache.poi.hssf.record.aggregates.RecordAggregate.visitContainedRecords.

Visit each of the atomic BIFF records contained in this RecordAggregate in the order that they should be written to file. Implementors may or may not return the actual Records being used to manage POI's internal implementation. Callers should not assume either way, and therefore only attempt to modify those Records after cloning

Parameters
rv:RecordAggregate.RecordVisitor

The visitor to use for callbacks while walking this object

Annotations
@Override