Package org.apache.poi.hssf.record
Class SelectionRecord
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.SelectionRecord
Title: Selection Record (0x001D)
Description: shows the user's selection on the sheet for write set num refs to 0
REFERENCE: PG 291 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionSelectionRecord
(int activeCellRow, int activeCellCol) Creates a default selection record (cell A1, in pane ID 3) -
Method Summary
Modifier and TypeMethodDescriptionclone()
int
get the active cell's colint
get the active cell's reference numberint
get the active cell's rowprotected int
byte
getPane()
short
getSid()
return the non static version of the id for this record.void
Write the data content of this BIFF record.void
setActiveCellCol
(short col) set the active cell's colvoid
setActiveCellRef
(short ref) set the active cell's reference numbervoid
setActiveCellRow
(int row) set the active cell's rowvoid
setPane
(byte pane) set which window pane this is fortoString()
get a string representation of the record (for biffview/debugging)Methods inherited from class org.apache.poi.hssf.record.StandardRecord
getRecordSize, serialize
Methods inherited from class org.apache.poi.hssf.record.Record
cloneViaReserialise, serialize
-
Field Details
-
sid
public static final short sid- See Also:
-
-
Constructor Details
-
SelectionRecord
public SelectionRecord(int activeCellRow, int activeCellCol) Creates a default selection record (cell A1, in pane ID 3)- Parameters:
activeCellRow
- the active cells row indexactiveCellCol
- the active cells column index
-
SelectionRecord
-
-
Method Details
-
setPane
public void setPane(byte pane) set which window pane this is for- Parameters:
pane
- the window pane
-
setActiveCellRow
public void setActiveCellRow(int row) set the active cell's row- Parameters:
row
- number of active cell
-
setActiveCellCol
public void setActiveCellCol(short col) set the active cell's col- Parameters:
col
- number of active cell
-
setActiveCellRef
public void setActiveCellRef(short ref) set the active cell's reference number- Parameters:
ref
- number of active cell
-
getPane
public byte getPane()- Returns:
- the pane ID which window pane this is for
-
getActiveCellRow
public int getActiveCellRow()get the active cell's row- Returns:
- row number of active cell
-
getActiveCellCol
public int getActiveCellCol()get the active cell's col- Returns:
- col number of active cell
-
getActiveCellRef
public int getActiveCellRef()get the active cell's reference number- Returns:
- ref number of active cell
-
toString
Description copied from class:Record
get a string representation of the record (for biffview/debugging) -
getDataSize
protected int getDataSize()- Specified by:
getDataSize
in classStandardRecord
-
serialize
Description copied from class:StandardRecord
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
RecordBase.getRecordSize()
} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).- Specified by:
serialize
in classStandardRecord
- Parameters:
out
- the output object
-
getSid
public short getSid()Description copied from class:Record
return the non static version of the id for this record. -
clone
-