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

public final Class SelectionRecord

extends StandardRecord
Class Inheritance
Imports
java.util.Map, java.util.function.Supplier, java.util.stream.Stream, org.apache.poi.hssf.util.CellRangeAddress8Bit, org.apache.poi.util.GenericRecordUtil, .LittleEndianOutput
Shows the user's selection on the sheet for write set num refs to 0

Field Summary

Modifier and TypeField and Description
private byte
field_1_pane

private int
field_2_row_active_cell

private int
field_3_col_active_cell

private int
field_4_active_cell_ref_index

private CellRangeAddress8Bit[]
field_6_refs

public static final short
sid

Constructor Summary

AccessConstructor and Description
public
SelectionRecord(SelectionRecord other)

public
SelectionRecord(int
the active cells row index
activeCellRow, int
the active cells column index
activeCellCol)

Creates a default selection record (cell A1, in pane ID 3)

public
SelectionRecord(RecordInputStream in)

Method Summary

Modifier and TypeMethod and Description
public SelectionRecord
copy()

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

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

public int

Returns:

col number of active cell
getActiveCellCol()

get the active cell's col

public int

Returns:

ref number of active cell
getActiveCellRef()

get the active cell's reference number

public int

Returns:

row number of active cell
getActiveCellRow()

get the active cell's row

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 byte

Returns:

the pane ID which window pane this is for
getPane()

public short
getSid()

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

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

private void
resetField6()

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
setActiveCellCol(short
number of active cell
col)

set the active cell's col

public void
setActiveCellRef(short
number of active cell
ref)

set the active cell's reference number

public void
setActiveCellRow(int
number of active cell
row)

set the active cell's row

public void
setPane(byte
the window pane
pane)

set which window pane this is for

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

Field Detail

field_1_paneback to summary
private byte field_1_pane
field_2_row_active_cellback to summary
private int field_2_row_active_cell
field_3_col_active_cellback to summary
private int field_3_col_active_cell
field_4_active_cell_ref_indexback to summary
private int field_4_active_cell_ref_index
field_6_refsback to summary
private CellRangeAddress8Bit[] field_6_refs
sidback to summary
public static final short sid

Constructor Detail

SelectionRecordback to summary
public SelectionRecord(SelectionRecord other)
SelectionRecordback to summary
public SelectionRecord(int activeCellRow, int activeCellCol)

Creates a default selection record (cell A1, in pane ID 3)

Parameters
activeCellRow:int

the active cells row index

activeCellCol:int

the active cells column index

SelectionRecordback to summary
public SelectionRecord(RecordInputStream in)

Method Detail

copyback to summary
public SelectionRecord copy()

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

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

Returns:SelectionRecord

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

a deep copy of the implementing class / instance

Annotations
@Override
getActiveCellColback to summary
public int getActiveCellCol()

get the active cell's col

Returns:int

col number of active cell

getActiveCellRefback to summary
public int getActiveCellRef()

get the active cell's reference number

Returns:int

ref number of active cell

getActiveCellRowback to summary
public int getActiveCellRow()

get the active cell's row

Returns:int

row number of active cell

getDataSizeback to summary
protected int getDataSize()

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

Annotations
@Override
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
getPaneback to summary
public byte getPane()
Returns:byte

the pane ID which window pane this is for

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

Annotations
@Override
resetField6back to summary
private void resetField6()
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

Annotations
@Override
setActiveCellColback to summary
public void setActiveCellCol(short col)

set the active cell's col

Parameters
col:short

number of active cell

setActiveCellRefback to summary
public void setActiveCellRef(short ref)

set the active cell's reference number

Parameters
ref:short

number of active cell

setActiveCellRowback to summary
public void setActiveCellRow(int row)

set the active cell's row

Parameters
row:int

number of active cell

setPaneback to summary
public void setPane(byte pane)

set which window pane this is for

Parameters
pane:byte

the window pane