Package org.apache.poi.hslf.model

Class MovieShape

java.lang.Object

org.apache.poi.hslf.usermodel.HSLFShape

org.apache.poi.hslf.usermodel.HSLFSimpleShape

org.apache.poi.hslf.usermodel.HSLFPictureShape

org.apache.poi.hslf.model.MovieShape

All Implemented Interfaces:

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

public final class MovieShape
extends HSLFPictureShape

Represents a movie in a PowerPoint document.

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_MOVIE_THUMBNAIL
static int	MOVIE_AVI
static int	MOVIE_MPEG

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

DEFAULT_LINE_WIDTH

Constructor Summary

Constructors

Constructor	Description
MovieShape(int movieIdx, HSLFPictureData pictureData)	Create a new Picture
MovieShape(int movieIdx, HSLFPictureData pictureData, ShapeContainer<HSLFShape,HSLFTextParagraph> parent)	Create a new Picture
MovieShape(EscherContainerRecord escherRecord, ShapeContainer<HSLFShape,HSLFTextParagraph> parent)	Create a Picture object

Method Summary

Modifier and Type	Method	Description
java.lang.String	getPath()
boolean	isAutoPlay()
void	setAutoPlay(boolean flag)
void	setMovieIndex(int idx)	Assign a movie to this shape

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

getClipping, getPictureData, getPictureIndex, getPictureName, getShapeType, setPictureName

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

Field Detail

DEFAULT_MOVIE_THUMBNAIL

public static final int DEFAULT_MOVIE_THUMBNAIL

See Also:

Constant Field Values

MOVIE_MPEG

public static final int MOVIE_MPEG

See Also:

Constant Field Values

MOVIE_AVI

public static final int MOVIE_AVI

See Also:

Constant Field Values

Constructor Detail

MovieShape

public MovieShape(int movieIdx,
                  HSLFPictureData pictureData)

Create a new Picture

Parameters:

pictureData - the picture data

MovieShape

public MovieShape(int movieIdx,
                  HSLFPictureData pictureData,
                  ShapeContainer<HSLFShape,HSLFTextParagraph> parent)

Create a new Picture

Parameters:

pictureData - the picture data

parent - the parent shape

MovieShape

public MovieShape(EscherContainerRecord escherRecord,
                  ShapeContainer<HSLFShape,HSLFTextParagraph> parent)

Create a Picture object

Parameters:

escherRecord - the EscherSpContainer record which holds information about this picture in the Slide

parent - the parent shape of this picture

Method Detail

setMovieIndex

public void setMovieIndex(int idx)

Assign a movie to this shape

Parameters:

idx - the index of the movie

See Also:

HSLFSlideShow.addMovie(String, int)

setAutoPlay

public void setAutoPlay(boolean flag)

isAutoPlay

public boolean isAutoPlay()

getPath

public java.lang.String getPath()

Returns:

UNC or local path to a video file