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:
org.apache.poi.common.Duplicatable
,GenericRecord
public final class MergeCellsRecord extends StandardRecord
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(MergeCellsRecord other)
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
copy()
CellRangeAddress
getAreaAt(int index)
java.util.Map<java.lang.String,java.util.function.Supplier<?>>
getGenericProperties()
HSSFRecordTypes
getGenericRecordType()
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)
-
Methods inherited from class org.apache.poi.hssf.record.StandardRecord
getRecordSize, serialize
-
Methods inherited from class org.apache.poi.hssf.record.Record
cloneViaReserialise, serialize, toString
-
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.apache.poi.common.usermodel.GenericRecord
getGenericChildren
-
-
-
-
Field Detail
-
sid
public static final short sid
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
MergeCellsRecord
public MergeCellsRecord(MergeCellsRecord other)
-
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)
-
copy
public MergeCellsRecord copy()
- Specified by:
copy
in interfaceorg.apache.poi.common.Duplicatable
- Specified by:
copy
in classStandardRecord
-
getGenericRecordType
public HSSFRecordTypes getGenericRecordType()
- Specified by:
getGenericRecordType
in interfaceGenericRecord
- Specified by:
getGenericRecordType
in classRecord
-
getGenericProperties
public java.util.Map<java.lang.String,java.util.function.Supplier<?>> getGenericProperties()
-
-