Package 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:
org.apache.poi.common.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 Details

  • Constructor Details

    • DrawingGroupRecord

      public DrawingGroupRecord()

    • DrawingGroupRecord

      public DrawingGroupRecord(DrawingGroupRecord other)

    • DrawingGroupRecord

      public DrawingGroupRecord(RecordInputStream in)

  • Method Details

    • 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

    • 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 org.apache.poi.common.Duplicatable
      Specified by:
      copy in class AbstractEscherHolderRecord

    • getGenericRecordType

      public HSSFRecordTypes getGenericRecordType()
      Specified by:
      getGenericRecordType in interface GenericRecord
      Specified by:
      getGenericRecordType in class Record

    • getGenericProperties

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