org.apache.poi.ddf

Class EscherPictBlip

java.lang.Object

org.apache.poi.ddf.EscherRecord

org.apache.poi.ddf.EscherBlipRecord

org.apache.poi.ddf.EscherPictBlip

All Implemented Interfaces:

java.lang.Cloneable

public final class EscherPictBlip
extends EscherBlipRecord

Field Summary

Fields

Modifier and Type	Field and Description
static short	RECORD_ID_EMF
static short	RECORD_ID_PICT
static short	RECORD_ID_WMF

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

RECORD_DESCRIPTION, RECORD_ID_END, RECORD_ID_START

Constructor Summary

Constructors

Constructor and Description
EscherPictBlip()

Method Summary

Modifier and Type	Method and 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.awt.Rectangle	getBounds() Get the clipping region of the pict file
int	getCompressedSize() Gets the compressed size of the metafile (in bytes)
byte	getFilter() Gets the filter byte - this is usually 0xFE
int	getRecordSize() Subclasses should effeciently return the number of bytes required to serialize the record.
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
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

getPicturedata, getRecordName, setPictureData, setPictureData

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

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

RECORD_ID_EMF

public static final short RECORD_ID_EMF

See Also:

Constant Field Values

RECORD_ID_WMF

public static final short RECORD_ID_WMF

See Also:

Constant Field Values

RECORD_ID_PICT

public static final short RECORD_ID_PICT

See Also:

Constant Field Values

Constructor Detail

EscherPictBlip

public EscherPictBlip()

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.

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

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 pict file

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

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.

Overrides:

getAttributeMap in class EscherBlipRecord

Returns:

the attribute map