EscherClientDataRecord (POI API Documentation)

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

All Implemented Interfaces:

java.lang.Cloneable
```
public class EscherClientDataRecord
extends EscherRecord
```
The EscherClientDataRecord is used to store client specific data about the position of a shape within a container.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String RECORD_DESCRIPTION

static short RECORD_ID

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`RECORD_DESCRIPTION`
`static short`	`RECORD_ID`

Constructor Summary

Constructors
Constructor and Description

EscherClientDataRecord()

Constructors
Constructor and Description
`EscherClientDataRecord()`

Method Summary

Methods
Modifier and Type	Method and Description
`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.
`java.lang.String`	`toXml(java.lang.String tab)`

Methods inherited from class org.apache.poi.ddf.EscherRecord
clone, display, fillFields, formatXmlRecordHeader, getChild, getChildRecords, getInstance, getOptions, getVersion, isContainerRecord, readHeader, readInstance, serialize, serialize, setChildRecords, setInstance, setOptions, setRecordId, setVersion, toXml

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)
```
    Description copied from class: EscherRecord
    
    The contract of this method is to deserialize an escher record including it's children.
    
    Specified by:
    
    fillFields in class EscherRecord
    
    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
```
public int serialize(int offset,
            byte[] data,
            EscherSerializationListener listener)
```
    Description copied from class: EscherRecord
    
    Serializes the record to an existing byte array.
    
    Specified by:
    
    serialize in class EscherRecord
    
    Parameters:
    offset - the offset within the byte array
    data - the data array to serialize to
    listener - 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: EscherRecord
    
    Subclasses should effeciently return the number of bytes required to serialize the record.
    
    Specified by:
    
    getRecordSize in class EscherRecord
    
    Returns:
    number of bytes
  - getRecordId
```
public short getRecordId()
```
    Description copied from class: EscherRecord
    
    Return the current record id.
    
    Overrides:
    
    getRecordId in class EscherRecord
    
    Returns:
    The 16 bit record id.
  - getRecordName
```
public java.lang.String getRecordName()
```
    Description copied from class: EscherRecord
    
    Subclasses should return the short name for this escher record.
    
    Specified by:
    
    getRecordName in class EscherRecord
    
    Returns:
    the short name for this escher record
  - toString
```
public java.lang.String toString()
```
    Returns the string representation of this record.
    
    Overrides:
    
    toString in class java.lang.Object
  - toXml
```
public java.lang.String toXml(java.lang.String tab)
```
    Overrides:
    
    toXml in class EscherRecord
    
    Parameters:
    tab - - each children must be a right of his parent
    
    Returns:
    xml representation of this record
  - getRemainingData
```
public byte[] getRemainingData()
```
    Any data recording this record.
    
    Returns:
    the remaining bytes
  - setRemainingData
```
public void setRemainingData(byte[] remainingData)
```
    Any data recording this record.
    
    Parameters:
    remainingData - the remaining bytes

Class EscherClientDataRecord

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.apache.poi.ddf.EscherRecord

Methods inherited from class java.lang.Object

Field Detail

RECORD_ID

RECORD_DESCRIPTION

Constructor Detail

EscherClientDataRecord

Method Detail

fillFields

serialize

getRecordSize

getRecordId

getRecordName

toString

toXml

getRemainingData

setRemainingData