Top Description Fields Constructors Methods
org.apache.poi.hssf.record

public final Class BlankRecord

extends StandardRecord
implements CellValueRecordInterface
Class Inheritance
All Implemented Interfaces
org.apache.poi.hssf.record.CellValueRecordInterface
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.util.GenericRecordUtil, .LittleEndianOutput

Represents a column in a row with no value but with styling.
Version
2.0-pre

Field Summary

Modifier and TypeField and Description
private int
private short
private short
public static final short

Constructor Summary

AccessConstructor and Description
public
BlankRecord()

Creates a new instance of BlankRecord

public
public

Method Summary

Modifier and TypeMethod and Description
public BlankRecord
public short

Returns:

the column
getColumn
()

Implements org.apache.poi.hssf.record.CellValueRecordInterface.getColumn.

get the column this cell defines within the row

protected int
public Map<String, Supplier<?>>
public HSSFRecordTypes
public int

Returns:

the row
getRow
()

Implements org.apache.poi.hssf.record.CellValueRecordInterface.getRow.

get the row this cell occurs on

public short
getSid()

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

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

public short

Returns:

extended format index
getXFIndex
()

Implements org.apache.poi.hssf.record.CellValueRecordInterface.getXFIndex.

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

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
setColumn(short
the column this cell defines
col
)

Implements org.apache.poi.hssf.record.CellValueRecordInterface.setColumn.

set the column this cell defines within the row

public void
setRow(int
the row this cell occurs within
row
)

Implements org.apache.poi.hssf.record.CellValueRecordInterface.setRow.

set the row this cell occurs on

public void
setXFIndex(short
- the 0-based index of the extended format
xf
)

Implements org.apache.poi.hssf.record.CellValueRecordInterface.setXFIndex.

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

Inherited from org.apache.poi.hssf.record.StandardRecord:
getRecordSizeserialize

Field Detail

field_1_rowback to summary
private int field_1_row
field_2_colback to summary
private short field_2_col
field_3_xfback to summary
private short field_3_xf
sidback to summary
public static final short sid

Constructor Detail

BlankRecordback to summary
public BlankRecord()

Creates a new instance of BlankRecord

BlankRecordback to summary
public BlankRecord(BlankRecord other)
BlankRecordback to summary
public BlankRecord(RecordInputStream in)

Method Detail

copyback to summary
public BlankRecord copy()

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

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

Returns:BlankRecord

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

a deep copy of the implementing class / instance

Annotations
@Override
getColumnback to summary
public short getColumn()

Implements org.apache.poi.hssf.record.CellValueRecordInterface.getColumn.

get the column this cell defines within the row

Returns:short

the column

getDataSizeback to summary
protected int getDataSize()

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

getGenericPropertiesback to summary
public Map<String, Supplier<?>> getGenericProperties()

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

Annotations
@Override
getGenericRecordTypeback 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
getRowback to summary
public int getRow()

Implements org.apache.poi.hssf.record.CellValueRecordInterface.getRow.

get the row this cell occurs on

Returns:int

the row

getSidback to summary
public short getSid()

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

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

Returns:short

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

he id for this record

getXFIndexback to summary
public short getXFIndex()

Implements org.apache.poi.hssf.record.CellValueRecordInterface.getXFIndex.

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

Returns:short

extended format index

serializeback 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

setColumnback to summary
public void setColumn(short col)

Implements org.apache.poi.hssf.record.CellValueRecordInterface.setColumn.

set the column this cell defines within the row

Parameters
col:short

the column this cell defines

setRowback to summary
public void setRow(int row)

Implements org.apache.poi.hssf.record.CellValueRecordInterface.setRow.

set the row this cell occurs on

Parameters
row:int

the row this cell occurs within

setXFIndexback to summary
public void setXFIndex(short xf)

Implements org.apache.poi.hssf.record.CellValueRecordInterface.setXFIndex.

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

Parameters
xf:short

- the 0-based index of the extended format

See Also
org.apache.poi.hssf.record.ExtendedFormatRecord