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.

Author:

Yegor Kozlov

Field Summary

Fields

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

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

_clientData, _clientRecords, DEFAULT_LINE_WIDTH

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

_escherContainer, _fill, _parent, _sheet, logger

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected EscherContainerRecord	createSpContainer(int idx, boolean isChild) Create a new Placeholder and initialize internal structures
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

afterInsert, getClipping, getEscherBSERecord, getPictureData, getPictureIndex, getPictureName, setPictureName

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

createSpContainer, getAdjustValue, getClientDataRecord, getClientRecords, getFillColor, getGeometry, getLineColor, getLineCompound, getLineDashing, getLineDecoration, getLineWidth, getShadow, getShadowAngle, getShadowColor, getShadowDistance, getStrokeStyle, setFillColor, setHyperlink, setLineColor, setLineCompound, setLineDashing, setLineWidth, updateClientData

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

draw, getAnchor, getEscherChild, getEscherChild, getEscherOptRecord, getEscherProperty, getEscherProperty, getEscherProperty, getFill, getFillStyle, getFlipHorizontal, getFlipVertical, getHyperlink, getParent, getRotation, getShapeId, getShapeName, getShapeType, getSheet, getSpContainer, isPlaceholder, moveTo, setAnchor, 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.usermodel.SimpleShape

getFillStyle, getGeometry, getLineDecoration, getShadow, getShapeType, getStrokeStyle, isPlaceholder

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

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, setAnchor, setFlipHorizontal, setFlipVertical, setRotation

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

createSpContainer

protected EscherContainerRecord createSpContainer(int idx,
                                                  boolean isChild)

Create a new Placeholder and initialize internal structures

Overrides:

createSpContainer in class HSLFPictureShape

Parameters:

idx - the index of the picture which refers to EscherBSE container.

Returns:

the created EscherContainerRecord which holds shape data

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