Package org.apache.poi.sl.usermodel
Interface SlideShow<S extends Shape<S,P>,P extends TextParagraph<S,P,? extends TextRun>>
- All Superinterfaces:
AutoCloseable
,Closeable
- All Known Implementing Classes:
HSLFSlideShow
,XMLSlideShow
public interface SlideShow<S extends Shape<S,P>,P extends TextParagraph<S,P,? extends TextRun>>
extends Closeable
-
Method Summary
Modifier and TypeMethodDescriptionaddPicture
(byte[] pictureData, PictureData.PictureType format) Adds a picture to the presentation.addPicture
(File pict, PictureData.PictureType format) Adds a picture to the presentation.addPicture
(InputStream is, PictureData.PictureType format) Adds a picture to the presentation.findPictureData
(byte[] pictureData) check if a picture with this picture data already exists in this presentationReturns the current page sizeList
<? extends PictureData> Returns all Pictures of this slideshow.List
<? extends MasterSheet<S, P>> Returns all slide masters.void
setPageSize
(Dimension pgsize) Change the current page sizevoid
write
(OutputStream out) Writes out the slideshow file the is represented by an instance of this class
-
Method Details
-
createSlide
- Throws:
IOException
-
getSlides
-
createMasterSheet
- Throws:
IOException
-
getSlideMasters
List<? extends MasterSheet<S,P>> getSlideMasters()Returns all slide masters. This doesn't include notes master and other arbitrary masters. -
getResources
Resources getResources() -
getPageSize
Dimension getPageSize()Returns the current page size- Returns:
- the page size
-
setPageSize
Change the current page size- Parameters:
pgsize
- page size (in points)
-
getPictureData
List<? extends PictureData> getPictureData()Returns all Pictures of this slideshow. The returnedList
is unmodifiable.- Returns:
- a
List
ofPictureData
.
-
addPicture
Adds a picture to the presentation.- Parameters:
pictureData
- The bytes of the pictureformat
- The format of the picture.- Returns:
- the picture data reference.
- Throws:
IOException
-
addPicture
Adds a picture to the presentation.- Parameters:
is
- The stream to read the image fromformat
- The format of the picture.- Returns:
- the picture data reference.
- Throws:
IOException
- Since:
- 3.15 beta 1
-
addPicture
Adds a picture to the presentation.- Parameters:
pict
- The file containing the image to addformat
- The format of the picture.- Returns:
- the picture data reference
- Throws:
IOException
- Since:
- 3.15 beta 1
-
findPictureData
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
Writes out the slideshow file the is represented by an instance of this class- Parameters:
out
- The OutputStream to write to.- Throws:
IOException
- If there is an unexpected IOException from the passed in OutputStream
-
getMetadataTextExtractor
POITextExtractor getMetadataTextExtractor()- Returns:
- an extractor for the slideshow metadata
- Since:
- POI 4.0.0
-
getPersistDocument
Object getPersistDocument()- Returns:
- the instance which handles the persisting of the slideshow,
which is either a subclass of
POIDocument
orPOIXMLDocument
- Since:
- POI 4.0.0
-