Package org.apache.poi.hslf.record
Class EscherPlaceholder
- java.lang.Object
-
- org.apache.poi.ddf.EscherRecord
-
- org.apache.poi.hslf.record.EscherPlaceholder
-
- All Implemented Interfaces:
java.lang.Cloneable
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 Description static java.lang.String
RECORD_DESCRIPTION
static short
RECORD_ID
-
Constructor Summary
Constructors Constructor Description EscherPlaceholder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
fillFields(byte[] data, int offset, EscherRecordFactory recordFactory)
The contract of this method is to deserialize an escher record including it's children.protected java.lang.Object[][]
getAttributeMap()
For the purpose of providing toString() and toXml() a subclass can either override those methods or provide a Object[][] array in the form{ { "Attribute Name (Header)", value, "optional attribute", value }, ... }
.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.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, getInstance, getOptions, getRecordId, getVersion, isContainerRecord, readHeader, readInstance, serialize, serialize, setChildRecords, setInstance, setOptions, setRecordId, setVersion, toString, toXml, toXml
-
-
-
-
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
-
-
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 classEscherRecord
- 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 classEscherRecord
- 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.- Specified by:
getRecordSize
in classEscherRecord
- 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 classEscherRecord
- Returns:
- the short name for this escher record
-
getAttributeMap
protected java.lang.Object[][] getAttributeMap()
Description copied from class:EscherRecord
For the purpose of providing toString() and toXml() a subclass can either override those methods or provide a Object[][] array in the form{ { "Attribute Name (Header)", value, "optional attribute", value }, ... }
.Null values won't be printed.
The attributes record, version, instance, options must not be returned.
- Specified by:
getAttributeMap
in classEscherRecord
- Returns:
- the attribute map
-
-