Package loci.poi.ddf

Class EscherSpgrRecord


  • public class EscherSpgrRecord
    extends EscherRecord
    The spgr record defines information about a shape group. Groups in escher are simply another form of shape that you can't physically see.
    Author:
    Glen Stampoultzis (glens at apache.org)
    • Constructor Detail

      • EscherSpgrRecord

        public EscherSpgrRecord()
    • Method Detail

      • fillFields

        public int fillFields​(byte[] data,
                              int offset,
                              EscherRecordFactory recordFactory)
        This method deserializes the record from a byte array.
        Specified by:
        fillFields in class EscherRecord
        Parameters:
        data - The byte array containing the escher record information
        offset - The starting offset into data.
        recordFactory - May be null since this is not a container record.
        Returns:
        The number of bytes read from the byte array.
      • serialize

        public int serialize​(int offset,
                             byte[] data,
                             EscherSerializationListener listener)
        This method serializes this escher record into a byte array.
        Specified by:
        serialize in class EscherRecord
        Parameters:
        offset - The offset into data to start writing the record data to.
        data - The byte array to serialize to.
        listener - A listener to retrieve start and end callbacks. Use a NullEscherSerailizationListener to ignore these events.
        Returns:
        The number of bytes written.
        See Also:
        NullEscherSerializationListener
      • getRecordSize

        public int getRecordSize()
        Returns the number of bytes that are required to serialize this record.
        Specified by:
        getRecordSize in class EscherRecord
        Returns:
        Number of bytes
      • getRecordId

        public short getRecordId()
        The 16 bit identifier of this shape group record.
        Overrides:
        getRecordId in class EscherRecord
        Returns:
        The 16 bit record id.
      • toString

        public String toString()
        Overrides:
        toString in class Object
        Returns:
        the string representation of this record.
      • getRectX1

        public int getRectX1()
        The starting top-left coordinate of child records.
      • setRectX1

        public void setRectX1​(int x1)
        The starting top-left coordinate of child records.
      • getRectY1

        public int getRectY1()
        The starting top-left coordinate of child records.
      • setRectY1

        public void setRectY1​(int y1)
        The starting top-left coordinate of child records.
      • getRectX2

        public int getRectX2()
        The starting bottom-right coordinate of child records.
      • setRectX2

        public void setRectX2​(int x2)
        The starting bottom-right coordinate of child records.
      • getRectY2

        public int getRectY2()
        The starting bottom-right coordinate of child records.
      • setRectY2

        public void setRectY2​(int field_4_rectY2)
        The starting bottom-right coordinate of child records.