Apache POI - Common 5.3.0 · org.apache.poi.sl.usermodel.ObjectShape

Method Summary

Modifier and Type	Method and Description
public String	Returns: the full name of the embedded object getFullName() Returns the full name of the embedded object, e.g. "Microsoft Word Document" or "Microsoft Office Excel Worksheet".
public ObjectData	Returns: the data object getObjectData()
public PictureData	Returns: the picture data for this picture. getPictureData() Returns the picture data for this picture.
public String	Returns: the ProgID getProgId() Returns the ProgID that stores the OLE Programmatic Identifier.
public default InputStream	Returns: an `InputStream` which serves the object data readObjectData() Reads the ole data as stream - the application specific stream is served The `raw data` serves the outer/wrapped object, which is usually a `POIFSFileSystem` stream, whereas this method return the unwrapped entry
public default InputStream	Returns: the raw data stream readObjectDataRaw() Convenience method to return the raw data as `InputStream`
public OutputStream	Returns: an `OutputStream` which receives the new data, the data will be persisted on `close()` updateObjectData(ObjectMetaData.Application a preset application enum application, ObjectMetaData or a custom metaData object, can be `null` if the application has been set metaData) Updates the ole data.

Inherited from org.apache.poi.sl.usermodel.PlaceableShape:: getAnchor getFlipHorizontal getFlipVertical getParent getRotation getSheet setAnchor setFlipHorizontal setFlipVertical setRotation
Inherited from org.apache.poi.sl.usermodel.Shape:: draw getAnchor getParent getShapeId getShapeName getSheet

Method Detail

getFullName	back to summary
public String getFullName() Returns the full name of the embedded object, e.g. "Microsoft Word Document" or "Microsoft Office Excel Worksheet". Returns:String the full name of the embedded object

getFullName

back to summary

public String getFullName()

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

Returns:String: the full name of the embedded object

getObjectData	back to summary
public ObjectData getObjectData() Returns:ObjectData the data object

getPictureData	back to summary
public PictureData getPictureData() Returns the picture data for this picture. Returns:PictureData the picture data for this picture.

getPictureData

back to summary

public PictureData getPictureData()

Returns the picture data for this picture.

Returns:PictureData: the picture data for this picture.

getProgId	back to summary
public 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:String the ProgID

getProgId

back to summary

public 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:String: the ProgID

readObjectData back to summary

readObjectData	back to summary
public default InputStream readObjectData() throws IOException Reads the ole data as stream - the application specific stream is served The `raw data` serves the outer/wrapped object, which is usually a `POIFSFileSystem` stream, whereas this method return the unwrapped entry Returns:InputStream an `InputStream` which serves the object data Exceptions IOException: if the linked object data couldn't be found

public default InputStream readObjectData() throws IOException

Reads the ole data as stream - the application specific stream is served The raw data serves the outer/wrapped object, which is usually a POIFSFileSystem stream, whereas this method return the unwrapped entry

Returns:InputStream

an InputStream which serves the object data

Exceptions

IOException:: if the linked object data couldn't be found

readObjectDataRaw back to summary

readObjectDataRaw	back to summary
public default InputStream readObjectDataRaw() throws IOException Convenience method to return the raw data as `InputStream` Returns:InputStream the raw data stream Exceptions IOException: if the data couldn't be retrieved

public default InputStream readObjectDataRaw() throws IOException

Convenience method to return the raw data as InputStream

Returns:InputStream

the raw data stream

Exceptions

IOException:: if the data couldn't be retrieved

updateObjectData back to summary

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

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.

Parameters

application:ObjectMetaData.Application: a preset application enum
metaData:ObjectMetaData: or a custom metaData object, can be null if the application has been set

Returns:OutputStream

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

Exceptions

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

public Interface ObjectShape<S extends Shape<S, P>, P extends TextParagraph<S, P, ? extends TextRun>>

Method Summary

Method Detail