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

public final Class MulBlankRecord

extends StandardRecord
Class Inheritance
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.util.GenericRecordUtil, .LittleEndianOutput
Represents a set of columns in a row with no value but with styling.
See Also
BlankRecord

Field Summary

Modifier and TypeField and Description
private final int
_firstCol

private final int
_lastCol

private final int
_row

private final short[]
_xfs

public static final short
sid

Constructor Summary

AccessConstructor and Description
public
MulBlankRecord(int row, int firstCol, short[] xfs)

public
MulBlankRecord(RecordInputStream
the RecordInputstream to read the record from
in)

Method Summary

Modifier and TypeMethod and Description
public MulBlankRecord
copy()

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

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

protected int
getDataSize()

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

public int

Returns:

starting column (first cell this holds in the row). Zero based
getFirstColumn()

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 int

Returns:

ending column (last cell this holds in the row). Zero based
getLastColumn()

public int

Returns:

number of columns (last - first +1)
getNumColumns()

get the number of columns this contains (last-first +1)

public int

Returns:

the row number of the cells this represents
getRow()

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:

the XF index for the column
getXFAt(int
the column (coffset = column - field_2_first_col)
coffset)

returns the xf index for column (coffset = column - field_2_first_col)

private static short[]
parseXFs(RecordInputStream in)

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.

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

Field Detail

_firstColback to summary
private final int _firstCol
_lastColback to summary
private final int _lastCol
_rowback to summary
private final int _row
_xfsback to summary
private final short[] _xfs
sidback to summary
public static final short sid

Constructor Detail

MulBlankRecordback to summary
public MulBlankRecord(int row, int firstCol, short[] xfs)
MulBlankRecordback to summary
public MulBlankRecord(RecordInputStream in)
Parameters
in:RecordInputStream

the RecordInputstream to read the record from

Method Detail

copyback to summary
public MulBlankRecord copy()

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

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

Returns:MulBlankRecord

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

a deep copy of the implementing class / instance

Annotations
@Override
getDataSizeback to summary
protected int getDataSize()

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

getFirstColumnback to summary
public int getFirstColumn()
Returns:int

starting column (first cell this holds in the row). Zero based

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
getLastColumnback to summary
public int getLastColumn()
Returns:int

ending column (last cell this holds in the row). Zero based

getNumColumnsback to summary
public int getNumColumns()

get the number of columns this contains (last-first +1)

Returns:int

number of columns (last - first +1)

getRowback to summary
public int getRow()
Returns:int

the row number of the cells this represents

getSidback 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

getXFAtback to summary
public short getXFAt(int coffset)

returns the xf index for column (coffset = column - field_2_first_col)

Parameters
coffset:int

the column (coffset = column - field_2_first_col)

Returns:short

the XF index for the column

parseXFsback to summary
private static short[] parseXFs(RecordInputStream in)
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