Package org.apache.poi.xslf.usermodel

Class XSLFSlideShowFactory

java.lang.Object

org.apache.poi.xslf.usermodel.XSLFSlideShowFactory

All Implemented Interfaces:

SlideShowProvider<XSLFShape,XSLFTextParagraph>

@Internal
public class XSLFSlideShowFactory
extends Object
implements SlideShowProvider<XSLFShape,XSLFTextParagraph>

Constructor Summary

Constructors

Constructor	Description
XSLFSlideShowFactory()

Method Summary

Modifier and Type	Method	Description
boolean	accepts(FileMagic fm)
XMLSlideShow	create()	Create a new empty SlideShow
XMLSlideShow	create(File file, String password, boolean readOnly)	Creates the XMLSlideShow from the given File, which must exist and be readable.
XMLSlideShow	create(InputStream stream)	Creates a XMLSlideShow from the given InputStream
XMLSlideShow	create(InputStream inp, String password)
XMLSlideShow	create(DirectoryNode root, String password)
static XMLSlideShow	createSlideShow(OPCPackage pkg)	Creates a XMLSlideShow from the given OOXML Package

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

accepts

public boolean accepts(FileMagic fm)

Specified by:

accepts in interface SlideShowProvider<XSLFShape,XSLFTextParagraph>

create

public XMLSlideShow create()

Create a new empty SlideShow

Specified by:

create in interface SlideShowProvider<XSLFShape,XSLFTextParagraph>

Returns:

The created SlideShow

create

public XMLSlideShow create(DirectoryNode root,
                           String password)
                    throws IOException

Specified by:

create in interface SlideShowProvider<XSLFShape,XSLFTextParagraph>

Throws:

IOException

create

public XMLSlideShow create(InputStream inp,
                           String password)
                    throws IOException

Specified by:

create in interface SlideShowProvider<XSLFShape,XSLFTextParagraph>

Throws:

IOException

create

public XMLSlideShow create(InputStream stream)
                    throws IOException

Creates a XMLSlideShow from the given InputStream

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

Specified by:

create in interface SlideShowProvider<XSLFShape,XSLFTextParagraph>

Parameters:

stream - The InputStream to read data from.

Returns:

The created SlideShow

Throws:

IOException - if an error occurs while reading the data

createSlideShow

public static XMLSlideShow createSlideShow(OPCPackage pkg)
                                    throws 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:

IOException - if an error occurs while reading the data

create

public XMLSlideShow create(File file,
                           String password,
                           boolean readOnly)
                    throws IOException

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

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

Specified by:

create in interface SlideShowProvider<XSLFShape,XSLFTextParagraph>

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:

IOException - if an error occurs while reading the data

EncryptedDocumentException - If the wrong password is given for a protected file