org.apache.poi.xssf.usermodel

Class XSSFPictureData

java.lang.Object

org.apache.poi.ooxml.POIXMLDocumentPart

org.apache.poi.xssf.usermodel.XSSFPictureData

All Implemented Interfaces:

PictureData

public class XSSFPictureData
extends POIXMLDocumentPart
implements PictureData

Raw picture data, normally attached to a SpreadsheetML Drawing. As a rule, pictures are stored in the /xl/media/ part of a SpreadsheetML package. (原始图片数据，通常附加到 SpreadsheetML 绘图。通常，图片存储在 SpreadsheetML 包的 /xl/media/ 部分中。)

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.poi.ooxml.POIXMLDocumentPart

POIXMLDocumentPart.RelationPart

Field Summary

Fields

Modifier and Type	Field and Description
protected static POIXMLRelation[]	RELATIONS Relationships for each known picture type (每种已知图片类型的关系)

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	XSSFPictureData() Create a new XSSFPictureData node (创建一个新的 XSSFPictureData 节点)
protected	XSSFPictureData(PackagePart part) Construct XSSFPictureData from a package part (从包部分构造 XSSFPitureData)

Method Summary

Modifier and Type	Method and Description
byte[]	getData() Gets the picture data as a byte array. (以字节数组的形式获取图片数据。)
java.lang.String	getMimeType() Returns the mime type for the image (返回图像的 MIME 类型)
int	getPictureType() Return an integer constant that specifies type of this picture (返回指定此图片类型的整数常量)
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. (*PictureData 对象直接将实际内容存储在部件中，而不像所有其他对象一样保留副本，因此我们需要以不同方式处理它们。)
java.lang.String	suggestFileExtension() Suggests a file extension for this image. (建议此图像的文件扩展名。)

Methods inherited from class org.apache.poi.ooxml.POIXMLDocumentPart

_invokeOnDocumentRead, addRelation, commit, createRelationship, createRelationship, createRelationship, getNextPartNumber, getPackagePart, getParent, getRelationById, getRelationId, getRelationPartById, getRelationParts, getRelations, getTargetPart, isCommitted, onDocumentCreate, onDocumentRead, onDocumentRemove, onSave, read, rebase, removeRelation, removeRelation, removeRelation, setCommitted, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

RELATIONS

protected static final POIXMLRelation[] RELATIONS

Relationships for each known picture type (每种已知图片类型的关系)

Constructor Detail

XSSFPictureData

protected XSSFPictureData()

Create a new XSSFPictureData node (创建一个新的 XSSFPictureData 节点)

See Also:

XSSFWorkbook.addPicture(byte[], int)

XSSFPictureData

protected XSSFPictureData(PackagePart part)

Construct XSSFPictureData from a package part (从包部分构造 XSSFPitureData)

Parameters:

part - the package part holding the drawing data, (part - 包含绘图数据的包部分，)

Since:

POI 3.14-Beta1

Method Detail

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

(以字节数组的形式获取图片数据。请注意，此调用可能很昂贵，因为所有图片数据都被复制到临时字节数组中。可以直接从底层包部分抓取图片数据，如下： InputStream is = getPackagePart().getInputStream();)

Specified by:

getData in interface PictureData (接口 PictureData 中的 getData)

Returns:

the picture data. (图片数据。)

suggestFileExtension

public java.lang.String suggestFileExtension()

Suggests a file extension for this image. (建议此图像的文件扩展名。)

Specified by:

suggestFileExtension in interface PictureData (接口 PictureData 中的SuggestFileExtension)

Returns:

the file extension. (文件扩展名。)

getPictureType

public int getPictureType()

Return an integer constant that specifies type of this picture (返回指定此图片类型的整数常量)

Specified by:

getPictureType in interface PictureData (接口 PictureData 中的 getPictureType)

Returns:

an integer constant that specifies type of this picture (指定此图片类型的整数常量)

See Also:

Workbook.PICTURE_TYPE_EMF, Workbook.PICTURE_TYPE_WMF, Workbook.PICTURE_TYPE_PICT, Workbook.PICTURE_TYPE_JPEG, Workbook.PICTURE_TYPE_PNG, Workbook.PICTURE_TYPE_DIB

getMimeType

public java.lang.String getMimeType()

Description copied from interface: PictureData

Returns the mime type for the image (返回图像的 MIME 类型)

Specified by:

getMimeType in interface PictureData (接口 PictureData 中的 getMimeType)

prepareForCommit

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. (*PictureData 对象直接将实际内容存储在部件中，而不像所有其他对象一样保留副本，因此我们需要以不同方式处理它们。)

Overrides:

prepareForCommit in class POIXMLDocumentPart