|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.poi.hssf.record.Record
org.apache.poi.hssf.record.MergeCellsRecord
public class MergeCellsRecord
Title: Merged Cells Record
Description: Optional record defining a square area of cells to "merged" into
one cell.
REFERENCE: NONE (UNDOCUMENTED PRESENTLY)
| Nested Class Summary | |
|---|---|
class |
MergeCellsRecord.MergedRegion
this is a low level representation of a MergedRegion of cells. |
| Field Summary | |
|---|---|
static short |
sid
|
| Constructor Summary | |
|---|---|
MergeCellsRecord()
|
|
MergeCellsRecord(RecordInputStream in)
Constructs a MergedCellsRecord and sets its fields appropriately |
|
| Method Summary | |
|---|---|
int |
addArea(int rowfrom,
short colfrom,
int rowto,
short colto)
Add an area to consider a merged cell. |
java.lang.Object |
clone()
|
protected void |
fillFields(RecordInputStream in)
called by the constructor, should set class level fields. |
MergeCellsRecord.MergedRegion |
getAreaAt(int index)
return the MergedRegion at the given index. |
short |
getNumAreas()
get the number of merged areas. |
int |
getRecordSize()
gives the current serialized size of the record. |
short |
getSid()
return the non static version of the id for this record. |
void |
removeAreaAt(int area)
essentially unmerge the cells in the "area" stored at the passed in index |
int |
serialize(int offset,
byte[] data)
called by the class that is responsible for writing this sucker. |
void |
setNumAreas(short numareas)
Deprecated. We now link the size to the actual array of merged regions |
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 |
|---|
cloneViaReserialise, isInValueSection, isValue, serialize |
| Methods inherited from class java.lang.Object |
|---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static final short sid
| Constructor Detail |
|---|
public MergeCellsRecord()
public MergeCellsRecord(RecordInputStream in)
in - the RecordInputstream to read the record from| Method Detail |
|---|
protected void fillFields(RecordInputStream in)
Record
fillFields in class Recordin - the RecordInputstream to read the record frompublic short getNumAreas()
public void setNumAreas(short numareas)
numareas - number of areasgetNumAreas()
public int addArea(int rowfrom,
short colfrom,
int rowto,
short colto)
rowfrom - - the upper left hand corner's rowcolfrom - - the upper left hand corner's colrowto - - the lower right hand corner's rowcolto - - the lower right hand corner's col
public void removeAreaAt(int area)
area - indexpublic MergeCellsRecord.MergedRegion getAreaAt(int index)
public int getRecordSize()
Record
getRecordSize in class Recordpublic short getSid()
Record
getSid in class Record
public int serialize(int offset,
byte[] data)
Record
serialize in class Recordoffset - to begin writing atdata - byte array containing instance data
public java.lang.String toString()
Record
toString in class Recordprotected void validateSid(short id)
Record
validateSid in class Recordid - alleged id for this recordpublic java.lang.Object clone()
clone in class Record
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||