Package org.apache.poi.hslf.usermodel

Class HSLFPictureShape

java.lang.Object

org.apache.poi.hslf.usermodel.HSLFShape

org.apache.poi.hslf.usermodel.HSLFSimpleShape

org.apache.poi.hslf.usermodel.HSLFPictureShape

All Implemented Interfaces:

IAdjustableShape, PictureShape<HSLFShape,HSLFTextParagraph>, PlaceableShape<HSLFShape,HSLFTextParagraph>, Shape<HSLFShape,HSLFTextParagraph>, SimpleShape<HSLFShape,HSLFTextParagraph>

Direct Known Subclasses:

ActiveXShape, HSLFObjectShape, MovieShape

public class HSLFPictureShape
extends HSLFSimpleShape
implements PictureShape<HSLFShape,HSLFTextParagraph>

Represents a picture in a PowerPoint document.

Field Summary

Fields inherited from class org.apache.poi.hslf.usermodel.HSLFSimpleShape

DEFAULT_LINE_WIDTH

Constructor Summary

Constructors

Constructor	Description
HSLFPictureShape(HSLFPictureData data)	Create a new Picture
HSLFPictureShape(HSLFPictureData data, ShapeContainer<HSLFShape,HSLFTextParagraph> parent)	Create a new Picture

Method Summary

Modifier and Type	Method	Description
java.awt.Insets	getClipping()	Returns the clipping values as percent ratio relatively to the image size.
HSLFPictureData	getPictureData()	Returns the picture data for this picture.
int	getPictureIndex()	Returns index associated with this picture.
java.lang.String	getPictureName()	Name of this picture.
ShapeType	getShapeType()
void	setPictureName(java.lang.String name)	Name of this picture.

Methods inherited from class org.apache.poi.hslf.usermodel.HSLFSimpleShape

createHyperlink, getAdjustValue, getFillColor, getGeometry, getHyperlink, getLineBackgroundColor, getLineCap, getLineColor, getLineCompound, getLineDash, getLineDecoration, getLineHeadDecoration, getLineHeadLength, getLineHeadWidth, getLineTailDecoration, getLineTailLength, getLineTailWidth, getLineWidth, getPlaceholder, getPlaceholderDetails, getShadow, getShadowAngle, getShadowColor, getShadowDistance, getStrokeStyle, isPlaceholder, setFillColor, setLineBackgroundColor, setLineCap, setLineColor, setLineCompound, setLineDash, setLineHeadDecoration, setLineHeadLength, setLineHeadWidth, setLineTailDecoration, setLineTailLength, setLineTailWidth, setLineWidth, setPlaceholder, setStrokeStyle

Methods inherited from class org.apache.poi.hslf.usermodel.HSLFShape

draw, getAnchor, getClientDataRecord, getEscherChild, getEscherChild, getEscherChild, getEscherChild, getEscherOptRecord, getEscherProperty, getEscherProperty, getEscherProperty, getFill, getFillStyle, getFlipHorizontal, getFlipVertical, getParent, getRotation, getShapeId, getShapeName, getSheet, getSpContainer, moveTo, setAnchor, setEscherProperty, setEscherProperty, setFlipHorizontal, setFlipVertical, setRotation, setShapeId, setShapeType, setSheet

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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, getStrokeStyle, isPlaceholder, setFillColor, setPlaceholder, setShapeType, setStrokeStyle

Constructor Detail

HSLFPictureShape

public HSLFPictureShape(HSLFPictureData data)

Create a new Picture

Parameters:

data - the picture data

HSLFPictureShape

public HSLFPictureShape(HSLFPictureData data,
                        ShapeContainer<HSLFShape,HSLFTextParagraph> parent)

Create a new Picture

Parameters:

data - the picture data

parent - the parent shape

Method Detail

getPictureIndex

public int getPictureIndex()

Returns index associated with this picture. Index starts with 1 and points to a EscherBSE record which holds information about this picture.

Returns:

the index to this picture (1 based).

getPictureData

public HSLFPictureData getPictureData()

Description copied from interface: PictureShape

Returns the picture data for this picture.

Specified by:

getPictureData in interface PictureShape<HSLFShape,HSLFTextParagraph>

Returns:

the picture data for this picture.

getPictureName

public java.lang.String getPictureName()

Name of this picture.

Returns:

name of this picture

setPictureName

public void setPictureName(java.lang.String name)

Name of this picture.

Parameters:

name - of this picture

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<HSLFShape,HSLFTextParagraph>

Returns:

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

getShapeType

public ShapeType getShapeType()

Specified by:

getShapeType in interface SimpleShape<HSLFShape,HSLFTextParagraph>

Overrides:

getShapeType in class HSLFShape