Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.poi.xslf.usermodel
Class XSLFSlideShowFactory

    java.lang.Object
      org.apache.poi.sl.usermodel.SlideShowFactory
          org.apache.poi.xslf.usermodel.XSLFSlideShowFactory

    @Internal
    public class XSLFSlideShowFactory

extends SlideShowFactory

Constructor Summary
`XSLFSlideShowFactory()`

Method Summary
`static SlideShow<?,?>` | `createSlideShow(java.io.File file, boolean readOnly)` Creates the XMLSlideShow from the given File, which must exist and be readable.
`static SlideShow<?,?>` | `createSlideShow(java.io.InputStream stream)` Creates a XMLSlideShow from the given InputStream
`static SlideShow<?,?>` | `createSlideShow(OPCPackage pkg)` Creates a XMLSlideShow from the given OOXML Package

Methods inherited from class org.apache.poi.sl.usermodel.SlideShowFactory
`create, create, create, create, create, create, create, createHSLFSlideShow, createSlideShow, createXSLFSlideShow`

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

Constructor Detail

### XSLFSlideShowFactory

    public XSLFSlideShowFactory()

Method Detail

### createSlideShow

    public static SlideShow<?,?> createSlideShow(OPCPackage pkg)
                                          throws java.io.IOException

  Creates a XMLSlideShow from the given OOXML Package

  Note that in order to properly release resources the SlideShow should be closed after use.

  Parameters:
    `pkg` - The `OPCPackage` opened for reading data.
  Returns:
    The created SlideShow
  Throws:
    `java.io.IOException` - if an error occurs while reading the data
    `InvalidFormatException`

### createSlideShow

    public static SlideShow<?,?> createSlideShow(java.io.File file,
                                                 boolean readOnly)
                                          throws java.io.IOException,
                                                 InvalidFormatException

  Creates the XMLSlideShow from the given File, which must exist and be readable.

  Note that in order to properly release resources theSlideShow should be closed after use.

  Parameters:
    `file` - The file to read data from.
    `readOnly` - If the SlideShow should be opened in read-only mode to avoid writing back changes when the document is closed.
  Returns:
    The created SlideShow
  Throws:
    `java.io.IOException` - if an error occurs while reading the data
    `EncryptedDocumentException` - If the wrong password is given for a protected file
    `InvalidFormatException`

### createSlideShow

    public static SlideShow<?,?> createSlideShow(java.io.InputStream stream)
                                          throws java.io.IOException,
                                                 InvalidFormatException

  Creates a XMLSlideShow from the given InputStream

  Note that in order to properly release resources the SlideShow should be closed after use.

  Parameters:
    `stream` - The `InputStream` to read data from.
  Returns:
    The created SlideShow
  Throws:
    `java.io.IOException` - if an error occurs while reading the data
    `InvalidFormatException`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

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