Top Fields Constructors Methods
org.apache.poi.ddf

public Class EscherBitmapBlip

extends EscherBlipRecord
Class Inheritance
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.util.GenericRecordUtil, .LittleEndian

Field Summary

Modifier and TypeField and Description
private final byte[]
field_1_UID

private byte
field_2_marker

private static final int
HEADER_SIZE

Hides org.apache.poi.ddf.EscherBlipRecord.HEADER_SIZE.

public static final short
RECORD_ID_DIB

public static final short
RECORD_ID_JPEG

public static final short
RECORD_ID_PNG

Inherited from org.apache.poi.ddf.EscherBlipRecord:
RECORD_ID_ENDRECORD_ID_START

Constructor Summary

AccessConstructor and Description
public
EscherBitmapBlip()

public
EscherBitmapBlip(EscherBitmapBlip other)

Method Summary

Modifier and TypeMethod and Description
public EscherBitmapBlip
copy()

Overrides org.apache.poi.ddf.EscherBlipRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

public int
fillFields(byte[]
The byte array containing the serialized escher records.
data, int
The offset into the byte array.
offset, EscherRecordFactory
A factory for creating new escher records.
recordFactory)

Overrides org.apache.poi.ddf.EscherBlipRecord.fillFields.

The contract of this method is to deserialize an escher record including its children.

public Map<String, Supplier<?>>
getGenericProperties()

Overrides org.apache.poi.ddf.EscherBlipRecord.getGenericProperties.

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

public byte

Returns:

the marker
getMarker()

Gets an unsigned integer that specifies an application-defined internal resource tag.

public int
getRecordSize()

Overrides org.apache.poi.ddf.EscherBlipRecord.getRecordSize.

Subclasses should effeciently return the number of bytes required to serialize the record.

public byte[]

Returns:

the first MD4
getUID()

Gets the first MD4, that specifies the unique identifier of the uncompressed blip data

public int
serialize(int
the offset within the byte array
offset, byte[]
the data array to serialize to
data, EscherSerializationListener
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.
listener)

Overrides org.apache.poi.ddf.EscherBlipRecord.serialize.

Serializes the record to an existing byte array.

public void
setMarker(byte
the marker
field_2_marker)

Sets an unsigned integer that specifies an application-defined internal resource tag.

public void
setUID(byte[]
the first MD4
field_1_UID)

Sets the first MD4, that specifies the unique identifier of the uncompressed blip data

Inherited from org.apache.poi.ddf.EscherBlipRecord:
getGenericRecordTypegetMaxRecordLengthgetPicturedatagetRecordNamesetMaxRecordLengthsetPictureDatasetPictureData

Field Detail

field_1_UIDback to summary
private final byte[] field_1_UID
field_2_markerback to summary
private byte field_2_marker
HEADER_SIZEback to summary
private static final int HEADER_SIZE

Hides org.apache.poi.ddf.EscherBlipRecord.HEADER_SIZE.

RECORD_ID_DIBback to summary
public static final short RECORD_ID_DIB
RECORD_ID_JPEGback to summary
public static final short RECORD_ID_JPEG
RECORD_ID_PNGback to summary
public static final short RECORD_ID_PNG

Constructor Detail

EscherBitmapBlipback to summary
public EscherBitmapBlip()
EscherBitmapBlipback to summary
public EscherBitmapBlip(EscherBitmapBlip other)

Method Detail

copyback to summary
public EscherBitmapBlip copy()

Overrides org.apache.poi.ddf.EscherBlipRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

Returns:EscherBitmapBlip

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

Annotations
@Override
fillFieldsback to summary
public int fillFields(byte[] data, int offset, EscherRecordFactory recordFactory)

Overrides org.apache.poi.ddf.EscherBlipRecord.fillFields.

Doc from org.apache.poi.ddf.EscherRecord.fillFields.

The contract of this method is to deserialize an escher record including its children.

Parameters
data:byte[]

The byte array containing the serialized escher records.

offset:int

The offset into the byte array.

recordFactory:EscherRecordFactory

A factory for creating new escher records.

Returns:int

The number of bytes written.

Annotations
@Override
getGenericPropertiesback to summary
public Map<String, Supplier<?>> getGenericProperties()

Overrides org.apache.poi.ddf.EscherBlipRecord.getGenericProperties.

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations
@Override
getMarkerback to summary
public byte getMarker()

Gets an unsigned integer that specifies an application-defined internal resource tag. This value MUST be 0xFF for external files.

Returns:byte

the marker

getRecordSizeback to summary
public int getRecordSize()

Overrides org.apache.poi.ddf.EscherBlipRecord.getRecordSize.

Doc from org.apache.poi.ddf.EscherRecord.getRecordSize.

Subclasses should effeciently return the number of bytes required to serialize the record.

Returns:int

number of bytes

Annotations
@Override
getUIDback to summary
public byte[] getUID()

Gets the first MD4, that specifies the unique identifier of the uncompressed blip data

Returns:byte[]

the first MD4

serializeback to summary
public int serialize(int offset, byte[] data, EscherSerializationListener listener)

Overrides org.apache.poi.ddf.EscherBlipRecord.serialize.

Doc from org.apache.poi.ddf.EscherRecord.serialize.

Serializes the record to an existing byte array.

Parameters
offset:int

the offset within the byte array

data:byte[]

the data array to serialize to

listener:EscherSerializationListener

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:int

the number of bytes written.

Annotations
@Override
setMarkerback to summary
public void setMarker(byte field_2_marker)

Sets an unsigned integer that specifies an application-defined internal resource tag. This value MUST be 0xFF for external files.

Parameters
field_2_marker:byte

the marker

setUIDback to summary
public void setUID(byte[] field_1_UID)

Sets the first MD4, that specifies the unique identifier of the uncompressed blip data

Parameters
field_1_UID:byte[]

the first MD4