org.apache.poi.hslf.record

Class EscherPlaceholder

java.lang.Object

org.apache.poi.ddf.EscherRecord

org.apache.poi.hslf.record.EscherPlaceholder

All Implemented Interfaces:

Duplicatable, GenericRecord

public class EscherPlaceholder
extends EscherRecord

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.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
EscherPlaceholder()
EscherPlaceholder(EscherPlaceholder other)

Method Summary

Modifier and Type	Method and Description
EscherPlaceholder	copy()
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.Map<java.lang.String,java.util.function.Supplier<?>>	getGenericProperties()
java.lang.Enum	getGenericRecordType()
byte	getPlacementId()
int	getPosition()
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	getSize()
int	serialize(int offset, byte[] data, EscherSerializationListener listener) Serializes the record to an existing byte array.

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

clone, display, fillFields, getChild, getChildRecords, getGenericChildren, getInstance, getOptions, getRecordId, 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

Field Detail

RECORD_ID

public static final short RECORD_ID

RECORD_DESCRIPTION

public static final java.lang.String RECORD_DESCRIPTION

See Also:

Constant Field Values

Constructor Detail

EscherPlaceholder

public EscherPlaceholder()

EscherPlaceholder

public EscherPlaceholder(EscherPlaceholder other)

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

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

getPosition

public int getPosition()

getPlacementId

public byte getPlacementId()

getSize

public byte getSize()

getGenericProperties

public java.util.Map<java.lang.String,java.util.function.Supplier<?>> getGenericProperties()

Specified by:

getGenericProperties in interface GenericRecord

Overrides:

getGenericProperties in class EscherRecord

getGenericRecordType

public java.lang.Enum getGenericRecordType()

copy

public EscherPlaceholder copy()

Specified by:

copy in interface Duplicatable

Specified by:

copy in class EscherRecord

Returns:

a deep copy of the implementing class / instance