java.lang.Object
- org.apache.poi.ooxml.POIXMLDocumentPart
- - org.apache.poi.ooxml.POIXMLDocument
  - - org.apache.poi.xslf.usermodel.XMLSlideShow

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, SlideShow<XSLFShape,XSLFTextParagraph>
```
@Beta
public class XMLSlideShow
extends POIXMLDocument
implements SlideShow<XSLFShape,XSLFTextParagraph>
```
High level representation of a ooxml slideshow. This is the first object most users will construct whether they are reading or writing a slideshow. It is also the top level object for creating new slides/etc.

Nested Class Summary
- Nested classes/interfaces inherited from class org.apache.poi.ooxml.POIXMLDocumentPart
  POIXMLDocumentPart.RelationPart

Field Summary
- Fields inherited from class org.apache.poi.ooxml.POIXMLDocument
  DOCUMENT_CREATOR, OLE_OBJECT_REL_TYPE, PACK_OBJECT_REL_TYPE

Constructor Summary

Constructors
Constructor Description

XMLSlideShow()

XMLSlideShow(java.io.InputStream is)

XMLSlideShow(OPCPackage pkg)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`XSLFPictureData`	`addPicture(byte[] pictureData, PictureData.PictureType format)`	Adds a picture to the workbook.
`XSLFPictureData`	`addPicture(java.io.File pict, PictureData.PictureType format)`	Adds a picture to the presentation.
`XSLFPictureData`	`addPicture(java.io.InputStream is, PictureData.PictureType format)`	Adds a picture to the slideshow.
`XSLFChart`	`createChart(XSLFSlide slide)`	Create a blank chart on the given slide.
`MasterSheet<XSLFShape,XSLFTextParagraph>`	`createMasterSheet()`
`void`	`createNotesMaster()`	Create a notes master.
`XSLFSlide`	`createSlide()`	Create a blank slide using the default (first) master.
`XSLFSlide`	`createSlide(XSLFSlideLayout layout)`	Create a slide and initialize it from the specified layout.
`XSLFSlideLayout`	`findLayout(java.lang.String name)`	Scan the master slides for the first slide layout with the given name.
`XSLFPictureData`	`findPictureData(byte[] pictureData)`	check if a picture with this picture data already exists in this presentation
`java.util.List<PackagePart>`	`getAllEmbeddedParts()`	Get the document's embedded files.
`java.util.List<XSLFChart>`	`getCharts()`	Return all the charts in the slideshow
`XSLFCommentAuthors`	`getCommentAuthors()`	Returns the list of comment authors, if there is one.
`CTPresentation`	`getCTPresentation()`
`POIXMLPropertiesTextExtractor`	`getMetadataTextExtractor()`
`XSLFNotesMaster`	`getNotesMaster()`	Return the Notes Master, if there is one.
`XSLFNotes`	`getNotesSlide(XSLFSlide slide)`	Return notes slide for the specified slide or create new if it does not exist yet.
`java.awt.Dimension`	`getPageSize()`	Returns the current page size
`java.lang.Object`	`getPersistDocument()`
`java.util.List<XSLFPictureData>`	`getPictureData()`	Returns all Pictures of this slideshow.
`Resources`	`getResources()`
`java.util.List<XSLFSlideMaster>`	`getSlideMasters()`	Returns all slide masters.
`java.util.List<XSLFSlide>`	`getSlides()`	Return all the slides in the slideshow
`XSLFTableStyles`	`getTableStyles()`
`XSLFSlide`	`removeSlide(int index)`
`void`	`setPageSize(java.awt.Dimension pgSize)`	Change the current page size
`void`	`setSlideOrder(XSLFSlide slide, int newIndex)`

Methods inherited from class org.apache.poi.ooxml.POIXMLDocument
close, getAllEmbedds, getPackage, getProperties, openPackage, write

Methods inherited from class org.apache.poi.ooxml.POIXMLDocumentPart
_invokeOnDocumentRead, addRelation, createRelationship, createRelationship, createRelationship, getPackagePart, getParent, getRelationById, getRelationId, getRelationPartById, getRelationParts, getRelations, isCommited, setCommited, toString

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.io.Closeable
close

