Apache POI - Common 5.3.0 · org.apache.poi.hssf.record.RowRecord

Modifier and Type	Field and Description
private static final BitField	badFontHeight
private static final BitField	bottomBorder
private static final BitField	collapsed
public static final int	ENCODED_SIZE
private int	field_1_row_number
private int	field_2_first_col
private int	field_3_last_col
private short	field_4_height
private short	field_5_optimize
private short	field_6_reserved
private int	field_7_option_flags 16 bit options flags
private int	field_8_option_flags 16 bit options flags
private static final BitField	formatted
private static final int	OPTION_BITS_ALWAYS_SET
private static final BitField	outlineLevel
private static final BitField	phoneticGuide
public static final short	sid
private static final BitField	topBorder
private static final BitField	xfIndex
private static final BitField	zeroHeight

Access	Constructor and Description
public	RowRecord(RowRecord other)
public	RowRecord(int rowNumber)
public	RowRecord(RecordInputStream in)

Method Summary

Modifier and Type	Method and Description
public RowRecord	copy() Implements abstract org.apache.poi.hssf.record.StandardRecord.copy. Implements org.apache.poi.common.Duplicatable.copy.
public boolean	Returns: - f -true if they aren't compatible (damn not logic) getBadFontHeight() get whether the font and row height are not compatible
public boolean	Returns: has cells with a thick bottom border getBottomBorder() A bit that specifies whether any cell in the row has a medium or thick bottom border, or any cell in the row directly below the current row has a medium or thick top border.
public boolean	Returns: c - colapse or not getColapsed() get whether or not to colapse this row
protected int	getDataSize() Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.
public int	Returns: col - the col number getFirstCol() get the logical col number for the first cell this row (0 based index)
public boolean	Returns: formatted or not getFormatted() get whether the row has been formatted (even if its got all blank cells)
public Map<String, Supplier<?>>	getGenericProperties() Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.
public HSSFRecordTypes	getGenericRecordType() Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType. Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.
public short	Returns: height of the row getHeight() get the height of the row
public int	Returns: col - the last col index + 1 getLastCol() get the logical col number for the last cell this row (0 based index), plus one
public short	Returns: optimize (set to 0) getOptimize() get whether to optimize or not (set to 0)
public short	Returns: options - the bitmask getOptionFlags() gets the option bitmask.
public short	Returns: options - the bitmask getOptionFlags2() gets the 2nd option bitmask.
public short	Returns: ol - the outline level getOutlineLevel() get the outline level of this row
public boolean	Returns: has phoentic guide getPhoeneticGuide() A bit that specifies whether the phonetic guide feature is enabled for any cell in this row.
public int	Returns: row - the row number getRowNumber() get the logical row number for this row (0 based index)
public short	getSid() Implements abstract org.apache.poi.hssf.record.Record.getSid. return the non static version of the id for this record.
public boolean	Returns: has cells with a thick top border getTopBorder() A bit that specifies whether any cell in the row has a thick top border, or any cell in the row directly above the current row has a thick bottom border.
public short	Returns: index to the XF record or bogus value (undefined) if isn't formatted getXFIndex() if the row is formatted then this is the index to the extended format record
public boolean	Returns: - z height is zero or not. getZeroHeight() get whether or not to display this row with 0 height
public boolean	isEmpty()
public void	serialize(LittleEndianOutput the output object out) Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize. Write the data content of this BIFF record.
public void	setBadFontHeight(boolean true if they aren't compatible (damn not logic) f) set whether the font and row height are not compatible
public void	setBottomBorder(boolean has thick bottom border f) A bit that specifies whether any cell in the row has a medium or thick bottom border, or any cell in the row directly below the current row has a medium or thick top border.
public void	setColapsed(boolean - collapse or not c) set whether or not to collapse this row
public void	setEmpty() Updates the firstCol and lastCol fields to the reserved value (-1) to signify that this row is empty
public void	setFirstCol(int - the col number col) set the logical col number for the first cell this row (0 based index)
public void	setFormatted(boolean formatted or not f) set whether the row has been formatted (even if its got all blank cells)
public void	setHeight(short of the row height) set the height of the row
public void	setLastCol(int - one past the zero-based index to the last cell in this row col)
public void	setOptimize(short (set to 0) optimize) set whether to optimize or not (set to 0)
public void	setOutlineLevel(short - the outline level ol) set the outline level of this row
public void	setPhoeneticGuide(boolean use phoenetic guide f) A bit that specifies whether the phonetic guide feature is enabled for any cell in this row.
public void	setRowNumber(int - the row number row) set the logical row number for this row (0 based index)
public void	setTopBorder(boolean has thick top border f) bit that specifies whether any cell in the row has a thick top border, or any cell in the row directly above the current row has a thick bottom border.
public void	setXFIndex(short to the XF record index) if the row is formatted then this is the index to the extended format record
public void	setZeroHeight(boolean height is zero or not. z) set whether or not to display this row with 0 height

Inherited from org.apache.poi.hssf.record.StandardRecord:: getRecordSize serialize

badFontHeight	back to summary
private static final BitField badFontHeight

bottomBorder	back to summary
private static final BitField bottomBorder

collapsed	back to summary
private static final BitField collapsed

ENCODED_SIZE	back to summary
public static final int ENCODED_SIZE

field_1_row_number	back to summary
private int field_1_row_number

field_2_first_col	back to summary
private int field_2_first_col

field_3_last_col	back to summary
private int field_3_last_col

field_4_height	back to summary
private short field_4_height

field_5_optimize	back to summary
private short field_5_optimize

field_6_reserved	back to summary
private short field_6_reserved

field_7_option_flags	back to summary
private int field_7_option_flags 16 bit options flags

field_8_option_flags	back to summary
private int field_8_option_flags 16 bit options flags

formatted	back to summary
private static final BitField formatted

OPTION_BITS_ALWAYS_SET	back to summary
private static final int OPTION_BITS_ALWAYS_SET

outlineLevel	back to summary
private static final BitField outlineLevel

phoneticGuide	back to summary
private static final BitField phoneticGuide

sid	back to summary
public static final short sid

topBorder	back to summary
private static final BitField topBorder

xfIndex	back to summary
private static final BitField xfIndex

zeroHeight	back to summary
private static final BitField zeroHeight

RowRecord	back to summary
public RowRecord(RowRecord other)

RowRecord	back to summary
public RowRecord(int rowNumber)

RowRecord	back to summary
public RowRecord(RecordInputStream in)

Method Detail

copy	back to summary
public RowRecord copy() Implements abstract org.apache.poi.hssf.record.StandardRecord.copy. Implements org.apache.poi.common.Duplicatable.copy. Returns:RowRecord Doc from org.apache.poi.common.Duplicatable.copy. a deep copy of the implementing class / instance Annotations @Override

copy

back to summary

public RowRecord copy()

Implements abstract org.apache.poi.hssf.record.StandardRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

Returns:RowRecord

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

Annotations

@Override

getBadFontHeight back to summary

getBadFontHeight	back to summary
public boolean getBadFontHeight() get whether the font and row height are not compatible Returns:boolean - f -true if they aren't compatible (damn not logic) See Also `getOptionFlags()`

public boolean getBadFontHeight()

get whether the font and row height are not compatible

Returns:boolean: - f -true if they aren't compatible (damn not logic)
See Also: getOptionFlags()

getBottomBorder	back to summary
public boolean getBottomBorder() A bit that specifies whether any cell in the row has a medium or thick bottom border, or any cell in the row directly below the current row has a medium or thick top border. Returns:boolean has cells with a thick bottom border

getBottomBorder

back to summary

public boolean getBottomBorder()

A bit that specifies whether any cell in the row has a medium or thick bottom border, or any cell in the row directly below the current row has a medium or thick top border.

Returns:boolean: has cells with a thick bottom border

getColapsed back to summary

getColapsed	back to summary
public boolean getColapsed() get whether or not to colapse this row Returns:boolean c - colapse or not See Also `getOptionFlags()`

public boolean getColapsed()

get whether or not to colapse this row

Returns:boolean: c - colapse or not
See Also: getOptionFlags()

getDataSize	back to summary
protected int getDataSize() Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.

getFirstCol	back to summary
public int getFirstCol() get the logical col number for the first cell this row (0 based index) Returns:int col - the col number

getFirstCol

back to summary

public int getFirstCol()

get the logical col number for the first cell this row (0 based index)

Returns:int: col - the col number

getFormatted back to summary

getFormatted	back to summary
public boolean getFormatted() get whether the row has been formatted (even if its got all blank cells) Returns:boolean formatted or not See Also `getOptionFlags()`

public boolean getFormatted()

get whether the row has been formatted (even if its got all blank cells)

Returns:boolean: formatted or not
See Also: getOptionFlags()

getGenericProperties	back to summary
public Map<String, Supplier<?>> getGenericProperties() Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties. Annotations @Override

getGenericProperties

back to summary

public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations

@Override

getGenericRecordType	back to summary
public HSSFRecordTypes getGenericRecordType() Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType. Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType. Annotations @Override

getGenericRecordType

back to summary

public HSSFRecordTypes getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.

Annotations

@Override

getHeight	back to summary
public short getHeight() get the height of the row Returns:short height of the row

getHeight

back to summary

public short getHeight()

get the height of the row

Returns:short: height of the row

getLastCol	back to summary
public int getLastCol() get the logical col number for the last cell this row (0 based index), plus one Returns:int col - the last col index + 1

getLastCol

back to summary

public int getLastCol()

get the logical col number for the last cell this row (0 based index), plus one

Returns:int: col - the last col index + 1

getOptimize	back to summary
public short getOptimize() get whether to optimize or not (set to 0) Returns:short optimize (set to 0)

getOptimize

back to summary

public short getOptimize()

get whether to optimize or not (set to 0)

Returns:short: optimize (set to 0)

getOptionFlags	back to summary
public short getOptionFlags() gets the option bitmask. (use the individual bit setters that refer to this method) Returns:short options - the bitmask

getOptionFlags

back to summary

public short getOptionFlags()

gets the option bitmask. (use the individual bit setters that refer to this method)

Returns:short: options - the bitmask

getOptionFlags2	back to summary
public short getOptionFlags2() gets the 2nd option bitmask. (use the individual bit setters that refer to this method) Returns:short options - the bitmask

getOptionFlags2

back to summary

public short getOptionFlags2()

gets the 2nd option bitmask. (use the individual bit setters that refer to this method)

Returns:short: options - the bitmask

getOutlineLevel back to summary

getOutlineLevel	back to summary
public short getOutlineLevel() get the outline level of this row Returns:short ol - the outline level See Also `getOptionFlags()`

public short getOutlineLevel()

get the outline level of this row

Returns:short: ol - the outline level
See Also: getOptionFlags()

getPhoeneticGuide	back to summary
public boolean getPhoeneticGuide() A bit that specifies whether the phonetic guide feature is enabled for any cell in this row. Returns:boolean has phoentic guide

getPhoeneticGuide

back to summary

public boolean getPhoeneticGuide()

A bit that specifies whether the phonetic guide feature is enabled for any cell in this row.

Returns:boolean: has phoentic guide

getRowNumber	back to summary
public int getRowNumber() get the logical row number for this row (0 based index) Returns:int row - the row number

getRowNumber

back to summary

public int getRowNumber()

get the logical row number for this row (0 based index)

Returns:int: row - the row number

getSid	back to summary
public short getSid() Implements abstract org.apache.poi.hssf.record.Record.getSid. Doc from org.apache.poi.hssf.record.Record.getSid. return the non static version of the id for this record. Returns:short he id for this record

getSid

back to summary

public short getSid()

Implements abstract org.apache.poi.hssf.record.Record.getSid.

Doc from org.apache.poi.hssf.record.Record.getSid.

return the non static version of the id for this record.

Returns:short: he id for this record

getTopBorder	back to summary
public boolean getTopBorder() A bit that specifies whether any cell in the row has a thick top border, or any cell in the row directly above the current row has a thick bottom border. Returns:boolean has cells with a thick top border

getTopBorder

back to summary

public boolean getTopBorder()

A bit that specifies whether any cell in the row has a thick top border, or any cell in the row directly above the current row has a thick bottom border.

Returns:boolean: has cells with a thick top border

getXFIndex back to summary

getXFIndex	back to summary
public short getXFIndex() if the row is formatted then this is the index to the extended format record Returns:short index to the XF record or bogus value (undefined) if isn't formatted See Also `org.apache.poi.hssf.record.ExtendedFormatRecord`

public short getXFIndex()

if the row is formatted then this is the index to the extended format record

Returns:short: index to the XF record or bogus value (undefined) if isn't formatted
See Also: org.apache.poi.hssf.record.ExtendedFormatRecord

getZeroHeight back to summary

getZeroHeight	back to summary
public boolean getZeroHeight() get whether or not to display this row with 0 height Returns:boolean - z height is zero or not. See Also `getOptionFlags()`

public boolean getZeroHeight()

get whether or not to display this row with 0 height

Returns:boolean: - z height is zero or not.
See Also: getOptionFlags()

isEmpty	back to summary
public boolean isEmpty()

serialize back to summary

serialize	back to summary
public void serialize(LittleEndianOutput out) Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize. Doc from org.apache.poi.hssf.record.StandardRecord.serialize. Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields have already been written by the superclass. The number of bytes written must equal the record size reported by `org.apache.poi.hssf.record.Record#getRecordSize()`} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass). Parameters out:LittleEndianOutput the output object

