Package org.apache.poi.ddf

Class EscherMetafileBlip

    • 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()

    • 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 Rectangle getBounds()
        Get the clipping region of the metafile
        Returns:
        the clipping region

      • setBounds

        public void setBounds​(Rectangle bounds)
        Sets the clipping region
        Parameters:
        bounds - the clipping region

      • getSizeEMU

        public Dimension getSizeEMU()
        Gets the dimensions of the metafile
        Returns:
        the dimensions of the metafile

      • setSizeEMU

        public void setSizeEMU​(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