Package org.apache.poi.ddf
Class EscherSpgrRecord
java.lang.Object
org.apache.poi.ddf.EscherRecord
org.apache.poi.ddf.EscherSpgrRecord
- All Implemented Interfaces:
Cloneable
The spgr record defines information about a shape group. Groups in escher
are simply another form of shape that you can't physically see.
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionintfillFields(byte[] data, int offset, EscherRecordFactory recordFactory) The contract of this method is to deserialize an escher record including it's children.protected Object[][]For the purpose of providing toString() and toXml() a subclass can either override those methods or provide a Object[][] array in the form{ { "Attribute Name (Header)", value, "optional attribute", value }, ... }.shortReturn the current record id.Subclasses should return the short name for this escher record.intSubclasses should effeciently return the number of bytes required to serialize the record.intThe starting top-left coordinate of child records.intThe bottom-right x coordinate of child records.intThe top-left coordinate of child records.intThe bottom-right y coordinate of child records.intserialize(int offset, byte[] data, EscherSerializationListener listener) Serializes the record to an existing byte array.voidsetRectX1(int x1) The top-left coordinate of child records.voidsetRectX2(int x2) The bottom-right x coordinate of child records.voidsetRectY1(int y1) The top-left y coordinate of child records.voidsetRectY2(int rectY2) The bottom-right y coordinate of child records.Methods inherited from class org.apache.poi.ddf.EscherRecord
clone, display, fillFields, getChild, getChildRecords, getInstance, getOptions, getVersion, isContainerRecord, readHeader, readInstance, serialize, serialize, setChildRecords, setInstance, setOptions, setRecordId, setVersion, toString, toXml, toXml
-
Field Details
-
RECORD_ID
public static final short RECORD_ID- See Also:
-
RECORD_DESCRIPTION
- See Also:
-
-
Constructor Details
-
EscherSpgrRecord
public EscherSpgrRecord()
-
-
Method Details
-
fillFields
Description copied from class:EscherRecordThe contract of this method is to deserialize an escher record including it's children.- Specified by:
fillFieldsin classEscherRecord- Parameters:
data- The byte array containing the serialized escher records.offset- The offset into the byte array.recordFactory- A factory for creating new escher records.- Returns:
- The number of bytes written.
-
serialize
Description copied from class:EscherRecordSerializes the record to an existing byte array.- Specified by:
serializein classEscherRecord- Parameters:
offset- the offset within the byte arraydata- the data array to serialize tolistener- a listener for begin and end serialization events. This is useful because the serialization is hierarchical/recursive and sometimes you need to be able break into that.- Returns:
- the number of bytes written.
-
getRecordSize
public int getRecordSize()Description copied from class:EscherRecordSubclasses should effeciently return the number of bytes required to serialize the record.- Specified by:
getRecordSizein classEscherRecord- Returns:
- number of bytes
-
getRecordId
public short getRecordId()Description copied from class:EscherRecordReturn the current record id.- Overrides:
getRecordIdin classEscherRecord- Returns:
- The 16 bit record id.
-
getRecordName
Description copied from class:EscherRecordSubclasses should return the short name for this escher record.- Specified by:
getRecordNamein classEscherRecord- Returns:
- the short name for this escher record
-
getRectX1
public int getRectX1()The starting top-left coordinate of child records.- Returns:
- the top-left x coordinate
-
setRectX1
public void setRectX1(int x1) The top-left coordinate of child records.- Parameters:
x1- the top-left x coordinate
-
getRectY1
public int getRectY1()The top-left coordinate of child records.- Returns:
- the top-left y coordinate
-
setRectY1
public void setRectY1(int y1) The top-left y coordinate of child records.- Parameters:
y1- the top-left y coordinate
-
getRectX2
public int getRectX2()The bottom-right x coordinate of child records.- Returns:
- the bottom-right x coordinate
-
setRectX2
public void setRectX2(int x2) The bottom-right x coordinate of child records.- Parameters:
x2- the bottom-right x coordinate
-
getRectY2
public int getRectY2()The bottom-right y coordinate of child records.- Returns:
- the bottom-right y coordinate
-
setRectY2
public void setRectY2(int rectY2) The bottom-right y coordinate of child records.- Parameters:
rectY2- the bottom-right y coordinate
-
getAttributeMap
Description copied from class:EscherRecordFor the purpose of providing toString() and toXml() a subclass can either override those methods or provide a Object[][] array in the form{ { "Attribute Name (Header)", value, "optional attribute", value }, ... }.Null values won't be printed.
The attributes record, version, instance, options must not be returned.
- Specified by:
getAttributeMapin classEscherRecord- Returns:
- the attribute map
-