Package loci.poi.ddf
Class EscherSpgrRecord
- java.lang.Object
-
- loci.poi.ddf.EscherRecord
-
- loci.poi.ddf.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)
-
-
Field Summary
Fields Modifier and Type Field Description static String
RECORD_DESCRIPTION
static short
RECORD_ID
-
Constructor Summary
Constructors Constructor Description EscherSpgrRecord()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
fillFields(byte[] data, int offset, EscherRecordFactory recordFactory)
This method deserializes the record from a byte array.short
getRecordId()
The 16 bit identifier of this shape group record.String
getRecordName()
The short name for this recordint
getRecordSize()
Returns the number of bytes that are required to serialize this record.int
getRectX1()
The starting top-left coordinate of child records.int
getRectX2()
The starting bottom-right coordinate of child records.int
getRectY1()
The starting top-left coordinate of child records.int
getRectY2()
The starting bottom-right coordinate of child records.int
serialize(int offset, byte[] data, EscherSerializationListener listener)
This method serializes this escher record into a byte array.void
setRectX1(int x1)
The starting top-left coordinate of child records.void
setRectX2(int x2)
The starting bottom-right coordinate of child records.void
setRectY1(int y1)
The starting top-left coordinate of child records.void
setRectY2(int field_4_rectY2)
The starting bottom-right coordinate of child records.String
toString()
-
Methods inherited from class loci.poi.ddf.EscherRecord
clone, display, fillFields, getChild, getChildRecords, getInstance, getOptions, isContainerRecord, readHeader, serialize, serialize, setChildRecords, setOptions, setRecordId
-
-
-
-
Field Detail
-
RECORD_ID
public static final short RECORD_ID
- See Also:
- Constant Field Values
-
RECORD_DESCRIPTION
public static final String RECORD_DESCRIPTION
- See Also:
- Constant Field Values
-
-
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 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
public int serialize(int offset, byte[] data, EscherSerializationListener listener)
This method serializes this escher record into a byte array.- Specified by:
serialize
in classEscherRecord
- Parameters:
offset
- The offset intodata
to start writing the record data to.data
- The byte array to serialize to.listener
- A listener to retrieve start and end callbacks. Use aNullEscherSerailizationListener
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 classEscherRecord
- Returns:
- Number of bytes
-
getRecordId
public short getRecordId()
The 16 bit identifier of this shape group record.- Overrides:
getRecordId
in classEscherRecord
- Returns:
- The 16 bit record id.
-
getRecordName
public String getRecordName()
The short name for this record- Specified by:
getRecordName
in classEscherRecord
-
toString
public String 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.
-
-