Package org.apache.poi.xslf.usermodel

Class XSLFPictureShape

java.lang.Object

org.apache.poi.xslf.usermodel.XSLFShape

org.apache.poi.xslf.usermodel.XSLFSimpleShape

org.apache.poi.xslf.usermodel.XSLFPictureShape

All Implemented Interfaces:

IAdjustableShape, PictureShape<XSLFShape,XSLFTextParagraph>, PlaceableShape<XSLFShape,XSLFTextParagraph>, Shape<XSLFShape,XSLFTextParagraph>, SimpleShape<XSLFShape,XSLFTextParagraph>

@Beta
public class XSLFPictureShape
extends XSLFSimpleShape
implements PictureShape<XSLFShape,XSLFTextParagraph>

Represents a picture shape

Method Summary

Modifier and Type	Method	Description
java.awt.Insets	getClipping()	Returns the clipping values as percent ratio relatively to the image size.
XSLFPictureData	getPictureData()	Return the data on the (internal) picture.
java.net.URI	getPictureLink()	For an external linked picture, return the last-seen path to the picture.
boolean	isExternalLinkedPicture()	Is this an internal picture (image data included within the PowerPoint file), or an external linked picture (image lives outside)?
void	setPlaceholder(Placeholder placeholder)	Specifies that the corresponding shape should be represented by the generating application as a placeholder.

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

createHyperlink, getAdjustValue, getAnchor, getFillColor, getFillStyle, getFlipHorizontal, getFlipVertical, getGeometry, getHyperlink, getLineCap, getLineColor, getLineCompound, getLineDash, getLineDecoration, getLineHeadDecoration, getLineHeadLength, getLineHeadWidth, getLineTailDecoration, getLineTailLength, getLineTailWidth, getLineWidth, getRotation, getShadow, getShapeType, getStrokeStyle, setAnchor, setFillColor, setFlipHorizontal, setFlipVertical, setLineCap, setLineColor, setLineCompound, setLineDash, setLineHeadDecoration, setLineHeadLength, setLineHeadWidth, setLineTailDecoration, setLineTailLength, setLineTailWidth, setLineWidth, setRotation, setShapeType, setStrokeStyle

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

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

Methods inherited from class java.lang.Object

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

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

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

draw, getAnchor, getParent, getShapeId, getShapeName, getSheet

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

createHyperlink, getFillColor, getFillStyle, getGeometry, getHyperlink, getLineDecoration, getPlaceholder, getPlaceholderDetails, getShadow, getShapeType, getStrokeStyle, isPlaceholder, setFillColor, setShapeType, setStrokeStyle

Method Detail

isExternalLinkedPicture

public boolean isExternalLinkedPicture()

Is this an internal picture (image data included within the PowerPoint file), or an external linked picture (image lives outside)?

getPictureData

public XSLFPictureData getPictureData()

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

Specified by:

getPictureData in interface PictureShape<XSLFShape,XSLFTextParagraph>

Returns:

the picture data for this picture.

setPlaceholder

public void setPlaceholder(Placeholder placeholder)

Description copied from interface: SimpleShape

Specifies that the corresponding shape should be represented by the generating application as a placeholder. When a shape is considered a placeholder by the generating application it can have special properties to alert the user that they may enter content into the shape.

Specified by:

setPlaceholder in interface SimpleShape<XSLFShape,XSLFTextParagraph>

Overrides:

setPlaceholder in class XSLFShape

Parameters:

placeholder - the placeholder or null to remove the reference to the placeholder

See Also:

PlaceholderDetails.setPlaceholder(Placeholder)

getPictureLink

public java.net.URI getPictureLink()

For an external linked picture, return the last-seen path to the picture. For an internal picture, returns null.

getClipping

public java.awt.Insets getClipping()

Description copied from interface: PictureShape

Returns the clipping values as percent ratio relatively to the image size. The clipping are returned as insets converted/scaled to 100000 (=100%).

Specified by:

getClipping in interface PictureShape<XSLFShape,XSLFTextParagraph>

Returns:

the clipping rectangle, which is given in percent in relation to the image width/height