Package org.apache.poi.sl.usermodel

Interface PictureShape<S extends Shape<S,P>,P extends TextParagraph<S,P,? extends TextRun>>

All Superinterfaces:

IAdjustableShape, PlaceableShape<S,P>, Shape<S,P>, SimpleShape<S,P>

All Known Implementing Classes:

ActiveXShape, HSLFObjectShape, HSLFPictureShape, MovieShape, XSLFPictureShape

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

Field Summary

Fields

Modifier and Type	Field	Description
static final int	FULLY_OPAQUE_ALPHA_VALUE
static final int	FULLY_TRANSPARENT_ALPHA_VALUE

Method Summary

Modifier and Type	Method	Description
int	getAlpha()	Returns alpha value in a range between 0 and 100000.
default PictureData	getAlternativePictureData()	Returns an alternative picture data, e.g.
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.draw.geom.IAdjustableShape

getAdjustValue

Methods inherited from interface org.apache.poi.sl.usermodel.PlaceableShape

getAnchor, getFlipHorizontal, getFlipVertical, getParent, getRotation, getSheet, setAnchor, setFlipHorizontal, setFlipVertical, setRotation

Methods inherited from interface org.apache.poi.sl.usermodel.Shape

draw, getAnchor, getParent, getShapeId, getShapeName, getSheet

Methods inherited from interface org.apache.poi.sl.usermodel.SimpleShape

createHyperlink, getFillColor, getFillStyle, getGeometry, getHyperlink, getLineDecoration, getPlaceholder, getPlaceholderDetails, getShadow, getShapeType, getStrokeStyle, isPlaceholder, setFillColor, setPlaceholder, setShapeType, setStrokeStyle

Field Details

FULLY_TRANSPARENT_ALPHA_VALUE

static final int FULLY_TRANSPARENT_ALPHA_VALUE

See Also:

• Constant Field Values

FULLY_OPAQUE_ALPHA_VALUE

static final int FULLY_OPAQUE_ALPHA_VALUE

See Also:

• Constant Field Values

Method Details

getPictureData

PictureData getPictureData()

Returns the picture data for this picture.

Returns:

the picture data for this picture.

getAlternativePictureData

default PictureData getAlternativePictureData()

Returns an alternative picture data, e.g. an embedded SVG image

Returns:

an alternative picture data

Since:

4.1.0

getClipping

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

getAlpha

int getAlpha()

Returns alpha value in a range between 0 and 100000. Value 0 represents complete transparency and 100000 represents complete opacity.

Returns:

alpha value in the range 0..100000.

Since:

6.0.0