Package loci.poi.ddf
Class EscherSpgrRecord
java.lang.Object
loci.poi.ddf.EscherRecord
loci.poi.ddf.EscherSpgrRecord
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)
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionintfillFields(byte[] data, int offset, EscherRecordFactory recordFactory) This method deserializes the record from a byte array.shortThe 16 bit identifier of this shape group record.The short name for this recordintReturns the number of bytes that are required to serialize this record.intThe starting top-left coordinate of child records.intThe starting bottom-right coordinate of child records.intThe starting top-left coordinate of child records.intThe starting bottom-right coordinate of child records.intserialize(int offset, byte[] data, EscherSerializationListener listener) This method serializes this escher record into a byte array.voidsetRectX1(int x1) The starting top-left coordinate of child records.voidsetRectX2(int x2) The starting bottom-right coordinate of child records.voidsetRectY1(int y1) The starting top-left coordinate of child records.voidsetRectY2(int field_4_rectY2) The starting bottom-right coordinate of child records.toString()Methods inherited from class loci.poi.ddf.EscherRecord
clone, display, fillFields, getChild, getChildRecords, getInstance, getOptions, isContainerRecord, readHeader, serialize, serialize, setChildRecords, setOptions, setRecordId
-
Field Details
-
RECORD_ID
public static final short RECORD_ID- See Also:
-
RECORD_DESCRIPTION
- See Also:
-
-
Constructor Details
-
EscherSpgrRecord
public EscherSpgrRecord()
-
-
Method Details
-
fillFields
This method deserializes the record from a byte array.- Specified by:
fillFieldsin classEscherRecord- Parameters:
data- The byte array containing the escher record informationoffset- The starting offset intodata.recordFactory- May be null since this is not a container record.- Returns:
- The number of bytes read from the byte array.
-
serialize
This method serializes this escher record into a byte array.- Specified by:
serializein classEscherRecord- Parameters:
offset- The offset intodatato start writing the record data to.data- The byte array to serialize to.listener- A listener to retrieve start and end callbacks. Use aNullEscherSerailizationListenerto ignore these events.- Returns:
- The number of bytes written.
- See Also:
-
getRecordSize
public int getRecordSize()Returns the number of bytes that are required to serialize this record.- Specified by:
getRecordSizein classEscherRecord- Returns:
- Number of bytes
-
getRecordId
public short getRecordId()The 16 bit identifier of this shape group record.- Overrides:
getRecordIdin classEscherRecord- Returns:
- The 16 bit record id.
-
getRecordName
The short name for this record- Specified by:
getRecordNamein classEscherRecord
-
toString
-
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.
-