Class XSLFPictureData

    • Constructor Detail

      • XSLFPictureData

        public XSLFPictureData​(PackagePart part)
        Construct XSLFPictureData from a package part
        Parameters:
        part - the package part holding the drawing data
        Since:
        POI 3.14-Beta1
    • Method Detail

      • getInputStream

        public java.io.InputStream getInputStream()
                                           throws java.io.IOException
        An InputStream to read the picture data directly from the underlying package part
        Returns:
        InputStream
        Throws:
        java.io.IOException
      • getData

        public byte[] getData()
        Gets the picture data as a byte array. You can grab the picture data directly from the underlying package part with the getInputStream() method
        Specified by:
        getData in interface PictureData
        Returns:
        the Picture data.
      • getFileName

        public java.lang.String getFileName()
        Returns the file name of the image, eg image7.jpg . The original filename isn't always available, but if it can be found it's likely to be in the CTDrawing
      • suggestFileExtension

        public java.lang.String suggestFileExtension()
        Suggests a file extension for this image.
        Returns:
        the file extension.
      • getChecksum

        public byte[] getChecksum()
        Description copied from interface: PictureData
        Gets the checksum - the checksum can be of various length - mostly it's 8 (XSLF) or 16 (HSLF) bytes long.
        Specified by:
        getChecksum in interface PictureData
        Returns:
        the checksum
      • getImageDimension

        public java.awt.Dimension getImageDimension()
        Description copied from interface: PictureData
        Return the original image dimensions in points (for formats supported by BufferedImage). Will return a Dimension with a default width of 200x200 if the format unsupported.
        Specified by:
        getImageDimension in interface PictureData
      • getContentType

        public java.lang.String getContentType()
        Description copied from interface: PictureData
        Returns content type (mime type) of this picture.
        Specified by:
        getContentType in interface PictureData
        Returns:
        content type of this picture.
      • setData

        public void setData​(byte[] data)
                     throws java.io.IOException
        Description copied from interface: PictureData
        Sets the binary picture data
        Specified by:
        setData in interface PictureData
        Parameters:
        data - picture data
        Throws:
        java.io.IOException
      • getIndex

        public int getIndex()
        Returns:
        the 0-based index of this pictures within the picture parts
      • setIndex

        public void setIndex​(int index)
        Parameters:
        index - sets the 0-based index of this pictures within the picture parts