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.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.poi.ooxml.POIXMLDocumentPart
POIXMLDocumentPart.RelationPart
-
-
Constructor Summary
Constructors Constructor Description XWPFPictureData(PackagePart part)
Construct XWPFPictureData from a package part
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
java.lang.Long
getChecksum()
byte[]
getData()
Gets the picture data as a byte array.java.lang.String
getFileName()
Returns the file name of the image, eg image7.jpg .static int
getMaxImageSize()
int
getPictureType()
Return an integer constant that specifies type of this picturePictureType
getPictureTypeEnum()
Return aPictureType
that specifies type of this pictureint
hashCode()
static void
setMaxImageSize(int length)
java.lang.String
suggestFileExtension()
Suggests a file extension for this image.-
Methods inherited from class org.apache.poi.ooxml.POIXMLDocumentPart
_invokeOnDocumentRead, addRelation, createRelationship, createRelationship, createRelationship, getNextPartNumber, getPackagePart, getParent, getRelationById, getRelationId, getRelationPartById, getRelationParts, getRelations, isCommitted, setCommitted, toString
-
-
-
-
Constructor Detail
-
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 Detail
-
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 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.
-
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:
Document.PICTURE_TYPE_EMF
,Document.PICTURE_TYPE_WMF
,Document.PICTURE_TYPE_PICT
,Document.PICTURE_TYPE_JPEG
,Document.PICTURE_TYPE_PNG
,Document.PICTURE_TYPE_GIF
,Document.PICTURE_TYPE_DIB
,getPictureTypeEnum()
-
getPictureTypeEnum
public PictureType getPictureTypeEnum()
Return aPictureType
that specifies type of this picture- Returns:
- a
PictureType
, returns null if an unknown type - Since:
- POI 5.2.3
-
getChecksum
public java.lang.Long getChecksum()
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
-