Top Description Fields Constructors Methods
org.apache.poi.hssf.record

public final Class DrawingGroupRecord

extends AbstractEscherHolderRecord
Class Inheritance
Imports
java.util.List, .Map, java.util.function.Supplier, org.apache.poi.ddf.EscherRecord, .EscherRecordTypes, .NullEscherSerializationListener, org.apache.poi.util.LittleEndian, .Removal
Specifies a group of drawing objects.

Contains a single OfficeArtDggContainer that specifies the group of drawing objects. Get the org.apache.poi.ddf.EscherContainerRecord representation via getEscherContainer().

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

Field Summary

Modifier and TypeField and Description
private static final int
DEFAULT_MAX_RECORD_SIZE

private static int
MAX_RECORD_SIZE

public static final short
sid

Constructor Summary

AccessConstructor and Description
public
DrawingGroupRecord()

public
DrawingGroupRecord(DrawingGroupRecord other)

public
DrawingGroupRecord(RecordInputStream in)

Method Summary

Modifier and TypeMethod and Description
public DrawingGroupRecord
copy()

Implements abstract org.apache.poi.hssf.record.AbstractEscherHolderRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

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

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

public HSSFRecordTypes
getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.

private static int
getMaxDataSize()

public static int

Returns:

the max record size allowed for DrawingGroupRecord
getMaxRecordSize()

private int
getRawDataSize()

protected String
getRecordName()

Implements abstract org.apache.poi.hssf.record.AbstractEscherHolderRecord.getRecordName.

public int
getRecordSize()

Overrides org.apache.poi.hssf.record.AbstractEscherHolderRecord.getRecordSize.

gives the current serialized size of the record.

public short
getSid()

Implements abstract org.apache.poi.hssf.record.AbstractEscherHolderRecord.getSid.

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

pack-priv static int
grossSizeFromDataSize(int dataSize)

public void
processChildRecords()
Deprecated Call decode() instead.

Process the bytes into escher records.

public int
serialize(int
to begin writing at
offset, byte[]
byte array containing instance data
data)

Overrides org.apache.poi.hssf.record.AbstractEscherHolderRecord.serialize.

called by the class that is responsible for writing this sucker.

public static void
setMaxRecordSize(int
the max record size allowed for DrawingGroupRecord
size)

private void
writeContinueHeader(byte[] data, int offset, int sizeExcludingHeader)

private int
writeData(int offset, byte[] data, byte[] rawData)

private void
writeHeader(byte[] data, int offset, int sizeExcludingHeader)

Inherited from org.apache.poi.hssf.record.AbstractEscherHolderRecord:
addEscherRecordaddEscherRecordclearEscherRecordsconvertRawBytesToEscherRecordsdecodefindFirstWithIdgetEscherContainergetEscherRecordgetEscherRecordsgetGenericChildrengetRawDatajoinprocessContinueRecordsetRawData

Field Detail

DEFAULT_MAX_RECORD_SIZEback to summary
private static final int DEFAULT_MAX_RECORD_SIZE
MAX_RECORD_SIZEback to summary
private static int MAX_RECORD_SIZE
sidback to summary
public static final short sid

Constructor Detail

DrawingGroupRecordback to summary
public DrawingGroupRecord()
DrawingGroupRecordback to summary
public DrawingGroupRecord(DrawingGroupRecord other)
DrawingGroupRecordback to summary
public DrawingGroupRecord(RecordInputStream in)

Method Detail

copyback to summary
public DrawingGroupRecord copy()

Implements abstract org.apache.poi.hssf.record.AbstractEscherHolderRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

Returns:DrawingGroupRecord

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

Annotations
@Override
getGenericPropertiesback to summary
public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations
@Override
getGenericRecordTypeback to summary
public HSSFRecordTypes getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.

Annotations
@Override
getMaxDataSizeback to summary
private static int getMaxDataSize()
getMaxRecordSizeback to summary
public static int getMaxRecordSize()
Returns:int

the max record size allowed for DrawingGroupRecord

getRawDataSizeback to summary
private int getRawDataSize()
getRecordNameback to summary
protected String getRecordName()

Implements abstract org.apache.poi.hssf.record.AbstractEscherHolderRecord.getRecordName.

getRecordSizeback to summary
public int getRecordSize()

Overrides org.apache.poi.hssf.record.AbstractEscherHolderRecord.getRecordSize.

Doc from org.apache.poi.hssf.record.RecordBase.getRecordSize.

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

Returns:int

the record size

getSidback to summary
public short getSid()

Implements abstract org.apache.poi.hssf.record.AbstractEscherHolderRecord.getSid.

Doc from org.apache.poi.hssf.record.Record.getSid.

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

Returns:short

he id for this record

grossSizeFromDataSizeback to summary
pack-priv static int grossSizeFromDataSize(int dataSize)
processChildRecordsback to summary
public void processChildRecords()

Deprecated

Call 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)

Annotations
@Removal
version:5.3
@Deprecated
serializeback to summary
public int serialize(int offset, byte[] data)

Overrides org.apache.poi.hssf.record.AbstractEscherHolderRecord.serialize.

Doc from org.apache.poi.hssf.record.RecordBase.serialize.

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.

Parameters
offset:int

to begin writing at

data:byte[]

byte array containing instance data

Returns:int

number of bytes written

setMaxRecordSizeback to summary
public static void setMaxRecordSize(int size)
Parameters
size:int

the max record size allowed for DrawingGroupRecord

writeContinueHeaderback to summary
private void writeContinueHeader(byte[] data, int offset, int sizeExcludingHeader)
writeDataback to summary
private int writeData(int offset, byte[] data, byte[] rawData)
writeHeaderback to summary
private void writeHeader(byte[] data, int offset, int sizeExcludingHeader)