Package 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:
Cloneable
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final short
static final short
static final short
Fields inherited from class org.apache.poi.ddf.EscherBlipRecord
RECORD_DESCRIPTION, RECORD_ID_END, RECORD_ID_START
-
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 }, ... }
.Get the clipping region of the pict fileint
Gets the compressed size of the metafile (in bytes)byte
Gets the filter byte - this is usually 0xFEint
Subclasses should effeciently return the number of bytes required to serialize the record.Gets the dimensions of the metafilebyte[]
getUID()
Gets the first MD4, that specifies the unique identifier of the uncompressed blip dataint
Gets the uncompressed size (in bytes)boolean
Gets the compression of the metafileint
serialize
(int offset, byte[] data, EscherSerializationListener listener) Serializes the record to an existing byte array.void
Sets the clipping regionvoid
setCompressed
(boolean compressed) Sets the compression of the metafilevoid
setCompressedSize
(int compressedSize) Sets the compressed size of the metafile (in bytes)void
setFilter
(byte filter) Sets the filter byte - this is usually 0xFEvoid
setSizeEMU
(Dimension sizeEMU) Gets the dimensions of the metafilevoid
setUID
(byte[] uid) Sets the first MD4, that specifies the unique identifier of the uncompressed blip datavoid
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
-
Field Details
-
RECORD_ID_EMF
public static final short RECORD_ID_EMF- See Also:
-
RECORD_ID_WMF
public static final short RECORD_ID_WMF- See Also:
-
RECORD_ID_PICT
public static final short RECORD_ID_PICT- See Also:
-
-
Constructor Details
-
EscherPictBlip
public EscherPictBlip()
-
-
Method Details
-
fillFields
Description copied from class:EscherRecord
The contract of this method is to deserialize an escher record including it's children.- Overrides:
fillFields
in classEscherBlipRecord
- 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.- Overrides:
serialize
in classEscherBlipRecord
- 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.- Overrides:
getRecordSize
in classEscherBlipRecord
- 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
Get the clipping region of the pict file- Returns:
- the clipping region
-
setBounds
Sets the clipping region- Parameters:
bounds
- the clipping region
-
getSizeEMU
Gets the dimensions of the metafile- Returns:
- the dimensions of the metafile
-
setSizeEMU
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
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 classEscherBlipRecord
- Returns:
- the attribute map
-