XSLFPictureShape (POI API Documentation)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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>
extends XSLFSimpleShape
implements PictureShape<XSLFShape,XSLFTextParagraph>

Represents a picture shape

Method Summary
`java.awt.Insets`	`getClipping()`
`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, setLineDash, setLineHeadDecoration, setLineHeadLength, setLineHeadWidth, setLineTailDecoration, setLineTailLength, setLineTailWidth, setLineWidth, setRotation, setShapeType

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, setLineDash, setLineHeadDecoration, setLineHeadLength, setLineHeadWidth, setLineTailDecoration, setLineTailLength, setLineTailWidth, setLineWidth, setRotation, setShapeType

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
`getFillStyle, getGeometry, getLineDecoration, getShadow, getShapeType, getStrokeStyle, isPlaceholder`

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>

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()

Specified by:: getClipping in interface PictureShape<XSLFShape,XSLFTextParagraph>