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:
java.lang.Cloneable
public final class MergeCellsRecord extends StandardRecord implements java.lang.Cloneable
Title: Merged Cells Record (0x00E5)Description: Optional record defining a square area of cells to "merged" into one cell.
-
-
Field Summary
Fields Modifier and Type Field Description static short
sid
-
Constructor Summary
Constructors Constructor Description MergeCellsRecord(RecordInputStream in)
Constructs a MergedCellsRecord and sets its fields appropriatelyMergeCellsRecord(CellRangeAddress[] regions, int startIndex, int numberOfRegions)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MergeCellsRecord
clone()
CellRangeAddress
getAreaAt(int index)
short
getNumAreas()
get the number of merged areas.short
getSid()
return the non static version of the id for this record.void
serialize(LittleEndianOutput out)
java.lang.String
toString()
get a string representation of the record (for biffview/debugging)-
Methods inherited from class org.apache.poi.hssf.record.StandardRecord
getRecordSize, serialize
-
Methods inherited from class org.apache.poi.hssf.record.Record
cloneViaReserialise, serialize
-
-
-
-
Field Detail
-
sid
public static final short sid
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
MergeCellsRecord
public MergeCellsRecord(CellRangeAddress[] regions, int startIndex, int numberOfRegions)
-
MergeCellsRecord
public MergeCellsRecord(RecordInputStream in)
Constructs a MergedCellsRecord and sets its fields appropriately- Parameters:
in
- the RecordInputstream to read the record from
-
-
Method Detail
-
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
public CellRangeAddress getAreaAt(int index)
- Parameters:
index
- the n-th MergedRegion- Returns:
- MergedRegion at the given index representing the area that is Merged (r1,c1 - r2,c2)
-
getSid
public short getSid()
Description copied from class:Record
return the non static version of the id for this record.
-
serialize
public void serialize(LittleEndianOutput out)
-
toString
public java.lang.String toString()
Description copied from class:Record
get a string representation of the record (for biffview/debugging)
-
clone
public MergeCellsRecord clone()
-
-