|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.poi.hssf.record.Record | +--org.apache.poi.hssf.record.RowRecord
Title: Row Record
Description: stores the row information for the sheet.
REFERENCE: PG 379 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
Field Summary | |
static short |
sid
|
Constructor Summary | |
RowRecord()
|
|
RowRecord(short id,
short size,
byte[] data)
Constructs a Row record and sets its fields appropriately. |
|
RowRecord(short id,
short size,
byte[] data,
int offset)
Constructs a Row record and sets its fields appropriately. |
Method Summary | |
int |
compareTo(java.lang.Object obj)
|
boolean |
equals(java.lang.Object obj)
|
protected void |
fillFields(byte[] data,
short size,
int offset)
called by the constructor, should set class level fields. |
boolean |
getBadFontHeight()
get whether the font and row height are not compatible |
boolean |
getColapsed()
get whether or not to colapse this row |
short |
getFirstCol()
get the logical col number for the first cell this row (0 based index) |
boolean |
getFormatted()
get whether the row has been formatted (even if its got all blank cells) |
short |
getHeight()
get the height of the row |
short |
getLastCol()
get the logical col number for the last cell this row (0 based index) |
short |
getOptimize()
get whether to optimize or not (set to 0) |
short |
getOptionFlags()
gets the option bitmask. |
short |
getOutlineLevel()
get the outline level of this row |
int |
getRecordSize()
gives the current serialized size of the record. |
short |
getRowNumber()
get the logical row number for this row (0 based index) |
short |
getSid()
return the non static version of the id for this record. |
short |
getXFIndex()
if the row is formatted then this is the index to the extended format record |
boolean |
getZeroHeight()
get whether or not to display this row with 0 height |
boolean |
isInValueSection()
DBCELL, ROW, VALUES all say yes |
int |
serialize(int offset,
byte[] data)
called by the class that is responsible for writing this sucker. |
void |
setBadFontHeight(boolean f)
set whether the font and row height are not compatible |
void |
setColapsed(boolean c)
set whether or not to colapse this row |
void |
setFirstCol(short col)
set the logical col number for the first cell this row (0 based index) |
void |
setFormatted(boolean f)
set whether the row has been formatted (even if its got all blank cells) |
void |
setHeight(short height)
set the height of the row |
void |
setLastCol(short col)
set the logical col number for the last cell this row (0 based index) |
void |
setOptimize(short optimize)
set whether to optimize or not (set to 0) |
void |
setOptionFlags(short options)
sets the option bitmask. |
void |
setOutlineLevel(short ol)
set the outline level of this row |
void |
setRowNumber(short row)
set the logical row number for this row (0 based index) |
void |
setXFIndex(short index)
if the row is formatted then this is the index to the extended format record |
void |
setZeroHeight(boolean z)
set whether or not to display this row with 0 height |
java.lang.String |
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 org.apache.poi.hssf.record.Record |
fillFields, isValue, processContinueRecord, serialize |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final short sid
Constructor Detail |
public RowRecord()
public RowRecord(short id, short size, byte[] data)
id
- id must be 0x208 or an exception will be throw upon validationsize
- the size of the data area of the recorddata
- data of the record (should not contain sid/len)public RowRecord(short id, short size, byte[] data, int offset)
id
- id must be 0x208 or an exception will be throw upon validationsize
- the size of the data area of the recorddata
- data of the record (should not contain sid/len)offset
- of the record dataMethod Detail |
protected void validateSid(short id)
Record
validateSid
in class Record
org.apache.poi.hssf.record.Record
id
- alleged id for this recordprotected void fillFields(byte[] data, short size, int offset)
Record
fillFields
in class Record
org.apache.poi.hssf.record.Record
data
- raw datasize
- size of dataoffset
- of the record's data (provided a big array of the file)public void setRowNumber(short row)
row
- - the row numberpublic void setFirstCol(short col)
col
- - the col numberpublic void setLastCol(short col)
col
- - the col numberpublic void setHeight(short height)
height
- of the rowpublic void setOptimize(short optimize)
optimize
- (set to 0)public void setOptionFlags(short options)
options
- - the bitmaskpublic void setOutlineLevel(short ol)
ol
- - the outline levelsetOptionFlags(short)
public void setColapsed(boolean c)
c
- - colapse or notsetOptionFlags(short)
public void setZeroHeight(boolean z)
z
- height is zero or not.setOptionFlags(short)
public void setBadFontHeight(boolean f)
f
- true if they aren't compatible (damn not logic)setOptionFlags(short)
public void setFormatted(boolean f)
f
- formatted or notsetOptionFlags(short)
public void setXFIndex(short index)
index
- to the XF recordExtendedFormatRecord
public short getRowNumber()
public short getFirstCol()
public short getLastCol()
public short getHeight()
public short getOptimize()
public short getOptionFlags()
public short getOutlineLevel()
getOptionFlags()
public boolean getColapsed()
getOptionFlags()
public boolean getZeroHeight()
getOptionFlags()
public boolean getBadFontHeight()
getOptionFlags()
public boolean getFormatted()
getOptionFlags()
public short getXFIndex()
ExtendedFormatRecord
public boolean isInValueSection()
Record
isInValueSection
in class Record
public java.lang.String toString()
Record
toString
in class Record
public int serialize(int offset, byte[] data)
Record
serialize
in class Record
org.apache.poi.hssf.record.Record
offset
- to begin writing atdata
- byte array containing instance datapublic int getRecordSize()
Record
getRecordSize
in class Record
public short getSid()
Record
getSid
in class Record
public int compareTo(java.lang.Object obj)
compareTo
in interface java.lang.Comparable
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |