Package 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:
org.apache.poi.common.Duplicatable
,GenericRecord
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_ID
-
-
Constructor Summary
Constructors Constructor Description HSLFEscherClientDataRecord()
HSLFEscherClientDataRecord(HSLFEscherClientDataRecord other)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addChild(Record childRecord)
HSLFEscherClientDataRecord
copy()
int
fillFields(byte[] data, int offset, EscherRecordFactory recordFactory)
The contract of this method is to deserialize an escher record including its 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
getGenericProperties, getGenericRecordType, getMaxRecordLength, getRecordId, setMaxRecordLength
-
Methods inherited from class org.apache.poi.ddf.EscherRecord
display, getChild, getChildRecords, getGenericChildren, getInstance, getOptions, getVersion, isContainerRecord, serialize, serialize, setChildRecords, setInstance, setOptions, setRecordId, setVersion, toString, toXml, toXml
-
-
-
-
Constructor Detail
-
HSLFEscherClientDataRecord
public HSLFEscherClientDataRecord()
-
HSLFEscherClientDataRecord
public HSLFEscherClientDataRecord(HSLFEscherClientDataRecord other)
-
-
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 its children.- Overrides:
fillFields
in classEscherClientDataRecord
- 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 classEscherClientDataRecord
- Parameters:
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.- 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 classEscherClientDataRecord
- Returns:
- number of bytes
-
getRemainingData
public byte[] getRemainingData()
Description copied from class:EscherClientDataRecord
Any data recording this record.- Overrides:
getRemainingData
in classEscherClientDataRecord
- Returns:
- the remaining bytes
-
setRemainingData
public void setRemainingData(byte[] remainingData)
Description copied from class:EscherClientDataRecord
Any data recording this record.- Overrides:
setRemainingData
in classEscherClientDataRecord
- 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 classEscherClientDataRecord
- Returns:
- the short name for this escher record
-
copy
public HSLFEscherClientDataRecord copy()
- Specified by:
copy
in interfaceorg.apache.poi.common.Duplicatable
- Overrides:
copy
in classEscherClientDataRecord
-
-