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()voidcollapseColumn(int columnIndex) voidexpandColumn(int columnIndex) findColumnInfo(int columnIndex) Finds the ColumnInfoRecord which contains the specified columnIndexintintintintgetOutlineLevel(int columnIndex) voidgroupColumnRange(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.voidInserts a column into the aggregate (at the end of the list).voidsetColumn(int targetColumnIx, Short xfIndex, Integer width, Integer level, Boolean hidden, Boolean collapsed) voidVisit each of the atomic BIFF records contained in thisRecordAggregatein 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:RecordAggregateVisit each of the atomic BIFF records contained in thisRecordAggregatein the order that they should be written to file. Implementors may or may not return the actualRecords being used to manage POI's internal implementation. Callers should not assume either way, and therefore only attempt to modify thoseRecords after cloning- Specified by:
visitContainedRecordsin 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.ColumnInfoRecords 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- iftruethe group will be indented by one level, iffalseindenting 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:
nullif 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()
-