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

public final Class RefModeRecord

extends StandardRecord
Class Inheritance
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.util.GenericRecordUtil, .LittleEndianOutput
Describes which reference mode to use
Version
2.0-pre

Field Summary

Modifier and TypeField and Description
private short
field_1_mode

public static final short
sid

public static final short
USE_A1_MODE

public static final short
USE_R1C1_MODE

Constructor Summary

AccessConstructor and Description
public
RefModeRecord()

public
RefModeRecord(RefModeRecord other)

public
RefModeRecord(RecordInputStream in)

Method Summary

Modifier and TypeMethod and Description
public RefModeRecord
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 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:

mode to use
getMode()

get the reference mode to use (HSSF uses/assumes A1)

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
setMode(short
the mode to use
mode)

set the reference mode to use (HSSF uses/assumes A1)

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

Field Detail

field_1_modeback to summary
private short field_1_mode
sidback to summary
public static final short sid
USE_A1_MODEback to summary
public static final short USE_A1_MODE
USE_R1C1_MODEback to summary
public static final short USE_R1C1_MODE

Constructor Detail

RefModeRecordback to summary
public RefModeRecord()
RefModeRecordback to summary
public RefModeRecord(RefModeRecord other)
RefModeRecordback to summary
public RefModeRecord(RecordInputStream in)

Method Detail

copyback to summary
public RefModeRecord copy()

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

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

Returns:RefModeRecord

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.

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
getModeback to summary
public short getMode()

get the reference mode to use (HSSF uses/assumes A1)

Returns:short

mode to use

See Also
USE_A1_MODE, USE_R1C1_MODE
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

setModeback to summary
public void setMode(short mode)

set the reference mode to use (HSSF uses/assumes A1)

Parameters
mode:short

the mode to use

See Also
USE_A1_MODE, USE_R1C1_MODE