Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.poi.hslf.record
Class HSLFEscherClientDataRecord

    java.lang.Object
      org.apache.poi.ddf.EscherRecord
          org.apache.poi.ddf.EscherClientDataRecord
              org.apache.poi.hslf.record.HSLFEscherClientDataRecord

All Implemented Interfaces:
  java.lang.Cloneable

    public class HSLFEscherClientDataRecord

extends EscherClientDataRecord

An atom record that specifies whether a shape is a placeholder shape. The number, position, and type of placeholder shapes are determined by the slide layout as specified in the SlideAtom record.

Since:
  POI 3.14-Beta2

Field Summary

Fields inherited from class org.apache.poi.ddf.EscherClientDataRecord
`RECORD_DESCRIPTION, RECORD_ID`

Constructor Summary
`HSLFEscherClientDataRecord()`

Method Summary
`void` | `addChild(Record childRecord)`
`int` | `fillFields(byte[] data, int offset, EscherRecordFactory recordFactory)` The contract of this method is to deserialize an escher record including it's children.
`java.util.List<? extends Record>` | `getHSLFChildRecords()`
`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.
`void` | `removeChild(java.lang.Class<? extends Record> childClass)`
`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.

Methods inherited from class org.apache.poi.ddf.EscherClientDataRecord
`getAttributeMap, getRecordId`

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, toString, toXml, toXml`

Methods inherited from class java.lang.Object
`equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

### HSLFEscherClientDataRecord

    public HSLFEscherClientDataRecord()

Method Detail

### getHSLFChildRecords

    public java.util.List<? extends Record> getHSLFChildRecords()

### removeChild

    public void removeChild(java.lang.Class<? extends Record> childClass)

### addChild

    public void addChild(Record childRecord)

### 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.

  Overrides:
    `fillFields` in class `EscherClientDataRecord`
  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.

  Overrides:
    `serialize` in class `EscherClientDataRecord`
  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.

  Overrides:
    `getRecordSize` in class `EscherClientDataRecord`
  Returns:
    number of bytes

### getRemainingData

    public byte[] getRemainingData()

  Description copied from class: `EscherClientDataRecord`
  Any data recording this record.

  Overrides:
    `getRemainingData` in class `EscherClientDataRecord`
  Returns:
    the remaining bytes

### setRemainingData

    public void setRemainingData(byte[] remainingData)

  Description copied from class: `EscherClientDataRecord`
  Any data recording this record.

  Overrides:
    `setRemainingData` in class `EscherClientDataRecord`
  Parameters:
    `remainingData` - the remaining bytes

### getRecordName

    public java.lang.String getRecordName()

  Description copied from class: `EscherRecord`
  Subclasses should return the short name for this escher record.

  Overrides:
    `getRecordName` in class `EscherClientDataRecord`
  Returns:
    the short name for this escher record

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright 2017 The Apache Software Foundation or its licensors, as applicable.