public void serialize(LittleEndianOutput out)

Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize.

Doc from org.apache.poi.hssf.record.StandardRecord.serialize.

Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields have already been written by the superclass.

The number of bytes written must equal the record size reported by org.apache.poi.hssf.record.Record#getRecordSize()} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).

Parameters

out:LittleEndianOutput: the output object

setBadFontHeight	back to summary
public void setBadFontHeight(boolean f) set whether the font and row height are not compatible Parameters f:boolean true if they aren't compatible (damn not logic)

setBadFontHeight

back to summary

public void setBadFontHeight(boolean f)

set whether the font and row height are not compatible

Parameters

f:boolean: true if they aren't compatible (damn not logic)

setBottomBorder

back to summary

public void setBottomBorder(boolean f)

A bit that specifies whether any cell in the row has a medium or thick bottom border, or any cell in the row directly below the current row has a medium or thick top border.

Parameters

f:boolean: has thick bottom border

setColapsed

back to summary

public void setColapsed(boolean c)

set whether or not to collapse this row

Parameters

c:boolean: - collapse or not

setEmpty	back to summary
public void setEmpty() Updates the firstCol and lastCol fields to the reserved value (-1) to signify that this row is empty

setFirstCol

back to summary

public void setFirstCol(int col)

set the logical col number for the first cell this row (0 based index)

