Package loci.poi.hssf.record
Class DimensionsRecord
java.lang.Object
loci.poi.hssf.record.Record
loci.poi.hssf.record.DimensionsRecord
Title: Dimensions Record
Description: provides the minumum and maximum bounds of a sheet.
REFERENCE: PG 303 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
- Version:
- 2.0-pre
- Author:
- Andrew C. Oliver (acoliver at apache dot org), Jason Height (jheight at chariot dot net dot au)
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a Dimensions record and sets its fields appropriately. -
Method Summary
Modifier and TypeMethodDescriptionclone()protected voidcalled by the constructor, should set class level fields.shortget the first column number for the sheetintget the first row number for the sheetshortget the last col number for the sheetintget the last row number for the sheetintgives the current serialized size of the record.shortgetSid()return the non static version of the id for this record.intserialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.voidsetFirstCol(short col) set the first column number for the sheetvoidsetFirstRow(int row) set the first row number for the sheetvoidsetLastCol(short col) set the last col number for the sheetvoidsetLastRow(int row) set the last row number for the sheettoString()get a string representation of the record (for biffview/debugging)protected voidvalidateSid(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 Details
-
sid
public static final short sid- See Also:
-
-
Constructor Details
-
DimensionsRecord
public DimensionsRecord() -
DimensionsRecord
Constructs a Dimensions record and sets its fields appropriately.- Parameters:
in- the RecordInputstream to read the record from
-
-
Method Details
-
validateSid
protected void validateSid(short id) Description copied from class:Recordcalled by constructor, should throw runtime exception in the event of a record passed with a differing ID.- Specified by:
validateSidin classRecord- Parameters:
id- alleged id for this record
-
fillFields
Description copied from class:Recordcalled by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.- Specified by:
fillFieldsin classRecord- Parameters:
in- the RecordInputstream to read the record from
-
setFirstRow
public void setFirstRow(int row) set the first row number for the sheet- Parameters:
row- - first row on the sheet
-
setLastRow
public void setLastRow(int row) set the last row number for the sheet- Parameters:
row- - last row on the sheet
-
setFirstCol
public void setFirstCol(short col) set the first column number for the sheet- Parameters:
col- first column on the sheet
-
setLastCol
public void setLastCol(short col) set the last col number for the sheet- Parameters:
col- last column on the sheet
-
getFirstRow
public int getFirstRow()get the first row number for the sheet- Returns:
- row - first row on the sheet
-
getLastRow
public int getLastRow()get the last row number for the sheet- Returns:
- row - last row on the sheet
-
getFirstCol
public short getFirstCol()get the first column number for the sheet- Returns:
- column - first column on the sheet
-
getLastCol
public short getLastCol()get the last col number for the sheet- Returns:
- column - last column on the sheet
-
toString
Description copied from class:Recordget a string representation of the record (for biffview/debugging) -
serialize
public int serialize(int offset, byte[] data) Description copied from class:Recordcalled 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:Recordgives the current serialized size of the record. Should include the sid and reclength (4 bytes).- Overrides:
getRecordSizein classRecord
-
getSid
public short getSid()Description copied from class:Recordreturn the non static version of the id for this record. -
clone
-