Package loci.poi.ddf
Class EscherClientDataRecord
java.lang.Object
loci.poi.ddf.EscherRecord
loci.poi.ddf.EscherClientDataRecord
The EscherClientDataRecord is used to store client specific data about the position of a
shape within a container.
- Author:
- Glen Stampoultzis
-
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.shortReturns the identifier of this record.The short name for this recordintReturns the number of bytes that are required to serialize this record.byte[]Any data recording this record.intserialize(int offset, byte[] data, EscherSerializationListener listener) This method serializes this escher record into a byte array.voidsetRemainingData(byte[] remainingData) Any data recording this record.toString()Returns the string representation of this record.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
-
EscherClientDataRecord
public EscherClientDataRecord()
-
-
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()Returns the identifier of this record.- Overrides:
getRecordIdin classEscherRecord- Returns:
- The 16 bit record id.
-
getRecordName
The short name for this record- Specified by:
getRecordNamein classEscherRecord
-
toString
Returns the string representation of this record. -
getRemainingData
public byte[] getRemainingData()Any data recording this record. -
setRemainingData
public void setRemainingData(byte[] remainingData) Any data recording this record.
-