org.apache.poi.xssf.usermodel

Class XSSFObjectData

java.lang.Object

org.apache.poi.xssf.usermodel.XSSFShape

org.apache.poi.xssf.usermodel.XSSFSimpleShape

org.apache.poi.xssf.usermodel.XSSFObjectData

All Implemented Interfaces:

java.lang.Iterable< XSSFTextParagraph>, ObjectData, Shape, SimpleShape, TextContainer

public class XSSFObjectData
extends XSSFSimpleShape
implements ObjectData

Represents binary object (i.e. OLE) data stored in the file. Eg. A GIF, JPEG etc... (表示存储在文件中的二进制对象（即 OLE）数据。例如。 GIF、JPEG 等...)

Field Summary

Fields inherited from class org.apache.poi.xssf.usermodel.XSSFShape

anchor, drawing, parent

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	XSSFObjectData(XSSFDrawing drawing, org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTShape ctShape)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getContentType()
DirectoryEntry	getDirectory() Gets the object data. (获取对象数据。)
java.lang.String	getFileName() The filename of the embedded image (嵌入图像的文件名)
byte[]	getObjectData()
PackagePart	getObjectPart()
java.lang.String	getOLE2ClassName()
org.openxmlformats.schemas.spreadsheetml.x2006.main.CTOleObject	getOleObject()
XSSFPictureData	getPictureData()
protected XSSFSheet	getSheet()
boolean	hasDirectoryEntry()
protected static org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTShape	prototype() Prototype with the default structure of a new auto-shape. (具有新自动形状的默认结构的原型。)

Methods inherited from class org.apache.poi.xssf.usermodel.XSSFSimpleShape

addNewTextParagraph, addNewTextParagraph, addNewTextParagraph, clearText, findDefinedParagraphProperty, findDefinedRunProperty, getBottomInset, getCTShape, getLeftInset, getRightInset, getShapeId, getShapeName, getShapeProperties, getShapeType, getText, getTextAutofit, getTextBody, getTextDirection, getTextHorizontalOverflow, getTextParagraphs, getTextVerticalOverflow, getTopInset, getVerticalAlignment, getWordWrap, iterator, setBottomInset, setLeftInset, setRightInset, setShapeType, setText, setText, setTextAutofit, setTextDirection, setTextHorizontalOverflow, setTextVerticalOverflow, setTopInset, setVerticalAlignment, setWordWrap, setXfrm

Methods inherited from class org.apache.poi.xssf.usermodel.XSSFShape

getAnchor, getDrawing, getParent, isNoFill, setFillColor, setLineStyle, setLineStyleColor, setLineWidth, setNoFill

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.poi.ss.usermodel.SimpleShape

getShapeId

Methods inherited from interface org.apache.poi.ss.usermodel.Shape

getAnchor, getParent, getShapeName, isNoFill, setFillColor, setLineStyleColor, setNoFill

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

XSSFObjectData

protected XSSFObjectData(XSSFDrawing drawing,
                         org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTShape ctShape)

Method Detail

prototype

protected static org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTShape prototype()

Prototype with the default structure of a new auto-shape. (具有新自动形状的默认结构的原型。)

getOLE2ClassName

public java.lang.String getOLE2ClassName()

Specified by:

getOLE2ClassName in interface ObjectData (接口 ObjectData 中的 getOLE2ClassName)

Returns:

the OLE2 Class Name of the object (对象的 OLE2 类名)

getOleObject

public org.openxmlformats.schemas.spreadsheetml.x2006.main.CTOleObject getOleObject()

Returns:

the CTOleObject associated with the shape (与形状关联的 CTOleObject)

getObjectData

public byte[] getObjectData()
                     throws java.io.IOException

Specified by:

getObjectData in interface ObjectData (接口 ObjectData 中的 getObjectData)

Returns:

the data portion, for an ObjectData that doesn't have an associated POIFS Directory Entry (数据部分，用于没有关联 POIFS 目录条目的 ObjectData)

Throws:

java.io.IOException (java.io.IOException)

getObjectPart

public PackagePart getObjectPart()

Returns:

the package part of the object data (对象数据的封装部分)

hasDirectoryEntry

public boolean hasDirectoryEntry()

Specified by:

hasDirectoryEntry in interface ObjectData (接口 ObjectData 中的 hasDirectoryEntry)

Returns:

does this ObjectData have an associated POIFS Directory Entry? (Not all do, those that don't have a data portion) (此 ObjectData 是否有关联的 POIFS 目录条目？ （不是所有的，那些没有数据部分的）)

getDirectory

public DirectoryEntry getDirectory()
                            throws java.io.IOException

Description copied from interface: ObjectData

Gets the object data. Only call for ones that have data though. See ObjectData.hasDirectoryEntry(). The caller has to close the corresponding POIFSFileSystem (获取对象数据。只要求那些有数据的人。请参阅 ObjectData.hasDirectoryEntry()。调用者必须关闭相应的 POIFSFileSystem)

Specified by:

getDirectory in interface ObjectData (接口 ObjectData 中的 getDirectory)

Returns:

the object data as an OLE2 directory. (对象数据作为 OLE2 目录。)

Throws:

java.io.IOException - if there was an error reading the data. (java.io.IOException - 如果读取数据时出错。)

getFileName

public java.lang.String getFileName()

The filename of the embedded image (嵌入图像的文件名)

Specified by:

getFileName in interface ObjectData (接口 ObjectData 中的 getFileName)

Returns:

a filename suggestion - inspecting/interpreting the Directory object probably gives a better result (文件名建议 - 检查/解释 Directory 对象可能会产生更好的结果)

getSheet

protected XSSFSheet getSheet()

getPictureData

public XSSFPictureData getPictureData()

Specified by:

getPictureData in interface ObjectData (接口 ObjectData 中的 getPictureData)

Returns:

the preview picture (预览图片)

getContentType

public java.lang.String getContentType()

Specified by:

getContentType in interface ObjectData (接口 ObjectData 中的 getContentType)