Overview | Package | Class | Use | 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>

Represents a picture shape

Field Summary

Fields inherited from class org.apache.poi.xslf.usermodel.XSLFShape
`PML_NS`

Method Summary
`protected org.openxmlformats.schemas.drawingml.x2006.main.CTBlip` | `getBlip()`
`protected org.openxmlformats.schemas.drawingml.x2006.main.CTBlipFillProperties` | `getBlipFill()`
`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)?
`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, getLinePaint, getLineTailDecoration, getLineTailLength, getLineTailWidth, getLineWidth, getRotation, 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
`draw, fetchShapeProperty, getBgPr, getBgRef, getChild, getCNvPr, getCTPlaceholder, getFillPaint, getGrpSpPr, getParent, getPlaceholder, getShapeId, getShapeName, getShapeProperties, getSheet, getSpStyle, getXmlObject, selectPaint, selectPaint, selectPaint, selectPaint, selectPaint, selectProperty, setParent`

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
`createHyperlink, getFillColor, getFillStyle, getGeometry, getHyperlink, getLineDecoration, getPlaceholder, getShadow, getShapeType, getStrokeStyle, setFillColor, setShapeType, setStrokeStyle`

Methods inherited from interface org.apache.poi.sl.usermodel.Shape
`draw, 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, getSheet, 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.

### setPlaceholder

    public void setPlaceholder(Placeholder placeholder)

  Description copied from class: `XSLFShape`
  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. Different types of placeholders are allowed and can be specified by using the placeholder type attribute for this element

  Specified by:
    `setPlaceholder` in interface `SimpleShape<XSLFShape,XSLFTextParagraph>`
  Overrides:
    `setPlaceholder` in class `XSLFSimpleShape`
  Parameters:
    `placeholder` - The shape to use as placeholder or null if no placeholder should be set.

### 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.

### getBlipFill

    protected org.openxmlformats.schemas.drawingml.x2006.main.CTBlipFillProperties getBlipFill()

### 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

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

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