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:

Iterable<XSSFTextParagraph>, ObjectData, Shape, SimpleShape, org.apache.poi.xddf.usermodel.text.TextContainer

public class XSSFObjectData
extends XSSFSimpleShape
implements ObjectData

Represents binary object (i.e. OLE) data stored in the file. Eg. A GIF, JPEG etc...

Method Summary

Modifier and Type	Method and Description
String	getContentType()
DirectoryEntry	getDirectory() Gets the object data.
String	getFileName() The filename of the embedded image
byte[]	getObjectData()
PackagePart	getObjectPart()
String	getOLE2ClassName()
CTOleObject	getOleObject()
XSSFPictureData	getPictureData()
boolean	hasDirectoryEntry()

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

addNewTextParagraph, addNewTextParagraph, addNewTextParagraph, clearText, findDefinedParagraphProperty, findDefinedRunProperty, getBottomInset, getCTShape, getLeftInset, getRightInset, getShapeId, getShapeName, 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

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

equals, 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

Method Detail

getOLE2ClassName

public String getOLE2ClassName()

Specified by:

getOLE2ClassName in interface ObjectData

Returns:

the OLE2 Class Name of the object

getOleObject

public CTOleObject getOleObject()

Returns:

the CTOleObject associated with the shape

getObjectData

public byte[] getObjectData()
                     throws IOException

Specified by:

getObjectData in interface ObjectData

Returns:

the data portion, for an ObjectData that doesn't have an associated POIFS Directory Entry

Throws:

IOException

getObjectPart

public PackagePart getObjectPart()

Returns:

the package part of the object data

hasDirectoryEntry

public boolean hasDirectoryEntry()

Specified by:

hasDirectoryEntry in interface ObjectData

Returns:

does this ObjectData have an associated POIFS Directory Entry? (Not all do, those that don't have a data portion)

getDirectory

public DirectoryEntry getDirectory()
                            throws 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

Specified by:

getDirectory in interface ObjectData

Returns:

the object data as an OLE2 directory.

Throws:

IOException - if there was an error reading the data.

getFileName

public String getFileName()

The filename of the embedded image

Specified by:

getFileName in interface ObjectData

Returns:

a filename suggestion - inspecting/interpreting the Directory object probably gives a better result

getPictureData

public XSSFPictureData getPictureData()

Specified by:

getPictureData in interface ObjectData

Returns:

the preview picture

getContentType

public String getContentType()

Specified by:

getContentType in interface ObjectData