Package org.apache.poi.hssf.record

Class BlankRecord

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.BlankRecord

All Implemented Interfaces:

Duplicatable, GenericRecord, CellValueRecordInterface

public final class BlankRecord
extends StandardRecord
implements CellValueRecordInterface

Represents a column in a row with no value but with styling.

Field Summary

Fields

Modifier and Type	Field	Description
static final short	sid

Constructor Summary

Constructors

Constructor	Description
BlankRecord()	Creates a new instance of BlankRecord
BlankRecord(BlankRecord other)
BlankRecord(RecordInputStream in)

Method Summary

Modifier and Type	Method	Description
BlankRecord	copy()
short	getColumn()	get the column this cell defines within the row
protected int	getDataSize()
Map<String,Supplier<?>>	getGenericProperties()
HSSFRecordTypes	getGenericRecordType()
int	getRow()	get the row this cell occurs on
short	getSid()	return the non static version of the id for this record.
short	getXFIndex()	get the index of the extended format record to style this cell with
void	serialize(LittleEndianOutput out)	Write the data content of this BIFF record.
void	setColumn(short col)	set the column this cell defines within the row
void	setRow(int row)	set the row this cell occurs on
void	setXFIndex(short xf)	set the index of the extended format record to style this cell with

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

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

Methods inherited from interface org.apache.poi.common.usermodel.GenericRecord

getGenericChildren

Field Details

sid

public static final short sid

See Also:

• Constant Field Values

Constructor Details

BlankRecord

public BlankRecord()

Creates a new instance of BlankRecord

BlankRecord

public BlankRecord(BlankRecord other)

BlankRecord

public BlankRecord(RecordInputStream in)

Method Details

setRow

public void setRow(int row)

set the row this cell occurs on

Specified by:

setRow in interface CellValueRecordInterface

Parameters:

row - the row this cell occurs within

getRow

public int getRow()

get the row this cell occurs on

Specified by:

getRow in interface CellValueRecordInterface

Returns:

the row

getColumn

public short getColumn()

get the column this cell defines within the row

Specified by:

getColumn in interface CellValueRecordInterface

Returns:

the column

setXFIndex

public void setXFIndex(short xf)

set the index of the extended format record to style this cell with

Specified by:

setXFIndex in interface CellValueRecordInterface

Parameters:

xf - - the 0-based index of the extended format

See Also:

• ExtendedFormatRecord

getXFIndex

public short getXFIndex()

get the index of the extended format record to style this cell with

Specified by:

getXFIndex in interface CellValueRecordInterface

Returns:

extended format index

setColumn

public void setColumn(short col)

set the column this cell defines within the row

Specified by:

setColumn in interface CellValueRecordInterface

Parameters:

col - the column this cell defines

getSid

public short getSid()

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

Specified by:

getSid in class Record

Returns:

he id for this record

serialize

public void serialize(LittleEndianOutput out)

Description copied from class: StandardRecord

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 RecordBase.getRecordSize()} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).

Specified by:

serialize in class StandardRecord

Parameters:

out - the output object

getDataSize

protected int getDataSize()

Specified by:

getDataSize in class StandardRecord

copy

public BlankRecord copy()

Specified by:

copy in interface Duplicatable

Specified by:

copy in class StandardRecord

Returns:

a deep copy of the implementing class / instance

getGenericRecordType

public HSSFRecordTypes getGenericRecordType()

Specified by:

getGenericRecordType in interface GenericRecord

Specified by:

getGenericRecordType in class Record

getGenericProperties

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

Specified by:

getGenericProperties in interface GenericRecord