org.apache.poi.hssf.record.aggregates

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:

Duplicatable

public final class ColumnInfoRecordsAggregate
extends RecordAggregate
implements Duplicatable

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.poi.hssf.record.aggregates.RecordAggregate

RecordAggregate.PositionTrackingVisitor, RecordAggregate.RecordVisitor

Constructor Summary

Constructors

Constructor and Description
ColumnInfoRecordsAggregate() Creates an empty aggregate
ColumnInfoRecordsAggregate(ColumnInfoRecordsAggregate other)
ColumnInfoRecordsAggregate(RecordStream rs)

Method Summary

Modifier and Type	Method and Description
ColumnInfoRecordsAggregate	clone() Deprecated.
void	collapseColumn(int columnIndex)
ColumnInfoRecordsAggregate	copy()
void	expandColumn(int columnIndex)
ColumnInfoRecord	findColumnInfo(int columnIndex) Finds the ColumnInfoRecord which contains the specified columnIndex
int	getMaxColumnIndex()
int	getMaxOutlineLevel()
int	getMinColumnIndex()
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	insertColumn(ColumnInfoRecord col) Inserts a column into the aggregate (at the end of the list).
void	setColumn(int targetColumnIx, java.lang.Short xfIndex, java.lang.Integer width, java.lang.Integer level, java.lang.Boolean hidden, java.lang.Boolean collapsed)
void	visitContainedRecords(RecordAggregate.RecordVisitor rv) Visit each of the atomic BIFF records contained in this RecordAggregate in the order that they should be written to file.

Methods inherited from class org.apache.poi.hssf.record.aggregates.RecordAggregate

getRecordSize, serialize

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ColumnInfoRecordsAggregate

public ColumnInfoRecordsAggregate()

Creates an empty aggregate

ColumnInfoRecordsAggregate

public ColumnInfoRecordsAggregate(ColumnInfoRecordsAggregate other)

ColumnInfoRecordsAggregate

public ColumnInfoRecordsAggregate(RecordStream rs)

Method Detail

clone

@Deprecated
 @Removal(version="5.0.0")
public ColumnInfoRecordsAggregate clone()

Deprecated.

Overrides:

clone in class java.lang.Object

copy

public ColumnInfoRecordsAggregate copy()

Specified by:

copy in interface Duplicatable

Returns:

a deep copy of the implementing class / instance

insertColumn

public void insertColumn(ColumnInfoRecord col)

Inserts a column into the aggregate (at the end of the list).

visitContainedRecords

public void visitContainedRecords(RecordAggregate.RecordVisitor rv)

Description copied from class: RecordAggregate

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

Specified by:

visitContainedRecords in class RecordAggregate

Parameters:

rv - The visitor to use for callbacks while walking this object

collapseColumn

public void collapseColumn(int columnIndex)

expandColumn

public void expandColumn(int columnIndex)

setColumn

public void setColumn(int targetColumnIx,
                      java.lang.Short xfIndex,
                      java.lang.Integer width,
                      java.lang.Integer level,
                      java.lang.Boolean hidden,
                      java.lang.Boolean collapsed)

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 - if true the group will be indented by one level, if false indenting will be decreased by one level.

findColumnInfo

public ColumnInfoRecord findColumnInfo(int columnIndex)

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()