Class CFRecordsAggregate
java.lang.Object
org.apache.poi.hssf.record.RecordBase
org.apache.poi.hssf.record.aggregates.RecordAggregate
org.apache.poi.hssf.record.aggregates.CFRecordsAggregate
CFRecordsAggregate - aggregates Conditional Formatting records CFHeaderRecord and number of up CFRuleRecord records together to simplify access to them.
Note that Excel versions before 2007 can only cope with a maximum of 3 Conditional Formatting rules per sheet. Excel 2007 or newer can cope with unlimited numbers, as can Apache OpenOffice. This is an Excel limitation, not a file format one.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.poi.hssf.record.aggregates.RecordAggregate
RecordAggregate.PositionTrackingVisitor, RecordAggregate.RecordVisitor
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Create a deep clone of the recordstatic CFRecordsAggregate
Create CFRecordsAggregate from a list of CF Recordsint
getRule
(int idx) void
setRule
(int idx, CFRuleBase r) toString()
String representation of CFRecordsAggregateboolean
updateFormulasAfterCellShift
(FormulaShifter shifter, int currentExternSheetIx) void
Visit each of the atomic BIFF records contained in thisRecordAggregate
in the order that they should be written to file.Methods inherited from class org.apache.poi.hssf.record.aggregates.RecordAggregate
getRecordSize, serialize
-
Constructor Details
-
CFRecordsAggregate
-
-
Method Details
-
createCFAggregate
Create CFRecordsAggregate from a list of CF Records- Parameters:
rs
- - the stream to read from- Returns:
- CFRecordsAggregate object
-
cloneCFAggregate
Create a deep clone of the record -
getHeader
- Returns:
- the header. Never
null
.
-
getRule
-
setRule
-
addRule
-
getNumberOfRules
public int getNumberOfRules() -
toString
String representation of CFRecordsAggregate -
visitContainedRecords
Description copied from class:RecordAggregate
Visit each of the atomic BIFF records contained in thisRecordAggregate
in the order that they should be written to file. Implementors may or may not return the actualRecord
s being used to manage POI's internal implementation. Callers should not assume either way, and therefore only attempt to modify thoseRecord
s after cloning- Specified by:
visitContainedRecords
in classRecordAggregate
-
updateFormulasAfterCellShift
- Returns:
false
if this wholeCFHeaderRecord
/CFRuleRecord
s should be deleted
-