Package org.apache.poi.hslf.usermodel
Class HSLFObjectShape
java.lang.Object
org.apache.poi.hslf.usermodel.HSLFShape
org.apache.poi.hslf.usermodel.HSLFSimpleShape
org.apache.poi.hslf.usermodel.HSLFPictureShape
org.apache.poi.hslf.usermodel.HSLFObjectShape
- All Implemented Interfaces:
IAdjustableShape,ObjectShape<HSLFShape,,HSLFTextParagraph> PictureShape<HSLFShape,,HSLFTextParagraph> PlaceableShape<HSLFShape,,HSLFTextParagraph> Shape<HSLFShape,,HSLFTextParagraph> SimpleShape<HSLFShape,HSLFTextParagraph>
public final class HSLFObjectShape
extends HSLFPictureShape
implements ObjectShape<HSLFShape,HSLFTextParagraph>
A shape representing embedded OLE object.
-
Field Summary
Fields inherited from class org.apache.poi.hslf.usermodel.HSLFSimpleShape
_hyperlink, DEFAULT_LINE_WIDTH -
Constructor Summary
ConstructorsConstructorDescriptionHSLFObjectShape(EscherContainerRecord escherRecord, ShapeContainer<HSLFShape, HSLFTextParagraph> parent) Create aOLEShapeobjectCreate a newOLEShapeHSLFObjectShape(HSLFPictureData data, ShapeContainer<HSLFShape, HSLFTextParagraph> parent) Create a newOLEShape -
Method Summary
Modifier and TypeMethodDescriptionReturn the record container for this embedded object.Returns the full name of the embedded object, e.g.Returns the instance name of the embedded object, e.g.Returns unique identifier for the OLE object.intReturns unique identifier for the OLE object.Returns the ProgID that stores the OLE Programmatic Identifier.voidsetFullName(String fullName) voidsetObjectID(int objectId) Set the unique identifier for the OLE object and register it in the necessary structuresvoidupdateObjectData(ObjectMetaData.Application application, ObjectMetaData metaData) Updates the ole data.Methods inherited from class org.apache.poi.hslf.usermodel.HSLFPictureShape
afterInsert, createSpContainer, getClipping, getEscherBSERecord, getPictureData, getPictureIndex, getPictureName, getShapeType, setPictureNameMethods inherited from class org.apache.poi.hslf.usermodel.HSLFSimpleShape
createHyperlink, createSpContainer, getAdjustValue, getFillColor, getGeometry, getHyperlink, getLineBackgroundColor, getLineCap, getLineColor, getLineCompound, getLineDash, getLineDecoration, getLineHeadDecoration, getLineHeadLength, getLineHeadWidth, getLineTailDecoration, getLineTailLength, getLineTailWidth, getLineWidth, getPlaceholder, getPlaceholderDetails, getShadow, getShadowAngle, getShadowColor, getShadowDistance, getStrokeStyle, isPlaceholder, setFillColor, setHyperlink, setLineBackgroundColor, setLineCap, setLineColor, setLineCompound, setLineDash, setLineHeadDecoration, setLineHeadLength, setLineHeadWidth, setLineTailDecoration, setLineTailLength, setLineTailWidth, setLineWidth, setPlaceholder, setStrokeStyleMethods inherited from class org.apache.poi.hslf.usermodel.HSLFShape
draw, getAnchor, getClientData, getClientDataRecord, getClientRecords, getEscherChild, getEscherChild, getEscherChild, getEscherChild, getEscherOptRecord, getEscherProperty, getEscherProperty, getEscherProperty, getFill, getFillStyle, getFlipHorizontal, getFlipVertical, getParent, getRotation, getShapeId, getShapeName, getSheet, getSpContainer, moveTo, setAnchor, setEscherProperty, setEscherProperty, setFlipHorizontal, setFlipVertical, setRotation, setShapeId, setShapeType, setSheetMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.poi.sl.draw.geom.IAdjustableShape
getAdjustValueMethods inherited from interface org.apache.poi.sl.usermodel.ObjectShape
getPictureData, readObjectData, readObjectDataRawMethods inherited from interface org.apache.poi.sl.usermodel.PlaceableShape
getAnchor, getFlipHorizontal, getFlipVertical, getParent, getRotation, getSheet, setAnchor, setFlipHorizontal, setFlipVertical, setRotationMethods inherited from interface org.apache.poi.sl.usermodel.Shape
draw, getAnchor, getParent, getShapeId, getShapeName, getSheetMethods inherited from interface org.apache.poi.sl.usermodel.SimpleShape
createHyperlink, getFillColor, getFillStyle, getGeometry, getHyperlink, getLineDecoration, getPlaceholder, getPlaceholderDetails, getShadow, getStrokeStyle, isPlaceholder, setFillColor, setPlaceholder, setShapeType, setStrokeStyle
-
Constructor Details
-
HSLFObjectShape
Create a newOLEShape- Parameters:
data- the picture data
-
HSLFObjectShape
Create a newOLEShape- Parameters:
data- the picture dataparent- the parent shape
-
HSLFObjectShape
public HSLFObjectShape(EscherContainerRecord escherRecord, ShapeContainer<HSLFShape, HSLFTextParagraph> parent) Create aOLEShapeobject- Parameters:
escherRecord- theEscherSpContainerrecord which holds information about this picture in theSlideparent- the parent shape of this picture
-
-
Method Details
-
getObjectID
public int getObjectID()Returns unique identifier for the OLE object.- Returns:
- the unique identifier for the OLE object
-
setObjectID
public void setObjectID(int objectId) Set the unique identifier for the OLE object and register it in the necessary structures- Parameters:
objectId- the unique identifier for the OLE object
-
getObjectData
Returns unique identifier for the OLE object.- Specified by:
getObjectDatain interfaceObjectShape<HSLFShape,HSLFTextParagraph> - Returns:
- the unique identifier for the OLE object
-
getExEmbed
Return the record container for this embedded object.It contains: 1. ExEmbedAtom.(4045) 2. ExOleObjAtom (4035) 3. CString (4026), Instance MenuName (1) used for menus and the Links dialog box. 4. CString (4026), Instance ProgID (2) that stores the OLE Programmatic Identifier. A ProgID is a string that uniquely identifies a given object. 5. CString (4026), Instance ClipboardName (3) that appears in the paste special dialog. 6. MetaFile( 4033), optional
-
getInstanceName
Returns the instance name of the embedded object, e.g. "Document" or "Workbook".- Returns:
- the instance name of the embedded object
-
getFullName
Description copied from interface:ObjectShapeReturns the full name of the embedded object, e.g. "Microsoft Word Document" or "Microsoft Office Excel Worksheet".- Specified by:
getFullNamein interfaceObjectShape<HSLFShape,HSLFTextParagraph> - Returns:
- the full name of the embedded object
-
setFullName
-
getProgId
Description copied from interface:ObjectShapeReturns 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:
getProgIdin interfaceObjectShape<HSLFShape,HSLFTextParagraph> - Returns:
- the ProgID
-
setProgId
-
updateObjectData
public OutputStream updateObjectData(ObjectMetaData.Application application, ObjectMetaData metaData) throws IOException Description copied from interface:ObjectShapeUpdates 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
POIFSFileSystemstream.- Specified by:
updateObjectDatain interfaceObjectShape<HSLFShape,HSLFTextParagraph> - Parameters:
application- a preset application enummetaData- or a custom metaData object, can benullif the application has been set- Returns:
- an
OutputStreamwhich 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
-