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 TypeMethodDescriptionprotected org.openxmlformats.schemas.drawingml.x2006.main.CTBlipgetBlip()protected org.openxmlformats.schemas.drawingml.x2006.main.CTBlipFillPropertiesprotected Stringprotected StringReturns the clipping values as percent ratio relatively to the image size.Return the data on the (internal) picture.For an external linked picture, return the last-seen path to the picture.booleanIs this an internal picture (image data included within the PowerPoint file), or an external linked picture (image lives outside)?voidsetPlaceholder(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, getLinePaint, getLineTailDecoration, getLineTailLength, getLineTailWidth, getLineWidth, getRotation, getShadow, getShapeType, getStrokeStyle, getXfrm, setAnchor, setFillColor, setFlipHorizontal, setFlipVertical, setLineCap, setLineColor, setLineCompound, setLineDash, setLineHeadDecoration, setLineHeadLength, setLineHeadWidth, setLineTailDecoration, setLineTailLength, setLineTailWidth, setLineWidth, setRotation, setShapeType, setStrokeStyleMethods 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, setParentMethods 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.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, getShapeType, getStrokeStyle, isPlaceholder, setFillColor, setShapeType, setStrokeStyle
-
Method Details
-
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
Return the data on the (internal) picture. For an external linked picture, will return null- Specified by:
getPictureDatain interfacePictureShape<XSLFShape,XSLFTextParagraph> - Returns:
- the picture data for this picture.
-
setPlaceholder
Description copied from interface:SimpleShapeSpecifies 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:
setPlaceholderin interfaceSimpleShape<XSLFShape,XSLFTextParagraph> - Overrides:
setPlaceholderin classXSLFShape- Parameters:
placeholder- the placeholder or null to remove the reference to the placeholder- See Also:
-
getPictureLink
For an external linked picture, return the last-seen path to the picture. For an internal picture, returns null. -
getBlipFill
protected org.openxmlformats.schemas.drawingml.x2006.main.CTBlipFillProperties getBlipFill() -
getBlip
protected org.openxmlformats.schemas.drawingml.x2006.main.CTBlip getBlip() -
getBlipLink
-
getBlipId
-
getClipping
Description copied from interface:PictureShapeReturns the clipping values as percent ratio relatively to the image size. The clipping are returned as insets converted/scaled to 100000 (=100%).- Specified by:
getClippingin interfacePictureShape<XSLFShape,XSLFTextParagraph> - Returns:
- the clipping rectangle, which is given in percent in relation to the image width/height
-