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


Method Summary
 PictureData addPicture(byte[] pictureData, PictureData.PictureType format)
          Adds a picture to the workbook.
 MasterSheet<S,P> createMasterSheet()
           
 Slide<S,P> createSlide()
           
 java.awt.Dimension getPageSize()
          Returns the current page size
 java.util.List<? extends PictureData> getPictureData()
          Returns all Pictures of this slideshow.
 Resources getResources()
           
 java.util.List<? extends MasterSheet<S,P>> getSlideMasters()
          Returns all slide masters.
 java.util.List<? extends Slide<S,P>> getSlides()
           
 void setPageSize(java.awt.Dimension pgsize)
          Change the current page size
 void write(java.io.OutputStream out)
          Writes out the slideshow file the is represented by an instance of this class
 
Methods inherited from interface java.io.Closeable
close
 

Method Detail

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 workbook.

Parameters:
pictureData - The bytes of the picture
format - The format of the picture.
Returns:
the new picture reference
Throws:
java.io.IOException

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


Copyright 2016 The Apache Software Foundation or its licensors, as applicable.