public class XWPFPictureData extends POIXMLDocumentPart
POIXMLDocumentPart.RelationPart
Modifier and Type | Field and Description |
---|---|
protected static POIXMLRelation[] |
RELATIONS
Relationships for each known picture type
|
Modifier | Constructor and Description |
---|---|
protected |
XWPFPictureData()
Create a new XWPFGraphicData node
|
|
XWPFPictureData(PackagePart part)
Construct XWPFPictureData from a package part
|
Modifier and Type | Method and 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 .
|
int |
getPictureType()
Return an integer constant that specifies type of this picture
|
int |
hashCode() |
protected void |
onDocumentRead()
Fired when a package part is read
|
protected void |
prepareForCommit()
*PictureData objects store the actual content in the part directly without keeping a
copy like all others therefore we need to handle them differently.
|
java.lang.String |
suggestFileExtension()
Suggests a file extension for this image.
|
_invokeOnDocumentRead, addRelation, commit, createRelationship, createRelationship, createRelationship, getNextPartNumber, getPackagePart, getParent, getRelationById, getRelationId, getRelationPartById, getRelationParts, getRelations, getTargetPart, isCommited, isCommitted, onDocumentCreate, onDocumentRemove, onSave, read, rebase, removeRelation, removeRelation, removeRelation, setCommited, setCommitted, toString
protected static final POIXMLRelation[] RELATIONS
protected XWPFPictureData()
public XWPFPictureData(PackagePart part)
part
- the package part holding the drawing data,protected void onDocumentRead() throws java.io.IOException
POIXMLDocumentPart
onDocumentRead
in class POIXMLDocumentPart
java.io.IOException
- a subclass may throw an IOException when a document is readpublic byte[] getData()
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();
public java.lang.String getFileName()
public java.lang.String suggestFileExtension()
public int getPictureType()
Document.PICTURE_TYPE_EMF
,
Document.PICTURE_TYPE_WMF
,
Document.PICTURE_TYPE_PICT
,
Document.PICTURE_TYPE_JPEG
,
Document.PICTURE_TYPE_PNG
,
Document.PICTURE_TYPE_DIB
public java.lang.Long getChecksum()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
protected void prepareForCommit()
prepareForCommit
in class POIXMLDocumentPart
Copyright 2020 The Apache Software Foundation or its licensors, as applicable.