org.apache.poi.sl.usermodel
Interface SlideShow<S extends Shape<S,P>,P extends TextParagraph<S,P,?>>

All Superinterfaces:

java.io.Closeable

All Known Implementing Classes:

HSLFSlideShow, XMLSlideShow

public interface SlideShow<S extends Shape<S,P>,P extends TextParagraph<S,P,?>>
extends java.io.Closeable

createSlide

Slide<S,P> createSlide()
                                                                       throws java.io.IOException

Throws:

java.io.IOException

getSlides

java.util.List<? extends Slide<S,P>> getSlides()

createMasterSheet

MasterSheet<S,P> createMasterSheet()
                                                                                   throws java.io.IOException

Throws:

java.io.IOException

getSlideMasters

java.util.List<? extends MasterSheet<S,P>> getSlideMasters()

Returns all slide masters. This doesn't include notes master and other arbitrary masters.

getResources

Resources getResources()

getPageSize

java.awt.Dimension getPageSize()

Returns the current page size

Returns:

the page size

setPageSize

void setPageSize(java.awt.Dimension pgsize)

Change the current page size

Parameters:

pgsize - page size (in points)

getPictureData

java.util.List<? extends PictureData> getPictureData()

Returns all Pictures of this slideshow. The returned List is unmodifiable.

Returns:

a List of PictureData.

addPicture

PictureData addPicture(byte[] pictureData,
                       PictureData.PictureType format)
                       throws java.io.IOException

Adds a picture to the presentation.

Parameters:

pictureData - The bytes of the picture

format - The format of the picture.

Returns:

the picture data reference.

Throws:

java.io.IOException

addPicture

PictureData addPicture(java.io.InputStream is,
                       PictureData.PictureType format)
                       throws java.io.IOException

Adds a picture to the presentation.

Parameters:

is - The stream to read the image from

format - The format of the picture.

Returns:

the picture data reference.

Throws:

java.io.IOException

Since:

3.15 beta 1

addPicture

PictureData addPicture(java.io.File pict,
                       PictureData.PictureType format)
                       throws java.io.IOException

Adds a picture to the presentation.

Parameters:

pict - The file containing the image to add

format - The format of the picture.

Returns:

the picture data reference

Throws:

java.io.IOException

Since:

3.15 beta 1

findPictureData

PictureData findPictureData(byte[] pictureData)

check if a picture with this picture data already exists in this presentation

Parameters:

pictureData - The picture data to find in the SlideShow

Returns:

null if picture data is not found in this slideshow

Since:

3.15 beta 3

write

void write(java.io.OutputStream out)
           throws java.io.IOException

Writes out the slideshow file the is represented by an instance of this class

Parameters:

out - The OutputStream to write to.

Throws:

java.io.IOException - If there is an unexpected IOException from the passed in OutputStream