XMLSlideShow (POI API Documentation)

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

```
@Beta
public class XMLSlideShow
extends POIXMLDocument
```
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.

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

Constructor Summary

Constructors
Constructor Description

XMLSlideShow()

XMLSlideShow(java.io.InputStream is)

XMLSlideShow(OPCPackage pkg)

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

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`XSLFSlideShow`	`_getXSLFSlideShow()`	Deprecated.
`int`	`addPicture(byte[] pictureData, int format)`	Adds a picture to the workbook.
`protected void`	`commit()`	Save the content in the underlying package part.
`void`	`createNotesMaster()`	Create a notes master.
`XSLFSlide`	`createSlide()`	Create a blank slide.
`XSLFSlide`	`createSlide(XSLFSlideLayout layout)`	Create a slide and initialize it from the specified layout.
`java.util.List<PackagePart>`	`getAllEmbedds()`	Get the document's embedded files.
`java.util.List<XSLFPictureData>`	`getAllPictures()`	Returns all Pictures, which are referenced from the document itself.
`XSLFCommentAuthors`	`getCommentAuthors()`	Returns the list of comment authors, if there is one.
`org.openxmlformats.schemas.presentationml.x2006.main.CTPresentation`	`getCTPresentation()`
`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
`XSLFSlideMaster[]`	`getSlideMasters()`
`XSLFSlide[]`	`getSlides()`	Return all the slides in the slideshow
`XSLFTableStyles`	`getTableStyles()`
`protected void`	`onDocumentRead()`	Fired when a package part is read
`XSLFSlide`	`removeSlide(int index)`
`void`	`setPageSize(java.awt.Dimension pgSize)`	Sets the page size to the given `Dimension` object.
`void`	`setSlideOrder(XSLFSlide slide, int newIndex)`

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

Methods inherited from class org.apache.poi.POIXMLDocument
close, getCorePart, getPackage, getProperties, getRelatedByType, hasOOXMLHeader, load, openPackage, write

Methods inherited from class org.apache.poi.POIXMLDocumentPart
addRelation, createRelationship, createRelationship, createRelationship, getPackagePart, getPackageRelationship, getParent, getRelationById, getRelationId, getRelations, getTargetPart, onDocumentCreate, onDocumentRemove, onSave, prepareForCommit, read, rebase, removeRelation, removeRelation, toString

- 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
  - _getXSLFSlideShow
```
@Deprecated
public XSLFSlideShow _getXSLFSlideShow()
                                throws OpenXML4JException,
                                       java.io.IOException,
                                       org.apache.xmlbeans.XmlException
```
    Deprecated.
    
    Throws:
    
    OpenXML4JException
    
    java.io.IOException
    
    org.apache.xmlbeans.XmlException
  - onDocumentRead
```
protected void onDocumentRead()
                       throws java.io.IOException
```
    Description copied from class: POIXMLDocumentPart
    
    Fired when a package part is read
    
    Overrides:
    
    onDocumentRead in class POIXMLDocumentPart
    
    Throws:
    
    java.io.IOException
  - commit
```
protected void commit()
               throws java.io.IOException
```
    Description copied from class: POIXMLDocumentPart
    Save the content in the underlying package part. Default implementation is empty meaning that the package part is left unmodified. Sub-classes should override and add logic to marshal the "model" into Ooxml4J. For example, the code saving a generic XML entry may look as follows:
```
 protected void commit() throws IOException {
   PackagePart part = getPackagePart();
   OutputStream out = part.getOutputStream();
   XmlObject bean = getXmlBean(); //the "model" which holds changes in memory
   bean.save(out, DEFAULT_XML_OPTIONS);
   out.close();
 }
  
```
    Overrides:
    
    commit in class POIXMLDocumentPart
    
    Throws:
    
    java.io.IOException
  - getAllEmbedds
```
public java.util.List<PackagePart> getAllEmbedds()
                                          throws OpenXML4JException
```
    Get the document's embedded files.
    
    Specified by:
    
    getAllEmbedds in class POIXMLDocument
    
    Throws:
    
    OpenXML4JException
  - getAllPictures
```
public java.util.List<XSLFPictureData> getAllPictures()
```
    Returns all Pictures, which are referenced from the document itself.
    
    Returns:
    
    a List of PackagePart. The returned List is unmodifiable.
  - createSlide
```
public XSLFSlide createSlide(XSLFSlideLayout layout)
```
    Create a slide and initialize it from the specified layout.
    
    Parameters:
    
    layout -
    
    Returns:
    
    created slide
  - createSlide
```
public XSLFSlide createSlide()
```
    Create a blank 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 XSLFSlideMaster[] getSlideMasters()
```
  - getSlides
```
public XSLFSlide[] getSlides()
```
    Return all the slides 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()
```
    Returns the current page size
    
    Returns:
    
    the page size
  - setPageSize
```
public void setPageSize(java.awt.Dimension pgSize)
```
    Sets the page size to the given Dimension object.
    
    Parameters:
    
    pgSize - page size
  - getCTPresentation
```
@Internal
public org.openxmlformats.schemas.presentationml.x2006.main.CTPresentation getCTPresentation()
```
  - addPicture
```
public int addPicture(byte[] pictureData,
                      int format)
```
    Adds a picture to the workbook.
    
    Parameters:
    
    pictureData - The bytes of the picture
    
    format - The format of the picture.
    
    Returns:
    
    the index to this picture (1 based).
    
    See Also:
    
    XSLFPictureData.PICTURE_TYPE_EMF, XSLFPictureData.PICTURE_TYPE_WMF, XSLFPictureData.PICTURE_TYPE_PICT, XSLFPictureData.PICTURE_TYPE_JPEG, XSLFPictureData.PICTURE_TYPE_PNG, XSLFPictureData.PICTURE_TYPE_DIB
  - getTableStyles
```
public XSLFTableStyles getTableStyles()
```

Class XMLSlideShow

Field Summary

Fields inherited from class org.apache.poi.POIXMLDocument

Fields inherited from class org.apache.poi.POIXMLDocumentPart

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from class org.apache.poi.POIXMLDocument

Methods inherited from class org.apache.poi.POIXMLDocumentPart

Constructor Detail

XMLSlideShow

XMLSlideShow

XMLSlideShow

Method Detail

_getXSLFSlideShow

onDocumentRead

commit

getAllEmbedds

getAllPictures

createSlide

createSlide

getNotesSlide

createNotesMaster

getNotesMaster

getSlideMasters

getSlides

getCommentAuthors

setSlideOrder

removeSlide

getPageSize

setPageSize

getCTPresentation

addPicture

getTableStyles