Package org.apache.poi.ddf
Class EscherBlipRecord
java.lang.Object
org.apache.poi.ddf.EscherRecord
org.apache.poi.ddf.EscherBlipRecord
- All Implemented Interfaces:
Cloneable
- Direct Known Subclasses:
EscherBitmapBlip
,EscherMetafileBlip
,EscherPictBlip
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint
fillFields
(byte[] data, int offset, EscherRecordFactory recordFactory) The contract of this method is to deserialize an escher record including it's children.protected Object[][]
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 }, ... }
.byte[]
Gets the picture data bytesSubclasses should return the short name for this escher record.int
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.void
setPictureData
(byte[] pictureData) Sets the picture data bytesvoid
setPictureData
(byte[] pictureData, int offset, int length) Sets the picture data bytesMethods 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 Details
-
RECORD_ID_START
public static final short RECORD_ID_START- See Also:
-
RECORD_ID_END
public static final short RECORD_ID_END- See Also:
-
RECORD_DESCRIPTION
- See Also:
-
-
Constructor Details
-
EscherBlipRecord
public EscherBlipRecord()
-
-
Method Details
-
fillFields
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
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
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
-
getPicturedata
public byte[] getPicturedata()Gets the picture data bytes- Returns:
- the picture data
-
setPictureData
public void setPictureData(byte[] pictureData) Sets the picture data bytes- Parameters:
pictureData
- the picture data
-
setPictureData
public void setPictureData(byte[] pictureData, int offset, int length) Sets the picture data bytes- Parameters:
pictureData
- the picture dataoffset
- the offset into the picture datalength
- the amount of bytes to be used
-
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
-