Methods inherited from interface org.apache.poi.sl.usermodel.SlideShow
write

- Constructor Detail
  - XMLSlideShow
```
public XMLSlideShow()
```
  - XMLSlideShow
```
public XMLSlideShow(OPCPackage pkg)
```
  - XMLSlideShow
```
public XMLSlideShow(java.io.InputStream is)
             throws java.io.IOException
```
    Throws:
    
    java.io.IOException
- Method Detail
  - getAllEmbeddedParts
```
public java.util.List<PackagePart> getAllEmbeddedParts()
                                                throws OpenXML4JException
```
    Get the document's embedded files.
    
    Specified by:
    
    getAllEmbeddedParts in class POIXMLDocument
    
    Returns:
    
    the document's embedded files
    
    Throws:
    
    OpenXML4JException - if the embedded parts can't be determined
  - getPictureData
```
public java.util.List<XSLFPictureData> getPictureData()
```
    Description copied from interface: SlideShow
    
    Returns all Pictures of this slideshow. The returned List is unmodifiable.
    
    Specified by:
    
    getPictureData in interface SlideShow<XSLFShape,XSLFTextParagraph>
    
    Returns:
    
    a List of PictureData.
  - createSlide
```
public XSLFSlide createSlide(XSLFSlideLayout layout)
```
    Create a slide and initialize it from the specified layout.
    
    Parameters:
    
    layout - The layout to use for the new slide.
    
    Returns:
    
    created slide
  - createSlide
```
public XSLFSlide createSlide()
```
    Create a blank slide using the default (first) master.
    
    Specified by:
    
    createSlide in interface SlideShow<XSLFShape,XSLFTextParagraph>
  - createChart
```
public XSLFChart createChart(XSLFSlide slide)
```
    Create a blank chart on the given slide.
  - getNotesSlide
```
public XSLFNotes getNotesSlide(XSLFSlide slide)
```
    Return notes slide for the specified slide or create new if it does not exist yet.
  - createNotesMaster
```
public void createNotesMaster()
```
    Create a notes master.
  - getNotesMaster
```
public XSLFNotesMaster getNotesMaster()
```
    Return the Notes Master, if there is one. (May not be present if no notes exist)
  - getSlideMasters
```
public java.util.List<XSLFSlideMaster> getSlideMasters()
```
    Description copied from interface: SlideShow
    
    Returns all slide masters. This doesn't include notes master and other arbitrary masters.
    
    Specified by:
    
    getSlideMasters in interface SlideShow<XSLFShape,XSLFTextParagraph>
  - getSlides
```
public java.util.List<XSLFSlide> getSlides()
```
    Return all the slides in the slideshow
    
    Specified by:
    
    getSlides in interface SlideShow<XSLFShape,XSLFTextParagraph>
  - getCharts
```
public java.util.List<XSLFChart> getCharts()
```
    Return all the charts in the slideshow
  - getCommentAuthors
```
public XSLFCommentAuthors getCommentAuthors()
```
    Returns the list of comment authors, if there is one. Will only be present if at least one slide has comments on it.
  - setSlideOrder
```
public void setSlideOrder(XSLFSlide slide,
                          int newIndex)
```
    Parameters:
    
    newIndex - 0-based index of the slide
  - removeSlide
```
public XSLFSlide removeSlide(int index)
```
  - getPageSize
```
public java.awt.Dimension getPageSize()
```
    Description copied from interface: SlideShow
    
    Returns the current page size
    
    Specified by:
    
    getPageSize in interface SlideShow<XSLFShape,XSLFTextParagraph>
    
    Returns:
    
    the page size
  - setPageSize
```
public void setPageSize(java.awt.Dimension pgSize)
```
    Description copied from interface: SlideShow
    
    Change the current page size
    
    Specified by:
    
    setPageSize in interface SlideShow<XSLFShape,XSLFTextParagraph>
    
    Parameters:
    
    pgSize - page size (in points)
  - getCTPresentation
```
@Internal
public CTPresentation getCTPresentation()
```
  - addPicture
