EscherMetafileBlip (POI API Documentation)

java.lang.Object
- org.apache.poi.ddf.EscherRecord
- - org.apache.poi.ddf.EscherBlipRecord
  - - org.apache.poi.ddf.EscherMetafileBlip

All Implemented Interfaces:: Duplicatable, GenericRecord

public final class EscherMetafileBlip
extends EscherBlipRecord

Field Summary

Fields
Modifier and Type	Field and Description
`static short`	`RECORD_ID_EMF` Deprecated. use EscherRecordTypes.BLIP_EMF.typeID
`static short`	`RECORD_ID_PICT` Deprecated. use EscherRecordTypes.BLIP_PICT.typeID
`static short`	`RECORD_ID_WMF` Deprecated. use EscherRecordTypes.BLIP_WMF.typeID

Fields inherited from class org.apache.poi.ddf.EscherBlipRecord
RECORD_ID_END, RECORD_ID_START

Constructor Summary

Constructors
Constructor and Description

EscherMetafileBlip()

EscherMetafileBlip(EscherMetafileBlip other)

Constructors
Constructor and Description
`EscherMetafileBlip()`
`EscherMetafileBlip(EscherMetafileBlip other)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EscherMetafileBlip`	`copy()`
`int`	`fillFields(byte[] data, int offset, EscherRecordFactory recordFactory)` The contract of this method is to deserialize an escher record including its children.
`java.awt.Rectangle`	`getBounds()` Get the clipping region of the metafile
`int`	`getCompressedSize()` Gets the compressed size of the metafile (in bytes)
`byte`	`getFilter()` Gets the filter byte - this is usually 0xFE
`java.util.Map<java.lang.String,java.util.function.Supplier<?>>`	`getGenericProperties()`
`static int`	`getMaxRecordLength()`
`byte[]`	`getPrimaryUID()` Gets the second MD4, that specifies the unique identifier of the uncompressed blip data
`int`	`getRecordSize()` Subclasses should effeciently return the number of bytes required to serialize the record.
`byte[]`	`getRemainingData()` Returns any remaining bytes
`short`	`getSignature()` Return the blip signature
`java.awt.Dimension`	`getSizeEMU()` Gets the dimensions of the metafile
`byte[]`	`getUID()` Gets the first MD4, that specifies the unique identifier of the uncompressed blip data
`int`	`getUncompressedSize()` Gets the uncompressed size (in bytes)
`boolean`	`isCompressed()` Gets the compression of the metafile
`int`	`serialize(int offset, byte[] data, EscherSerializationListener listener)` Serializes the record to an existing byte array.
`void`	`setBounds(java.awt.Rectangle bounds)` Sets the clipping region
`void`	`setCompressed(boolean compressed)` Sets the compression of the metafile
`void`	`setCompressedSize(int compressedSize)` Sets the compressed size of the metafile (in bytes)
`void`	`setFilter(byte filter)` Sets the filter byte - this is usually 0xFE
`static void`	`setMaxRecordLength(int length)`
`void`	`setPictureData(byte[] pictureData)` Sets the picture data bytes
`void`	`setPrimaryUID(byte[] primaryUID)` Sets the second MD4, that specifies the unique identifier of the uncompressed blip data
`void`	`setSizeEMU(java.awt.Dimension sizeEMU)` Gets the dimensions of the metafile
`void`	`setUID(byte[] uid)` Sets the first MD4, that specifies the unique identifier of the uncompressed blip data
`void`	`setUncompressedSize(int uncompressedSize)` Sets the uncompressed size (in bytes)

Methods inherited from class org.apache.poi.ddf.EscherBlipRecord
getGenericRecordType, getPicturedata, getRecordName, setPictureData

Methods inherited from class org.apache.poi.ddf.EscherRecord
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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - RECORD_ID_EMF
```
@Deprecated
 @Removal(version="5.3")
public static final short RECORD_ID_EMF
```
    Deprecated. use EscherRecordTypes.BLIP_EMF.typeID
  - RECORD_ID_WMF
```
@Deprecated
 @Removal(version="5.3")
public static final short RECORD_ID_WMF
```
    Deprecated. use EscherRecordTypes.BLIP_WMF.typeID
  - RECORD_ID_PICT
```
@Deprecated
 @Removal(version="5.3")
public static final short RECORD_ID_PICT
```
    Deprecated. use EscherRecordTypes.BLIP_PICT.typeID
- Constructor Detail
  - EscherMetafileBlip
```
public EscherMetafileBlip()
```
  - EscherMetafileBlip
```
public EscherMetafileBlip(EscherMetafileBlip other)
```
- Method Detail
  - setMaxRecordLength
```
public static void setMaxRecordLength(int length)
```
    Parameters:
    
    length - the max record length allowed for EscherMetafileBlip
  - getMaxRecordLength
