Package org.apache.poi.hssf.record

Class SharedValueRecordBase

java.lang.Object

org.apache.poi.hssf.record.RecordBase

org.apache.poi.hssf.record.Record

org.apache.poi.hssf.record.StandardRecord

org.apache.poi.hssf.record.SharedValueRecordBase

All Implemented Interfaces:

org.apache.poi.common.Duplicatable, GenericRecord

Direct Known Subclasses:

ArrayRecord, SharedFormulaRecord, TableRecord

public abstract class SharedValueRecordBase
extends StandardRecord

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

Constructor Summary

Constructors

Constructor	Description
SharedValueRecordBase(LittleEndianInput in)	reads only the range (1 CellRangeAddress8Bit) from the stream

Method Summary

Modifier and Type	Method	Description
final int	getFirstColumn()
final int	getFirstRow()
final int	getLastColumn()
final int	getLastRow()
final CellRangeAddress8Bit	getRange()
final boolean	isFirstCell(int rowIx, int colIx)
final boolean	isInRange(int rowIx, int colIx)
void	serialize(LittleEndianOutput out)

Methods inherited from class org.apache.poi.hssf.record.StandardRecord

copy, getRecordSize, serialize

Methods inherited from class org.apache.poi.hssf.record.Record

cloneViaReserialise, getGenericRecordType, getSid, serialize, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.poi.common.usermodel.GenericRecord

getGenericChildren, getGenericProperties

Constructor Details

SharedValueRecordBase

public SharedValueRecordBase(LittleEndianInput in)

reads only the range (1 CellRangeAddress8Bit) from the stream

Parameters:

in - The interface for reading the record data.

Method Details

getRange

public final CellRangeAddress8Bit getRange()

Returns:

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

getFirstRow

public final int getFirstRow()

getLastRow

public final int getLastRow()

getFirstColumn

public final int getFirstColumn()

getLastColumn

public final int getLastColumn()

serialize

public void serialize(LittleEndianOutput out)

isInRange

public final boolean isInRange(int rowIx,
 int colIx)

Parameters:

rowIx - the row index

colIx - the column index

Returns:

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

See Also:

• getRange()

isFirstCell

public final boolean isFirstCell(int rowIx,
 int colIx)

Parameters:

rowIx - the row index

colIx - the column index

Returns:

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

See Also:

• getRange()