Parameters

col:int: - the col number

setFormatted

back to summary

public void setFormatted(boolean f)

set whether the row has been formatted (even if its got all blank cells)

Parameters

f:boolean: formatted or not

setHeight

back to summary

public void setHeight(short height)

set the height of the row

Parameters

height:short: of the row

setLastCol	back to summary
public void setLastCol(int col) Parameters col:int - one past the zero-based index to the last cell in this row

setOptimize

back to summary

public void setOptimize(short optimize)

set whether to optimize or not (set to 0)

Parameters

optimize:short: (set to 0)

setOutlineLevel

back to summary

public void setOutlineLevel(short ol)

set the outline level of this row

Parameters

ol:short: - the outline level

setPhoeneticGuide

back to summary

public void setPhoeneticGuide(boolean f)

A bit that specifies whether the phonetic guide feature is enabled for any cell in this row.

Parameters

f:boolean: use phoenetic guide

setRowNumber

back to summary

public void setRowNumber(int row)

set the logical row number for this row (0 based index)

Parameters

row:int: - the row number

setTopBorder

back to summary

public void setTopBorder(boolean f)

bit that specifies whether any cell in the row has a thick top border, or any cell in the row directly above the current row has a thick bottom border.

Parameters

f:boolean: has thick top border

setXFIndex back to summary

public void setXFIndex(short index)

if the row is formatted then this is the index to the extended format record

Parameters

index:short: to the XF record

setZeroHeight

back to summary

public void setZeroHeight(boolean z)

set whether or not to display this row with 0 height

Parameters

z:boolean: height is zero or not.

public final Class RowRecord

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail