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 TypeMethodDescriptionprotected org.openxmlformats.schemas.drawingml.x2006.main.CTBlip
getBlip()
protected org.openxmlformats.schemas.drawingml.x2006.main.CTBlipFillProperties
protected String
org.openxmlformats.schemas.presentationml.x2006.main.CTOleObject
Returns the full name of the embedded object, e.g.Return the data on the (internal) picture.Returns the ProgID that stores the OLE Programmatic Identifier.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, fetchShapeProperty, getBgPr, getBgRef, getChild, getCNvPr, getFillPaint, getGrpSpPr, getParent, getPlaceholder, getPlaceholderDetails, getShapeId, getShapeName, getShapeProperties, getSheet, getSpStyle, getXmlObject, isPlaceholder, selectPaint, selectPaint, selectPaint, selectPaint, selectPaint, selectProperty, setParent, setPlaceholder
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.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 Details
-
getCTOleObject
-
getObjectData
- Specified by:
getObjectData
in interfaceObjectShape<XSLFShape,
XSLFTextParagraph> - Returns:
- the data object
-
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 interfaceObjectShape<XSLFShape,
XSLFTextParagraph> - Returns:
- the ProgID
-
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 interfaceObjectShape<XSLFShape,
XSLFTextParagraph> - Returns:
- the full name of the embedded object
-
getPictureData
Return the data on the (internal) picture. For an external linked picture, will return null- Specified by:
getPictureData
in interfaceObjectShape<XSLFShape,
XSLFTextParagraph> - Returns:
- the picture data for this picture.
-
getBlip
protected org.openxmlformats.schemas.drawingml.x2006.main.CTBlip getBlip() -
getBlipId
-
getBlipFill
protected org.openxmlformats.schemas.drawingml.x2006.main.CTBlipFillProperties getBlipFill() -
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 interfaceObjectShape<XSLFShape,
XSLFTextParagraph> - Parameters:
application
- a preset application enummetaData
- or a custom metaData object, can benull
if the application has been set- Returns:
- an
OutputStream
which receives the new data, the data will be persisted onclose()
- Throws:
IOException
- if the linked object data couldn't be found or a new object data couldn't be initialized
-