Package org.apache.poi.hssf.record
Class MergeCellsRecord
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.MergeCellsRecord
- All Implemented Interfaces:
Cloneable
Title: Merged Cells Record (0x00E5)
Description: Optional record defining a square area of cells to "merged" into one cell.
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a MergedCellsRecord and sets its fields appropriatelyMergeCellsRecord(CellRangeAddress[] regions, int startIndex, int numberOfRegions) -
Method Summary
Modifier and TypeMethodDescriptionclone()getAreaAt(int index) protected intshortget the number of merged areas.shortgetSid()return the non static version of the id for this record.voidWrite the data content of this BIFF record.toString()get a string representation of the record (for biffview/debugging)Methods inherited from class org.apache.poi.hssf.record.StandardRecord
getRecordSize, serializeMethods inherited from class org.apache.poi.hssf.record.Record
cloneViaReserialise, serialize
-
Field Details
-
sid
public static final short sid- See Also:
-
-
Constructor Details
-
MergeCellsRecord
-
MergeCellsRecord
Constructs a MergedCellsRecord and sets its fields appropriately- Parameters:
in- the RecordInputstream to read the record from
-
-
Method Details
-
getNumAreas
public short getNumAreas()get the number of merged areas. If this drops down to 0 you should just go ahead and delete the record.- Returns:
- number of areas
-
getAreaAt
- Parameters:
index- the n-th MergedRegion- Returns:
- MergedRegion at the given index representing the area that is Merged (r1,c1 - r2,c2)
-
getDataSize
protected int getDataSize()- Specified by:
getDataSizein classStandardRecord
-
getSid
public short getSid()Description copied from class:Recordreturn the non static version of the id for this record. -
serialize
Description copied from class:StandardRecordWrite 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:
serializein classStandardRecord- Parameters:
out- the output object
-
toString
Description copied from class:Recordget a string representation of the record (for biffview/debugging) -
clone
-