Package org.apache.poi.hssf.record
Class ColumnInfoRecord
- java.lang.Object
-
- org.apache.poi.hssf.record.RecordBase
-
- org.apache.poi.hssf.record.Record
-
- org.apache.poi.hssf.record.StandardRecord
-
- org.apache.poi.hssf.record.ColumnInfoRecord
-
- All Implemented Interfaces:
org.apache.poi.common.Duplicatable
,GenericRecord
public final class ColumnInfoRecord extends StandardRecord
Defines with width and formatting for a range of columns
-
-
Field Summary
Fields Modifier and Type Field Description static short
sid
-
Constructor Summary
Constructors Constructor Description ColumnInfoRecord()
Creates a column info record with default width and formatColumnInfoRecord(ColumnInfoRecord other)
ColumnInfoRecord(RecordInputStream in)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
containsColumn(int columnIndex)
ColumnInfoRecord
copy()
boolean
formatMatches(ColumnInfoRecord other)
boolean
getCollapsed()
int
getColumnWidth()
int
getFirstColumn()
get the first column this record defines formatting info forjava.util.Map<java.lang.String,java.util.function.Supplier<?>>
getGenericProperties()
HSSFRecordTypes
getGenericRecordType()
boolean
getHidden()
int
getLastColumn()
get the last column this record defines formatting info forint
getOutlineLevel()
short
getSid()
return the non static version of the id for this record.int
getXFIndex()
get the columns' default format infoboolean
isAdjacentBefore(ColumnInfoRecord other)
void
serialize(LittleEndianOutput out)
void
setCollapsed(boolean isCollapsed)
set whether the cells are collapsedvoid
setColumnWidth(int cw)
set the columns' width in 1/256 of a character widthvoid
setFirstColumn(int fc)
set the first column this record defines formatting info forvoid
setHidden(boolean ishidden)
set whether or not these cells are hiddenvoid
setLastColumn(int lc)
set the last column this record defines formatting info forvoid
setOutlineLevel(int olevel)
set the outline level for the cellsvoid
setXFIndex(int xfi)
set the columns' default format info-
Methods inherited from class org.apache.poi.hssf.record.StandardRecord
getRecordSize, serialize
-
Methods inherited from class org.apache.poi.hssf.record.Record
cloneViaReserialise, serialize, toString
-
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.apache.poi.common.usermodel.GenericRecord
getGenericChildren
-
-
-
-
Field Detail
-
sid
public static final short sid
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ColumnInfoRecord
public ColumnInfoRecord()
Creates a column info record with default width and format
-
ColumnInfoRecord
public ColumnInfoRecord(ColumnInfoRecord other)
-
ColumnInfoRecord
public ColumnInfoRecord(RecordInputStream in)
-
-
Method Detail
-
setFirstColumn
public void setFirstColumn(int fc)
set the first column this record defines formatting info for- Parameters:
fc
- - the first column index (0-based)
-
setLastColumn
public void setLastColumn(int lc)
set the last column this record defines formatting info for- Parameters:
lc
- - the last column index (0-based)
-
setColumnWidth
public void setColumnWidth(int cw)
set the columns' width in 1/256 of a character width- Parameters:
cw
- - column width
-
setXFIndex
public void setXFIndex(int xfi)
set the columns' default format info- Parameters:
xfi
- - the extended format index- See Also:
ExtendedFormatRecord
-
setHidden
public void setHidden(boolean ishidden)
set whether or not these cells are hidden- Parameters:
ishidden
- - whether the cells are hidden.
-
setOutlineLevel
public void setOutlineLevel(int olevel)
set the outline level for the cells- Parameters:
olevel
- -outline level for the cells
-
setCollapsed
public void setCollapsed(boolean isCollapsed)
set whether the cells are collapsed- Parameters:
isCollapsed
- - whether the cells are collapsed
-
getFirstColumn
public int getFirstColumn()
get the first column this record defines formatting info for- Returns:
- the first column index (0-based)
-
getLastColumn
public int getLastColumn()
get the last column this record defines formatting info for- Returns:
- the last column index (0-based)
-
getColumnWidth
public int getColumnWidth()
- Returns:
- column width in units of 1/256 of a character width
-
getXFIndex
public int getXFIndex()
get the columns' default format info- Returns:
- the extended format index
- See Also:
ExtendedFormatRecord
-
getHidden
public boolean getHidden()
- Returns:
- whether the cells are hidden.
-
getOutlineLevel
public int getOutlineLevel()
- Returns:
- outline level for the cells
-
getCollapsed
public boolean getCollapsed()
- Returns:
- whether the cells are collapsed
-
containsColumn
public boolean containsColumn(int columnIndex)
-
isAdjacentBefore
public boolean isAdjacentBefore(ColumnInfoRecord other)
-
formatMatches
public boolean formatMatches(ColumnInfoRecord other)
- Parameters:
other
- the format to match with- Returns:
true
if the format, options and column width match
-
getSid
public short getSid()
Description copied from class:Record
return the non static version of the id for this record.
-
serialize
public void serialize(LittleEndianOutput out)
-
copy
public ColumnInfoRecord copy()
- Specified by:
copy
in interfaceorg.apache.poi.common.Duplicatable
- Specified by:
copy
in classStandardRecord
-
getGenericRecordType
public HSSFRecordTypes getGenericRecordType()
- Specified by:
getGenericRecordType
in interfaceGenericRecord
- Specified by:
getGenericRecordType
in classRecord
-
getGenericProperties
public java.util.Map<java.lang.String,java.util.function.Supplier<?>> getGenericProperties()
-
-