org.apache.poi.ddf
Class EscherClientDataRecord

java.lang.Object
  org.apache.poi.ddf.EscherRecord
      org.apache.poi.ddf.EscherClientDataRecord

public class EscherClientDataRecord
extends EscherRecord

The EscherClientDataRecord is used to store client specific data about the position of a shape within a container.

Author:

Glen Stampoultzis

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) This method deserializes the record from a byte array.
short	getRecordId() Returns the identifier of this record.
java.lang.String	getRecordName() The short name for this record
int	getRecordSize() Returns the number of bytes that are required to serialize this record.
byte[]	getRemainingData() Any data recording this record.
int	serialize(int offset, byte[] data, EscherSerializationListener listener) This method serializes this escher record into a 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, isContainerRecord, readHeader, serialize, serialize, setChildRecords, setOptions, setRecordId

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

RECORD_ID

public static final short RECORD_ID

See Also:

Constant Field Values

RECORD_DESCRIPTION

public static final java.lang.String RECORD_DESCRIPTION

See Also:

Constant Field Values

Constructor Detail

EscherClientDataRecord

public EscherClientDataRecord()

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 class EscherRecord

Parameters:

data - The byte array containing the escher record information

offset - The starting offset into data.

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 class EscherRecord

Parameters:

offset - The offset into data to start writing the record data to.

data - The byte array to serialize to.

listener - A listener to retrieve start and end callbacks. Use a NullEscherSerailizationListener 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 class EscherRecord

Returns:

Number of bytes

getRecordId

public short getRecordId()

Returns the identifier of this record.

Overrides:

getRecordId in class EscherRecord

Returns:

The 16 bit record id.

getRecordName

public java.lang.String getRecordName()

The short name for this record

Specified by:

getRecordName in class EscherRecord

toString

public java.lang.String toString()

Returns the string representation of this record.

Overrides:

toString in class java.lang.Object

getRemainingData

public byte[] getRemainingData()

Any data recording this record.

setRemainingData

public void setRemainingData(byte[] remainingData)

Any data recording this record.