```
public XSLFPictureData addPicture(byte[] pictureData,
                                  PictureData.PictureType format)
```
    Adds a picture to the workbook.
    
    Specified by:
    
    addPicture in interface SlideShow<XSLFShape,XSLFTextParagraph>
    
    Parameters:
    
    pictureData - The bytes of the picture
    
    format - The format of the picture.
    
    Returns:
    
    the picture data
  - addPicture
```
public XSLFPictureData addPicture(java.io.InputStream is,
                                  PictureData.PictureType format)
                           throws java.io.IOException
```
    Adds a picture to the slideshow.
    
    Specified by:
    
    addPicture in interface SlideShow<XSLFShape,XSLFTextParagraph>
    
    Parameters:
    
    is - The stream to read image from
    
    format - The format of the picture
    
    Returns:
    
    the picture data
    
    Throws:
    
    java.io.IOException
    
    Since:
    
    3.15 beta 2
  - addPicture
```
public XSLFPictureData addPicture(java.io.File pict,
                                  PictureData.PictureType format)
                           throws java.io.IOException
```
    Adds a picture to the presentation.
    
    Specified by:
    
    addPicture in interface SlideShow<XSLFShape,XSLFTextParagraph>
    
    Parameters:
    
    pict - The file containing the image to add
    
    format - The format of the picture.
    
    Returns:
    
    the picture data
    
    Throws:
    
    java.io.IOException
    
    Since:
    
    3.15 beta 2
  - findPictureData
```
public XSLFPictureData findPictureData(byte[] pictureData)
```
    check if a picture with this picture data already exists in this presentation
    
    Specified by:
    
    findPictureData in interface SlideShow<XSLFShape,XSLFTextParagraph>
    
    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 2
  - findLayout
```
public XSLFSlideLayout findLayout(java.lang.String name)
```
    Scan the master slides for the first slide layout with the given name.
    
    Parameters:
    
    name - The layout name (case-insensitive). Cannot be null.
    
    Returns:
    
    the first layout found or null on failure
  - getTableStyles
```
public XSLFTableStyles getTableStyles()
```
  - createMasterSheet
```
public MasterSheet<XSLFShape,XSLFTextParagraph> createMasterSheet()
                                                                 throws java.io.IOException
```
    Specified by:
    
    createMasterSheet in interface SlideShow<XSLFShape,XSLFTextParagraph>
    
    Throws:
    
    java.io.IOException
  - getResources
```
public Resources getResources()
```
    Specified by:
    
    getResources in interface SlideShow<XSLFShape,XSLFTextParagraph>
  - getMetadataTextExtractor
```
public POIXMLPropertiesTextExtractor getMetadataTextExtractor()
```
    Specified by:
    
    getMetadataTextExtractor in interface SlideShow<XSLFShape,XSLFTextParagraph>
    
    Returns:
    
    an extractor for the slideshow metadata
  - getPersistDocument
```
public java.lang.Object getPersistDocument()
```
    Specified by:
    
    getPersistDocument in interface SlideShow<XSLFShape,XSLFTextParagraph>
    
    Returns:
    
    the instance which handles the persisting of the slideshow, which is either a subclass of POIDocument or POIXMLDocument

Constructor	Description
`XMLSlideShow()`
`XMLSlideShow(java.io.InputStream is)`
`XMLSlideShow(OPCPackage pkg)`

Class XMLSlideShow

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.poi.ooxml.POIXMLDocumentPart

Field Summary

Fields inherited from class org.apache.poi.ooxml.POIXMLDocument

Constructor Summary

Method Summary

Methods inherited from class org.apache.poi.ooxml.POIXMLDocument

Methods inherited from class org.apache.poi.ooxml.POIXMLDocumentPart

Methods inherited from class java.lang.Object

Methods inherited from interface java.io.Closeable

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

Constructor Detail

XMLSlideShow

XMLSlideShow

XMLSlideShow

Method Detail

getAllEmbeddedParts

getPictureData

createSlide

createSlide

createChart

getNotesSlide

createNotesMaster

getNotesMaster

getSlideMasters

getSlides

getCharts

getCommentAuthors

setSlideOrder

removeSlide

getPageSize

setPageSize

getCTPresentation

addPicture

addPicture

addPicture

findPictureData

findLayout

getTableStyles

createMasterSheet

getResources

getMetadataTextExtractor

getPersistDocument