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
_hyperlink, ADJUST_VALUES, DEFAULT_LINE_WIDTH
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
HSLFPictureShape(EscherContainerRecord escherRecord, ShapeContainer<HSLFShape,HSLFTextParagraph> parent)
Create aPicture
objectHSLFPictureShape(HSLFPictureData data)
Create a newPicture
HSLFPictureShape(HSLFPictureData data, ShapeContainer<HSLFShape,HSLFTextParagraph> parent)
Create a newPicture
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
afterInsert(HSLFSheet sh)
By default set the orininal image sizeprotected EscherContainerRecord
createSpContainer(int idx, boolean isChild)
Create a new Picture and populate the inital structure of theEscherSp
record which holds information about this picture.Insets
getClipping()
protected EscherBSERecord
getEscherBSERecord()
HSLFPictureData
getPictureData()
int
getPictureIndex()
Returns index associated with this picture.String
getPictureName()
Name of this picture.ShapeType
getShapeType()
void
setPictureName(String name)
Name of this picture.-
Methods inherited from class org.apache.poi.hslf.usermodel.HSLFSimpleShape
createHyperlink, createSpContainer, 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, setHyperlink, 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, getClientData, getClientDataRecord, getClientRecords, getEscherChild, getEscherChild, getEscherChild, getEscherChild, getEscherOptRecord, getEscherProperty, getEscherProperty, getEscherProperty, getEscherProperty, getEscherProperty, getEscherProperty, getFill, getFillStyle, getFlipHorizontal, getFlipVertical, getParent, getRotation, getShapeId, getShapeName, getSheet, getSpContainer, moveTo, setAnchor, setEscherProperty, setEscherProperty, setEscherProperty, setEscherProperty, setEscherProperty, setFlipHorizontal, setFlipVertical, setRotation, setShapeId, setShapeType, setSheet
-
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.draw.geom.IAdjustableShape
getAdjustValue
-
Methods inherited from interface org.apache.poi.sl.usermodel.PictureShape
getAlternativePictureData
-
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 newPicture
- Parameters:
data
- the picture data
-
HSLFPictureShape
public HSLFPictureShape(HSLFPictureData data, ShapeContainer<HSLFShape,HSLFTextParagraph> parent)
Create a newPicture
- Parameters:
data
- the picture dataparent
- the parent shape
-
HSLFPictureShape
protected HSLFPictureShape(EscherContainerRecord escherRecord, ShapeContainer<HSLFShape,HSLFTextParagraph> parent)
Create aPicture
object- Parameters:
escherRecord
- theEscherSpContainer
record which holds information about this picture in theSlide
parent
- the parent shape of this picture
-
-
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).
-
createSpContainer
protected EscherContainerRecord createSpContainer(int idx, boolean isChild)
Create a new Picture and populate the inital structure of theEscherSp
record which holds information about this picture.- Parameters:
idx
- the index of the picture which refers toEscherBSE
container.- Returns:
- the create Picture object
-
getPictureData
public HSLFPictureData getPictureData()
- Specified by:
getPictureData
in interfacePictureShape<HSLFShape,HSLFTextParagraph>
-
getEscherBSERecord
protected EscherBSERecord getEscherBSERecord()
-
getPictureName
public String getPictureName()
Name of this picture.- Returns:
- name of this picture
-
setPictureName
public void setPictureName(String name)
Name of this picture.- Parameters:
name
- of this picture
-
afterInsert
protected void afterInsert(HSLFSheet sh)
By default set the orininal image size- Overrides:
afterInsert
in classHSLFShape
- Parameters:
sh
- - owning shape
-
getClipping
public Insets getClipping()
- Specified by:
getClipping
in interfacePictureShape<HSLFShape,HSLFTextParagraph>
-
getShapeType
public ShapeType getShapeType()
- Specified by:
getShapeType
in interfaceSimpleShape<HSLFShape,HSLFTextParagraph>
- Overrides:
getShapeType
in classHSLFShape
-
-