PictureShape (POI API Documentation)

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.sl.usermodel
Interface PictureShape<S extends Shape<S,P>,P extends TextParagraph<S,P,?>>

All Superinterfaces:: IAdjustableShape, PlaceableShape<S,P>, Shape<S,P>, SimpleShape<S,P>

All Known Implementing Classes:: ActiveXShape, HSLFPictureShape, MovieShape, OLEShape, XSLFPictureShape

public interface PictureShape<S extends Shape<S,P>,P extends TextParagraph<S,P,?>>
extends SimpleShape<S,P>
extends SimpleShape<S,P>

Method Summary
`java.awt.Insets`	`getClipping()` Returns the clipping values as percent ratio relatively to the image size.
`PictureData`	`getPictureData()` Returns the picture data for this picture.

Methods inherited from interface org.apache.poi.sl.usermodel.SimpleShape
`createHyperlink, getFillColor, getFillStyle, getGeometry, getHyperlink, getLineDecoration, getPlaceholder, getShadow, getShapeType, getStrokeStyle, setFillColor, setPlaceholder, 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

PictureData getPictureData()

Returns the picture data for this picture.

java.awt.Insets getClipping()

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

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