Package org.apache.poi.xslf.usermodel

Class XSLFSlideShow

java.lang.Object

org.apache.poi.ooxml.POIXMLDocumentPart

org.apache.poi.ooxml.POIXMLDocument

org.apache.poi.xslf.usermodel.XSLFSlideShow

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class XSLFSlideShow
extends POIXMLDocument

Experimental class to do low level processing of pptx files. Most users should use the higher level XMLSlideShow instead. If you are using these low level classes, then you will almost certainly need to refer to the OOXML specifications from http://www.ecma-international.org/publications/standards/Ecma-376.htm WARNING - APIs expected to change rapidly

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
XSLFSlideShow(java.lang.String file)
XSLFSlideShow(OPCPackage container)

Method Summary

Modifier and Type	Method	Description
java.util.List<PackagePart>	getAllEmbeddedParts()	Get the document's embedded files.
PackagePart	getNodesPart(CTSlideIdListEntry parentSlide)	Gets the PackagePart of the notes for the given slide, or null if there isn't one.
CTNotesSlide	getNotes(CTSlideIdListEntry slide)	Returns the low level notes object for the given slide, as found from the supplied slide reference
CTPresentation	getPresentation()	Returns the low level presentation base object
CTSlide	getSlide(CTSlideIdListEntry slide)	Returns the low level slide object from the supplied slide reference
CTCommentList	getSlideComments(CTSlideIdListEntry slide)	Returns all the comments for the given slide
CTSlideMaster	getSlideMaster(CTSlideMasterIdListEntry master)	Returns the low level slide master object from the supplied slide master reference
PackagePart	getSlideMasterPart(CTSlideMasterIdListEntry master)
CTSlideMasterIdList	getSlideMasterReferences()	Returns the references from the presentation to its slide masters.
PackagePart	getSlidePart(CTSlideIdListEntry slide)
CTSlideIdList	getSlideReferences()	Returns the references from the presentation to its slides.

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

Constructor Detail

XSLFSlideShow

public XSLFSlideShow(OPCPackage container)
              throws OpenXML4JException,
                     java.io.IOException,
                     XmlException

Throws:

OpenXML4JException

java.io.IOException

XmlException

XSLFSlideShow

public XSLFSlideShow(java.lang.String file)
              throws OpenXML4JException,
                     java.io.IOException,
                     XmlException

Throws:

OpenXML4JException

java.io.IOException

XmlException

Method Detail

getPresentation

@Internal
public CTPresentation getPresentation()

Returns the low level presentation base object

getSlideReferences

@Internal
public CTSlideIdList getSlideReferences()

Returns the references from the presentation to its slides. You'll need these to figure out the slide ordering, and to get at the actual slides themselves

getSlideMasterReferences

@Internal
public CTSlideMasterIdList getSlideMasterReferences()

Returns the references from the presentation to its slide masters. You'll need these to get at the actual slide masters themselves

getSlideMasterPart

public PackagePart getSlideMasterPart(CTSlideMasterIdListEntry master)
                               throws java.io.IOException,
                                      XmlException

Throws:

java.io.IOException

XmlException

getSlideMaster

@Internal
public CTSlideMaster getSlideMaster(CTSlideMasterIdListEntry master)
                             throws java.io.IOException,
                                    XmlException

Returns the low level slide master object from the supplied slide master reference

Throws:

java.io.IOException

XmlException

getSlidePart

public PackagePart getSlidePart(CTSlideIdListEntry slide)
                         throws java.io.IOException,
                                XmlException

Throws:

java.io.IOException

XmlException

getSlide

@Internal
public CTSlide getSlide(CTSlideIdListEntry slide)
                 throws java.io.IOException,
                        XmlException

Returns the low level slide object from the supplied slide reference

Throws:

java.io.IOException

XmlException

getNodesPart

public PackagePart getNodesPart(CTSlideIdListEntry parentSlide)
                         throws java.io.IOException,
                                XmlException

Gets the PackagePart of the notes for the given slide, or null if there isn't one.

Throws:

java.io.IOException

XmlException

getNotes

@Internal
public CTNotesSlide getNotes(CTSlideIdListEntry slide)
                      throws java.io.IOException,
                             XmlException

Returns the low level notes object for the given slide, as found from the supplied slide reference

Throws:

java.io.IOException

XmlException

getSlideComments

@Internal
public CTCommentList getSlideComments(CTSlideIdListEntry slide)
                               throws java.io.IOException,
                                      XmlException

Returns all the comments for the given slide

Throws:

java.io.IOException

XmlException

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