org.apache.poi.hslf.model

Class OLEShape

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.model.OLEShape

All Implemented Interfaces:

IAdjustableShape, PictureShape<HSLFShape,HSLFTextParagraph>, PlaceableShape<HSLFShape,HSLFTextParagraph>, Shape<HSLFShape,HSLFTextParagraph>, SimpleShape<HSLFShape,HSLFTextParagraph>

public final class OLEShape
extends HSLFPictureShape

A shape representing embedded OLE obejct.

Field Summary

Fields inherited from class org.apache.poi.hslf.usermodel.HSLFSimpleShape

_hyperlink, DEFAULT_LINE_WIDTH

Constructor Summary

Constructors

Constructor and Description
OLEShape(EscherContainerRecord escherRecord, ShapeContainer<HSLFShape,HSLFTextParagraph> parent) Create a OLEShape object
OLEShape(HSLFPictureData data) Create a new OLEShape
OLEShape(HSLFPictureData data, ShapeContainer<HSLFShape,HSLFTextParagraph> parent) Create a new OLEShape

Method Summary

Modifier and Type	Method and Description
ExEmbed	getExEmbed() Return the record container for this embedded object.
java.lang.String	getFullName() Returns the full name of the embedded object, e.g.
java.lang.String	getInstanceName() Returns the instance name of the embedded object, e.g.
HSLFObjectData	getObjectData() Returns unique identifier for the OLE object.
int	getObjectID() Returns unique identifier for the OLE object.
java.lang.String	getProgID() Returns the ProgID that stores the OLE Programmatic Identifier.
void	setObjectID(int objectId) Set the unique identifier for the OLE object and register it in the necessary structures

Methods inherited from class org.apache.poi.hslf.usermodel.HSLFPictureShape

afterInsert, createSpContainer, getClipping, getEscherBSERecord, getPictureData, getPictureIndex, getPictureName, getShapeType, setPictureName

Methods 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, getShadow, getShadowAngle, getShadowColor, getShadowDistance, getStrokeStyle, setFillColor, setHyperlink, setLineBackgroundColor, setLineCap, setLineColor, setLineCompound, setLineDash, setLineHeadDecoration, setLineHeadLength, setLineHeadWidth, setLineTailDecoration, setLineTailLength, setLineTailWidth, setLineWidth, setPlaceholder, setStrokeStyle

Methods 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, isPlaceholder, moveTo, setAnchor, setEscherProperty, setEscherProperty, setFlipHorizontal, setFlipVertical, setRotation, setShapeId, setShapeType, setSheet

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.SimpleShape

createHyperlink, getFillColor, getFillStyle, getGeometry, getHyperlink, getLineDecoration, getPlaceholder, getShadow, getStrokeStyle, setFillColor, setPlaceholder, setShapeType, setStrokeStyle

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

draw, getAnchor, getParent, getSheet

Methods inherited from interface org.apache.poi.sl.draw.geom.IAdjustableShape

getAdjustValue

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

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

Constructor Detail

OLEShape

public OLEShape(HSLFPictureData data)

Create a new OLEShape

Parameters:

data - the picture data

OLEShape

public OLEShape(HSLFPictureData data,
                ShapeContainer<HSLFShape,HSLFTextParagraph> parent)

Create a new OLEShape

Parameters:

data - the picture data

parent - the parent shape

OLEShape

public OLEShape(EscherContainerRecord escherRecord,
                ShapeContainer<HSLFShape,HSLFTextParagraph> parent)

Create a OLEShape object

Parameters:

escherRecord - the EscherSpContainer record which holds information about this picture in the Slide

parent - the parent shape of this picture

Method Detail

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

public HSLFObjectData getObjectData()

Returns unique identifier for the OLE object.

Returns:

the unique identifier for the OLE object

getExEmbed

public ExEmbed 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

public java.lang.String getInstanceName()

Returns the instance name of the embedded object, e.g. "Document" or "Workbook".

Returns:

the instance name of the embedded object

getFullName

public java.lang.String getFullName()

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

Returns:

the full name of the embedded object

getProgID

public java.lang.String getProgID()

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".

Returns:

the ProgID