|
||||||||||
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.EscherClientDataRecord
public class EscherClientDataRecord
The EscherClientDataRecord is used to store client specific data about the position of a shape within a container.
Field Summary | |
---|---|
static java.lang.String |
RECORD_DESCRIPTION
|
static short |
RECORD_ID
|
Constructor Summary | |
---|---|
EscherClientDataRecord()
|
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. |
byte[] |
getRemainingData()
Any data recording this record. |
int |
serialize(int offset,
byte[] data,
EscherSerializationListener listener)
Serializes the record to an existing byte array. |
void |
setRemainingData(byte[] remainingData)
Any data recording this record. |
java.lang.String |
toString()
Returns the string representation of this record. |
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 EscherClientDataRecord()
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 byte[] getRemainingData()
public void setRemainingData(byte[] remainingData)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |