Class ColumnInfoRecordsAggregate
java.lang.Object
org.apache.poi.hssf.record.RecordBase
org.apache.poi.hssf.record.aggregates.RecordAggregate
org.apache.poi.hssf.record.aggregates.ColumnInfoRecordsAggregate
- All Implemented Interfaces:
Cloneable
- Author:
- Glen Stampoultzis
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.poi.hssf.record.aggregates.RecordAggregate
RecordAggregate.PositionTrackingVisitor, RecordAggregate.RecordVisitor
-
Constructor Summary
ConstructorsConstructorDescriptionCreates an empty aggregate -
Method Summary
Modifier and TypeMethodDescriptionclone()
void
collapseColumn
(int columnIndex) void
expandColumn
(int columnIndex) findColumnInfo
(int columnIndex) Finds the ColumnInfoRecord which contains the specified columnIndexint
int
int
int
getOutlineLevel
(int columnIndex) void
groupColumnRange
(int fromColumnIx, int toColumnIx, boolean indent) Creates an outline group for the specified columns, by setting the level field for each col info record in the range.void
Inserts a column into the aggregate (at the end of the list).void
setColumn
(int targetColumnIx, Short xfIndex, Integer width, Integer level, Boolean hidden, Boolean collapsed) 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
-
ColumnInfoRecordsAggregate
public ColumnInfoRecordsAggregate()Creates an empty aggregate -
ColumnInfoRecordsAggregate
-
-
Method Details
-
clone
-
insertColumn
Inserts a column into the aggregate (at the end of the list). -
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
-
collapseColumn
public void collapseColumn(int columnIndex) -
expandColumn
public void expandColumn(int columnIndex) -
setColumn
-
groupColumnRange
public void groupColumnRange(int fromColumnIx, int toColumnIx, boolean indent) Creates an outline group for the specified columns, by setting the level field for each col info record in the range.ColumnInfoRecord
s may be created, split or merged as a result of this operation.- Parameters:
fromColumnIx
- group from this column (inclusive)toColumnIx
- group to this column (inclusive)indent
- iftrue
the group will be indented by one level, iffalse
indenting will be decreased by one level.
-
findColumnInfo
Finds the ColumnInfoRecord which contains the specified columnIndex- Parameters:
columnIndex
- index of the column (not the index of the ColumnInfoRecord)- Returns:
null
if no column info found for the specified column
-
getMaxOutlineLevel
public int getMaxOutlineLevel() -
getOutlineLevel
public int getOutlineLevel(int columnIndex) -
getMinColumnIndex
public int getMinColumnIndex() -
getMaxColumnIndex
public int getMaxColumnIndex()
-