org.apache.poi.hssf.record

Class DrawingGroupRecord

java.lang.Object

org.apache.poi.hssf.record.RecordBase

org.apache.poi.hssf.record.Record

org.apache.poi.hssf.record.AbstractEscherHolderRecord

org.apache.poi.hssf.record.DrawingGroupRecord

All Implemented Interfaces:

Duplicatable, GenericRecord

public final class DrawingGroupRecord
extends AbstractEscherHolderRecord

Specifies a group of drawing objects.

Contains a single OfficeArtDggContainer that specifies the group of drawing objects. Get the EscherContainerRecord representation via AbstractEscherHolderRecord.getEscherContainer().

Referred to as an MsoDrawingGroup in [MS-XLS].pdf v20190618.

Field Summary

Fields

Modifier and Type	Field and Description
static short	sid

Constructor Summary

Constructors

Constructor and Description
DrawingGroupRecord()
DrawingGroupRecord(DrawingGroupRecord other)
DrawingGroupRecord(RecordInputStream in)

Method Summary

Modifier and Type	Method and Description
DrawingGroupRecord	copy()
Map<String,Supplier<?>>	getGenericProperties()
HSSFRecordTypes	getGenericRecordType()
static int	getMaxRecordSize()
protected String	getRecordName()
int	getRecordSize() gives the current serialized size of the record.
short	getSid() return the non static version of the id for this record.
void	processChildRecords() Deprecated. Call AbstractEscherHolderRecord.decode() instead.
int	serialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.
static void	setMaxRecordSize(int size)

Methods inherited from class org.apache.poi.hssf.record.AbstractEscherHolderRecord

addEscherRecord, addEscherRecord, clearEscherRecords, convertRawBytesToEscherRecords, decode, findFirstWithId, getEscherContainer, getEscherRecord, getEscherRecords, getGenericChildren, getRawData, join, processContinueRecord, setRawData

Methods inherited from class org.apache.poi.hssf.record.Record

cloneViaReserialise, serialize, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

sid

public static final short sid

See Also:

Constant Field Values

Constructor Detail

DrawingGroupRecord

public DrawingGroupRecord()

DrawingGroupRecord

public DrawingGroupRecord(DrawingGroupRecord other)

DrawingGroupRecord

public DrawingGroupRecord(RecordInputStream in)

Method Detail

setMaxRecordSize

public static void setMaxRecordSize(int size)

Parameters:

size - the max record size allowed for DrawingGroupRecord

getMaxRecordSize

public static int getMaxRecordSize()

Returns:

the max record size allowed for DrawingGroupRecord

getRecordName

protected String getRecordName()

Specified by:

getRecordName in class AbstractEscherHolderRecord

getSid

public short getSid()

Description copied from class: Record

return the non static version of the id for this record.

Specified by:

getSid in class AbstractEscherHolderRecord

Returns:

he id for this record

serialize

public int serialize(int offset,
                     byte[] data)

Description copied from class: RecordBase

called by the class that is responsible for writing this sucker. Subclasses should implement this so that their data is passed back in a byte array.

Overrides:

serialize in class AbstractEscherHolderRecord

Parameters:

offset - to begin writing at

data - byte array containing instance data

Returns:

number of bytes written

processChildRecords

@Removal(version="5.3")
 @Deprecated
public void processChildRecords()

Deprecated. Call AbstractEscherHolderRecord.decode() instead.

Process the bytes into escher records. (Not done by default in case we break things, unless you set the "poi.deserialize.escher" system property)

getRecordSize

public int getRecordSize()

Description copied from class: RecordBase

gives the current serialized size of the record. Should include the sid and reclength (4 bytes).

Overrides:

getRecordSize in class AbstractEscherHolderRecord

Returns:

the record size

copy

public DrawingGroupRecord copy()

Specified by:

copy in interface Duplicatable

Specified by:

copy in class AbstractEscherHolderRecord

Returns:

a deep copy of the implementing class / instance

getGenericRecordType

public HSSFRecordTypes getGenericRecordType()

Specified by:

getGenericRecordType in interface GenericRecord

Specified by:

getGenericRecordType in class Record

getGenericProperties

public Map<String,Supplier<?>> getGenericProperties()