org.apache.poi.xslf
Class XSLFSlideShow

java.lang.Object
  extended by org.apache.poi.POIXMLDocumentPart
      extended by org.apache.poi.POIXMLDocument
          extended by org.apache.poi.xslf.XSLFSlideShow

public class XSLFSlideShow
extends POIXMLDocument

Experimental class to do low level processing of pptx files. 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


Field Summary
static java.lang.String COMMENT_RELATION_TYPE
           
static java.lang.String MAIN_CONTENT_TYPE
           
static java.lang.String NOTES_CONTENT_TYPE
           
static java.lang.String NOTES_RELATION_TYPE
           
static java.lang.String SLIDE_CONTENT_TYPE
           
static java.lang.String SLIDE_LAYOUT_RELATION_TYPE
           
 
Fields inherited from class org.apache.poi.POIXMLDocument
CORE_PROPERTIES_REL_TYPE, CUSTOM_PROPERTIES_REL_TYPE, DOCUMENT_CREATOR, EXTENDED_PROPERTIES_REL_TYPE, OLE_OBJECT_REL_TYPE, PACK_OBJECT_REL_TYPE
 
Fields inherited from class org.apache.poi.POIXMLDocumentPart
DEFAULT_XML_OPTIONS
 
Constructor Summary
XSLFSlideShow(OPCPackage container)
           
XSLFSlideShow(java.lang.String file)
           
 
Method Summary
 java.util.List<PackagePart> getAllEmbedds()
          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.POIXMLDocument
ensureWriteAccess, getCorePart, getPackage, getProperties, getRelatedByType, getTargetPart, getTargetPart, hasOOXMLHeader, load, openPackage, write
 
Methods inherited from class org.apache.poi.POIXMLDocumentPart
addRelation, commit, createRelationship, createRelationship, createRelationship, getPackagePart, getPackageRelationship, getParent, getRelations, onDocumentCreate, onDocumentRead, onSave, read, removeRelation, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

MAIN_CONTENT_TYPE

public static final java.lang.String MAIN_CONTENT_TYPE
See Also:
Constant Field Values

NOTES_CONTENT_TYPE

public static final java.lang.String NOTES_CONTENT_TYPE
See Also:
Constant Field Values

SLIDE_CONTENT_TYPE

public static final java.lang.String SLIDE_CONTENT_TYPE
See Also:
Constant Field Values

SLIDE_LAYOUT_RELATION_TYPE

public static final java.lang.String SLIDE_LAYOUT_RELATION_TYPE
See Also:
Constant Field Values

NOTES_RELATION_TYPE

public static final java.lang.String NOTES_RELATION_TYPE
See Also:
Constant Field Values

COMMENT_RELATION_TYPE

public static final java.lang.String COMMENT_RELATION_TYPE
See Also:
Constant Field Values
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

getAllEmbedds

public java.util.List<PackagePart> getAllEmbedds()
                                          throws OpenXML4JException
Get the document's embedded files.

Specified by:
getAllEmbedds in class POIXMLDocument
Throws:
OpenXML4JException


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