Package loci.poi.hssf.record
Class SelectionRecord
- java.lang.Object
-
- loci.poi.hssf.record.Record
-
- loci.poi.hssf.record.SelectionRecord
-
public class SelectionRecord extends Record
Title: Selection RecordDescription: shows the user's selection on the sheet for write set num refs to 0
TODO : Fully implement reference subrecords. REFERENCE: PG 291 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
- Author:
- Andrew C. Oliver (acoliver at apache dot org), Jason Height (jheight at chariot dot net dot au), Glen Stampoultzis (glens at apache.org)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
SelectionRecord.Reference
-
Field Summary
Fields Modifier and Type Field Description static short
sid
-
Constructor Summary
Constructors Constructor Description SelectionRecord()
SelectionRecord(RecordInputStream in)
Constructs a Selection record and sets its fields appropriately.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Object
clone()
protected void
fillFields(RecordInputStream in)
called by the constructor, should set class level fields.short
getActiveCellCol()
get the active cell's colshort
getActiveCellRef()
get the active cell's reference numberint
getActiveCellRow()
get the active cell's rowshort
getNumRefs()
get the number of cell refs (we don't support selection so set to 0byte
getPane()
get which window pane this is forint
getRecordSize()
gives the current serialized size of the record.short
getSid()
return the non static version of the id for this record.int
serialize(int offset, byte[] data)
called by the class that is responsible for writing this sucker.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
setNumRefs(short refs)
set the number of cell refs (we don't support selection so set to 0void
setPane(byte pane)
set which window pane this is forString
toString()
get a string representation of the record (for biffview/debugging)protected void
validateSid(short id)
called by constructor, should throw runtime exception in the event of a record passed with a differing ID.-
Methods inherited from class loci.poi.hssf.record.Record
isInValueSection, isValue, serialize
-
-
-
-
Field Detail
-
sid
public static final short sid
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
SelectionRecord
public SelectionRecord()
-
SelectionRecord
public SelectionRecord(RecordInputStream in)
Constructs a Selection record and sets its fields appropriately.- Parameters:
in
- the RecordInputstream to read the record from
-
-
Method Detail
-
validateSid
protected void validateSid(short id)
Description copied from class:Record
called by constructor, should throw runtime exception in the event of a record passed with a differing ID.- Specified by:
validateSid
in classRecord
- Parameters:
id
- alleged id for this record
-
fillFields
protected void fillFields(RecordInputStream in)
Description copied from class:Record
called by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.- Specified by:
fillFields
in classRecord
- Parameters:
in
- the RecordInputstream to read the record from
-
setPane
public void setPane(byte pane)
set which window pane this is for- Parameters:
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
-
setNumRefs
public void setNumRefs(short refs)
set the number of cell refs (we don't support selection so set to 0- Parameters:
refs
- - number of references
-
getPane
public byte getPane()
get which window pane this is for- Returns:
- pane
-
getActiveCellRow
public int getActiveCellRow()
get the active cell's row- Returns:
- row number of active cell
-
getActiveCellCol
public short getActiveCellCol()
get the active cell's col- Returns:
- col number of active cell
-
getActiveCellRef
public short getActiveCellRef()
get the active cell's reference number- Returns:
- ref number of active cell
-
getNumRefs
public short getNumRefs()
get the number of cell refs (we don't support selection so set to 0- Returns:
- refs - number of references
-
toString
public String toString()
Description copied from class:Record
get a string representation of the record (for biffview/debugging)
-
serialize
public int serialize(int offset, byte[] data)
Description copied from class:Record
called by the class that is responsible for writing this sucker. Subclasses should implement this so that their data is passed back in a byte array.
-
getRecordSize
public int getRecordSize()
Description copied from class:Record
gives the current serialized size of the record. Should include the sid and reclength (4 bytes).- Overrides:
getRecordSize
in classRecord
-
getSid
public short getSid()
Description copied from class:Record
return the non static version of the id for this record.
-
-