|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.poi.ddf.EscherRecord org.apache.poi.ddf.EscherSpgrRecord
public class 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.
Field Summary | |
---|---|
static java.lang.String |
RECORD_DESCRIPTION
|
static short |
RECORD_ID
|
Constructor Summary | |
---|---|
EscherSpgrRecord()
|
Method Summary | |
---|---|
int |
fillFields(byte[] data,
int offset,
EscherRecordFactory recordFactory)
The contract of this method is to deserialize an escher record including it's children. |
short |
getRecordId()
Return the current record id. |
java.lang.String |
getRecordName()
Subclasses should return the short name for this escher record. |
int |
getRecordSize()
Subclasses should effeciently return the number of bytes required to serialize the 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)
Serializes the record to an existing 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 rectY2)
The starting bottom-right coordinate of child records. |
java.lang.String |
toString()
|
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 |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final short RECORD_ID
public static final java.lang.String RECORD_DESCRIPTION
Constructor Detail |
---|
public EscherSpgrRecord()
Method Detail |
---|
public int fillFields(byte[] data, int offset, EscherRecordFactory recordFactory)
EscherRecord
fillFields
in class EscherRecord
data
- The byte array containing the serialized escher
records.offset
- The offset into the byte array.recordFactory
- A factory for creating new escher records.
public int serialize(int offset, byte[] data, EscherSerializationListener listener)
EscherRecord
serialize
in class EscherRecord
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.
public int getRecordSize()
EscherRecord
getRecordSize
in class EscherRecord
public short getRecordId()
EscherRecord
getRecordId
in class EscherRecord
public java.lang.String getRecordName()
EscherRecord
getRecordName
in class EscherRecord
public java.lang.String toString()
toString
in class java.lang.Object
public int getRectX1()
public void setRectX1(int x1)
public int getRectY1()
public void setRectY1(int y1)
public int getRectX2()
public void setRectX2(int x2)
public int getRectY2()
public void setRectY2(int rectY2)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |