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

public final Class DimensionsRecord

extends StandardRecord
Class Inheritance
Imports
java.util.Map, java.util.function.Supplier, org.apache.logging.log4j.LogManager, .Logger, org.apache.poi.util.GenericRecordUtil, .LittleEndianOutput

Provides the minumum and maximum bounds of a sheet.
Version
2.0-pre

Field Summary

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

Constructor Summary

AccessConstructor and Description
public
public
public

Method Summary

Modifier and TypeMethod and Description
public DimensionsRecord
protected int
public short

Returns:

column - first column on the sheet
getFirstCol
()

get the first column number for the sheet

public int

Returns:

row - first row on the sheet
getFirstRow
()

get the first row number for the sheet

public Map<String, Supplier<?>>
public HSSFRecordTypes
public short

Returns:

column - last column on the sheet
getLastCol
()

get the last col number for the sheet

public int

Returns:

row - last row on the sheet
getLastRow
()

get the last row number for the sheet

public short
getSid()

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

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

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
setFirstCol(short
first column on the sheet
col
)

set the first column number for the sheet

public void
setFirstRow(int
- first row on the sheet
row
)

set the first row number for the sheet

public void
setLastCol(short
last column on the sheet
col
)

set the last col number for the sheet

public void
setLastRow(int
- last row on the sheet
row
)

set the last row number for the sheet

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

Field Detail

field_1_first_rowback to summary
private int field_1_first_row
field_2_last_rowback to summary
private int field_2_last_row
field_3_first_colback to summary
private short field_3_first_col
field_4_last_colback to summary
private short field_4_last_col
field_5_zeroback to summary
private short field_5_zero
LOGback to summary
private static final Logger LOG
sidback to summary
public static final short sid

Constructor Detail

DimensionsRecordback to summary
public DimensionsRecord()
DimensionsRecordback to summary
public DimensionsRecord(DimensionsRecord other)
DimensionsRecordback to summary
public DimensionsRecord(RecordInputStream in)

Method Detail

copyback to summary
public DimensionsRecord copy()

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

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

Returns:DimensionsRecord

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.

getFirstColback to summary
public short getFirstCol()

get the first column number for the sheet

Returns:short

column - first column on the sheet

getFirstRowback to summary
public int getFirstRow()

get the first row number for the sheet

Returns:int

row - first row on the sheet

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
getLastColback to summary
public short getLastCol()

get the last col number for the sheet

Returns:short

column - last column on the sheet

getLastRowback to summary
public int getLastRow()

get the last row number for the sheet

Returns:int

row - last row on the sheet

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

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

setFirstColback to summary
public void setFirstCol(short col)

set the first column number for the sheet

Parameters
col:short

first column on the sheet

setFirstRowback to summary
public void setFirstRow(int row)

set the first row number for the sheet

Parameters
row:int

- first row on the sheet

setLastColback to summary
public void setLastCol(short col)

set the last col number for the sheet

Parameters
col:short

last column on the sheet

setLastRowback to summary
public void setLastRow(int row)

set the last row number for the sheet

Parameters
row:int

- last row on the sheet