```
public static int getMaxRecordLength()
```
    Returns:
    
    the max record length allowed for EscherMetafileBlip
  - 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 class EscherBlipRecord
    
    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 class EscherBlipRecord
    
    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.
    
    Overrides:
    
    getRecordSize in class EscherBlipRecord
    
    Returns:
    
    number of bytes
  - getUID
```
public byte[] getUID()
```
    Gets the first MD4, that specifies the unique identifier of the uncompressed blip data
    
    Returns:
    
    the first MD4
  - setUID
```
public void setUID(byte[] uid)
```
    Sets the first MD4, that specifies the unique identifier of the uncompressed blip data
    
    Parameters:
    
    uid - the first MD4
  - getPrimaryUID
```
public byte[] getPrimaryUID()
```
    Gets the second MD4, that specifies the unique identifier of the uncompressed blip data
    
    Returns:
    
    the second MD4
  - setPrimaryUID
```
public void setPrimaryUID(byte[] primaryUID)
```
    Sets the second MD4, that specifies the unique identifier of the uncompressed blip data
    
    Parameters:
    
    primaryUID - the second MD4
  - getUncompressedSize
```
public int getUncompressedSize()
```
    Gets the uncompressed size (in bytes)
    
    Returns:
    
    the uncompressed size
  - setUncompressedSize
```
public void setUncompressedSize(int uncompressedSize)
```
    Sets the uncompressed size (in bytes)
    
    Parameters:
    
    uncompressedSize - the uncompressed size
  - getBounds
```
public java.awt.Rectangle getBounds()
```
    Get the clipping region of the metafile
    
    Returns:
    
    the clipping region
  - setBounds
```
public void setBounds(java.awt.Rectangle bounds)
```
    Sets the clipping region
    
    Parameters:
    
    bounds - the clipping region
  - getSizeEMU
```
public java.awt.Dimension getSizeEMU()
```
    Gets the dimensions of the metafile
    
    Returns:
    
    the dimensions of the metafile
  - setSizeEMU
```
public void setSizeEMU(java.awt.Dimension sizeEMU)
```
    Gets the dimensions of the metafile
    
    Parameters:
    
    sizeEMU - the dimensions of the metafile
  - getCompressedSize
```
public int getCompressedSize()
```
    Gets the compressed size of the metafile (in bytes)
    
    Returns:
    
    the compressed size
  - setCompressedSize
```
public void setCompressedSize(int compressedSize)
```
    Sets the compressed size of the metafile (in bytes)
    
    Parameters:
    
    compressedSize - the compressed size
  - isCompressed
```
public boolean isCompressed()
```
    Gets the compression of the metafile
    
    Returns:
    
    true, if the metafile is compressed
  - setCompressed
```
public void setCompressed(boolean compressed)
```
    Sets the compression of the metafile
    
    Parameters:
    
    compressed - the compression state, true if it's compressed
  - getFilter
```
public byte getFilter()
```
    Gets the filter byte - this is usually 0xFE
    
    Returns:
    
    the filter byte
  - setFilter
```
public void setFilter(byte filter)
```
    Sets the filter byte - this is usually 0xFE
    
    Parameters:
    
    filter - the filter byte
  - getRemainingData
```
public byte[] getRemainingData()
```
    Returns any remaining bytes
    
    Returns:
    
    any remaining bytes
  - getSignature
```
public short getSignature()
```
    Return the blip signature
    
    Returns:
    
    the blip signature
  - setPictureData
```
public void setPictureData(byte[] pictureData)
```
    Description copied from class: EscherBlipRecord
    
    Sets the picture data bytes
    
    Overrides:
    
    setPictureData in class EscherBlipRecord
    
    Parameters:
    
    pictureData - the picture data
  - getGenericProperties
```
public java.util.Map<java.lang.String,java.util.function.Supplier<?>> getGenericProperties()
```
    Specified by:
    
    getGenericProperties in interface GenericRecord
    
    Overrides:
    
    getGenericProperties in class EscherBlipRecord
  - copy
```
public EscherMetafileBlip copy()
```
    Specified by:
    
    copy in interface Duplicatable
    
    Overrides:
    
    copy in class EscherBlipRecord
    
    Returns:
    
    a deep copy of the implementing class / instance

Class EscherMetafileBlip

Field Summary

Fields inherited from class org.apache.poi.ddf.EscherBlipRecord

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Field Detail

RECORD_ID_EMF

RECORD_ID_WMF

RECORD_ID_PICT

Constructor Detail

EscherMetafileBlip

EscherMetafileBlip

Method Detail

setMaxRecordLength

getMaxRecordLength

fillFields

serialize

getRecordSize

getUID

setUID

getPrimaryUID

setPrimaryUID

getUncompressedSize

setUncompressedSize

getBounds

setBounds

getSizeEMU

setSizeEMU

getCompressedSize

setCompressedSize

isCompressed

setCompressed

getFilter

setFilter

getRemainingData

getSignature

setPictureData

getGenericProperties

copy