org.apache.poi.xslf.usermodel
Class XSLFPictureShape

java.lang.Object
  extended by org.apache.poi.xslf.usermodel.XSLFShape
      extended by org.apache.poi.xslf.usermodel.XSLFSimpleShape
          extended by 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


Nested Class Summary
 
Nested classes/interfaces inherited from interface org.apache.poi.sl.usermodel.SimpleShape
SimpleShape.Placeholder
 
Method Summary
protected  org.openxmlformats.schemas.drawingml.x2006.main.CTBlip getBlip()
           
protected  java.lang.String getBlipId()
           
protected  java.lang.String getBlipLink()
           
 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)?
 
Methods inherited from class org.apache.poi.xslf.usermodel.XSLFSimpleShape
getAdjustValue, getAnchor, getFillColor, getFillStyle, getFlipHorizontal, getFlipVertical, getGeometry, getLineCap, getLineColor, getLineCompound, getLineDash, getLineDecoration, getLineHeadDecoration, getLineHeadLength, getLineHeadWidth, getLinePaint, getLineTailDecoration, getLineTailLength, getLineTailWidth, getLineWidth, getRotation, getSafeXfrm, getShadow, getShapeType, getStrokeStyle, getXfrm, isPlaceholder, 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
fetchShapeProperty, getBgPr, getBgRef, getCNvPr, getCTPlaceholder, getFillPaint, getGrpSpPr, getPaint, getParent, getShapeId, getShapeName, getSheet, getSpPr, getSpStyle, getXmlObject, selectPaint, selectPaint, selectPaint, selectPaint, selectPaint, selectProperty, setParent, setPlaceholder
 
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
getFillColor, getFillStyle, getGeometry, getLineDecoration, getShadow, getShapeType, getStrokeStyle, isPlaceholder, setFillColor, setShapeType, setStrokeStyle
 
Methods inherited from interface org.apache.poi.sl.usermodel.Shape
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, setAnchor, setFlipHorizontal, setFlipVertical, setRotation
 

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.

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.


getBlip

protected org.openxmlformats.schemas.drawingml.x2006.main.CTBlip getBlip()

getBlipLink

protected java.lang.String getBlipLink()

getBlipId

protected java.lang.String getBlipId()

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


Copyright 2015 The Apache Software Foundation or its licensors, as applicable.