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

public abstract Class SharedValueRecordBase

extends StandardRecord
Class Inheritance
Known Direct Subclasses
org.apache.poi.hssf.record.TableRecord, org.apache.poi.hssf.record.ArrayRecord, org.apache.poi.hssf.record.SharedFormulaRecord
Imports
org.apache.poi.hssf.util.CellRangeAddress8Bit, org.apache.poi.util.LittleEndianInput, .LittleEndianOutput

Common base class for SharedFormulaRecord, ArrayRecord and TableRecord which are have similarities.

Field Summary

Modifier and TypeField and Description
private CellRangeAddress8Bit

Constructor Summary

AccessConstructor and Description
protected
protected
protected
public
SharedValueRecordBase(LittleEndianInput
The interface for reading the record data.
in
)

reads only the range (1 CellRangeAddress8Bit) from the stream

Method Summary

Modifier and TypeMethod and Description
protected int
protected abstract int
public final int
public final int
public final int
public final int
public final CellRangeAddress8Bit

Returns:

the range of cells that this record is shared across. Never null.
getRange
()

public final boolean

Returns:

true if (rowIx, colIx) describes the first cell in this shared value object's range
isFirstCell
(int
the row index
rowIx
,
int
the column index
colIx
)

public final boolean

Returns:

true if (rowIx, colIx) is within the range of this shared value object.
isInRange
(int
the row index
rowIx
,
int
the column index
colIx
)

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.

protected abstract void
Inherited from org.apache.poi.hssf.record.StandardRecord:
copygetRecordSizeserialize

Field Detail

_rangeback to summary
private CellRangeAddress8Bit _range

Constructor Detail

SharedValueRecordBaseback to summary
protected SharedValueRecordBase(SharedValueRecordBase other)
SharedValueRecordBaseback to summary
protected SharedValueRecordBase(CellRangeAddress8Bit range)
SharedValueRecordBaseback to summary
protected SharedValueRecordBase()
SharedValueRecordBaseback to summary
public SharedValueRecordBase(LittleEndianInput in)

reads only the range (1 CellRangeAddress8Bit) from the stream

Parameters
in:LittleEndianInput

The interface for reading the record data.

Method Detail

getDataSizeback to summary
protected int getDataSize()

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

getExtraDataSizeback to summary
protected abstract int getExtraDataSize()
getFirstColumnback to summary
public final int getFirstColumn()
getFirstRowback to summary
public final int getFirstRow()
getLastColumnback to summary
public final int getLastColumn()
getLastRowback to summary
public final int getLastRow()
getRangeback to summary
public final CellRangeAddress8Bit getRange()
Returns:CellRangeAddress8Bit

the range of cells that this record is shared across. Never null.

isFirstCellback to summary
public final boolean isFirstCell(int rowIx, int colIx)
Parameters
rowIx:int

the row index

colIx:int

the column index

Returns:boolean

true if (rowIx, colIx) describes the first cell in this shared value object's range

See Also
getRange()
isInRangeback to summary
public final boolean isInRange(int rowIx, int colIx)
Parameters
rowIx:int

the row index

colIx:int

the column index

Returns:boolean

true if (rowIx, colIx) is within the range of this shared value object.

See Also
getRange()
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

serializeExtraDataback to summary
protected abstract void serializeExtraData(LittleEndianOutput out)