Package org.apache.poi.xslf.usermodel

Class XSLFObjectShape

java.lang.Object

org.apache.poi.xslf.usermodel.XSLFShape

org.apache.poi.xslf.usermodel.XSLFGraphicFrame

org.apache.poi.xslf.usermodel.XSLFObjectShape

All Implemented Interfaces:

GraphicalFrame<XSLFShape,XSLFTextParagraph>, ObjectShape<XSLFShape,XSLFTextParagraph>, PlaceableShape<XSLFShape,XSLFTextParagraph>, Shape<XSLFShape,XSLFTextParagraph>

public class XSLFObjectShape
extends XSLFGraphicFrame
implements ObjectShape<XSLFShape,XSLFTextParagraph>

Method Summary

Modifier and Type	Method	Description
CTOleObject	getCTOleObject()
String	getFullName()	Returns the full name of the embedded object, e.g.
XSLFObjectData	getObjectData()
XSLFPictureData	getPictureData()	Return the data on the (internal) picture.
String	getProgId()	Returns the ProgID that stores the OLE Programmatic Identifier.
OutputStream	updateObjectData(ObjectMetaData.Application application, ObjectMetaData metaData)	Updates the ole data.

Methods inherited from class org.apache.poi.xslf.usermodel.XSLFGraphicFrame

getAnchor, getFallbackPicture, getFlipHorizontal, getFlipVertical, getRotation, getShapeType, setAnchor, setFlipHorizontal, setFlipVertical, setRotation

Methods inherited from class org.apache.poi.xslf.usermodel.XSLFShape

draw, getParent, getPlaceholder, getPlaceholderDetails, getShapeId, getShapeName, getSheet, getXmlObject, isPlaceholder, setParent, setPlaceholder

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.poi.sl.usermodel.ObjectShape

readObjectData, readObjectDataRaw

Methods inherited from interface org.apache.poi.sl.usermodel.PlaceableShape

getAnchor, getFlipHorizontal, getFlipVertical, getParent, getRotation, getSheet, setAnchor, setFlipHorizontal, setFlipVertical, setRotation

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

draw, getAnchor, getParent, getShapeId, getShapeName, getSheet

Method Detail

getCTOleObject

@Internal
public CTOleObject getCTOleObject()

getObjectData

public XSLFObjectData getObjectData()

Specified by:

getObjectData in interface ObjectShape<XSLFShape,XSLFTextParagraph>

Returns:

the data object

getProgId

public String getProgId()

Description copied from interface: ObjectShape

Returns the ProgID that stores the OLE Programmatic Identifier. A ProgID is a string that uniquely identifies a given object, for example, "Word.Document.8" or "Excel.Sheet.8".

Specified by:

getProgId in interface ObjectShape<XSLFShape,XSLFTextParagraph>

Returns:

the ProgID

getFullName

public String getFullName()

Description copied from interface: ObjectShape

Returns the full name of the embedded object, e.g. "Microsoft Word Document" or "Microsoft Office Excel Worksheet".

Specified by:

getFullName in interface ObjectShape<XSLFShape,XSLFTextParagraph>

Returns:

the full name of the embedded object

getPictureData

public XSLFPictureData getPictureData()

Return the data on the (internal) picture. For an external linked picture, will return null

Specified by:

getPictureData in interface ObjectShape<XSLFShape,XSLFTextParagraph>

Returns:

the picture data for this picture.

updateObjectData

public OutputStream updateObjectData(ObjectMetaData.Application application,
                                     ObjectMetaData metaData)
                              throws IOException

Description copied from interface: ObjectShape

Updates the ole data. If there wasn't an object registered before, a new ole embedding is registered in the parent slideshow.

For HSLF this needs to be a POIFSFileSystem stream.

Specified by:

updateObjectData in interface ObjectShape<XSLFShape,XSLFTextParagraph>

Parameters:

application - a preset application enum

metaData - or a custom metaData object, can be null if the application has been set

Returns:

an OutputStream which receives the new data, the data will be persisted on close()

Throws:

IOException - if the linked object data couldn't be found or a new object data couldn't be initialized