Package org.apache.poi.xwpf.usermodel

Class XWPFPictureData

java.lang.Object
org.apache.poi.ooxml.POIXMLDocumentPart
org.apache.poi.xwpf.usermodel.XWPFPictureData
public class XWPFPictureData extends POIXMLDocumentPart
Raw picture data, normally attached to a WordprocessingML Drawing. As a rule, pictures are stored in the /word/media/ part of a WordprocessingML package.

  • Constructor Details

    • XWPFPictureData

      public XWPFPictureData(PackagePart part)
      Construct XWPFPictureData from a package part
      Parameters:
      part - the package part holding the drawing data,
      Since:
      POI 3.14-Beta1

  • Method Details

    • setMaxImageSize

      public static void setMaxImageSize(int length)
      Parameters:
      length - the max image size allowed for XSSF pictures

    • getMaxImageSize

      public static int getMaxImageSize()
      Returns:
      the max image size allowed for XSSF pictures

    • getData

      public byte[] getData()
      Gets the picture data as a byte array.

      Note, that this call might be expensive since all the picture data is copied into a temporary byte array. You can grab the picture data directly from the underlying package part as follows:
      InputStream is = getPackagePart().getInputStream();

      Returns:
      the Picture data.

    • getFileName

      public 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 String suggestFileExtension()
      Suggests a file extension for this image.
      Returns:
      the file extension.

    • getPictureType

      public int getPictureType()
      Return an integer constant that specifies type of this picture
      Returns:
      an integer constant that specifies type of this picture, returns 0 if an unknown type
      See Also:

    • getPictureTypeEnum

      public PictureType getPictureTypeEnum()
      Return a PictureType that specifies type of this picture
      Returns:
      a PictureType, returns null if an unknown type
      Since:
      POI 5.2.3

    • getChecksum

      public Long getChecksum()

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object