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:
Closeable,AutoCloseable
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 -
Method Summary
Modifier and TypeMethodDescriptionGet the document's embedded files.getNodesPart(org.openxmlformats.schemas.presentationml.x2006.main.CTSlideIdListEntry parentSlide) Gets the PackagePart of the notes for the given slide, or null if there isn't one.org.openxmlformats.schemas.presentationml.x2006.main.CTNotesSlidegetNotes(org.openxmlformats.schemas.presentationml.x2006.main.CTSlideIdListEntry slide) Returns the low level notes object for the given slide, as found from the supplied slide referenceorg.openxmlformats.schemas.presentationml.x2006.main.CTPresentationReturns the low level presentation base objectorg.openxmlformats.schemas.presentationml.x2006.main.CTSlidegetSlide(org.openxmlformats.schemas.presentationml.x2006.main.CTSlideIdListEntry slide) Returns the low level slide object from the supplied slide referenceorg.openxmlformats.schemas.presentationml.x2006.main.CTCommentListgetSlideComments(org.openxmlformats.schemas.presentationml.x2006.main.CTSlideIdListEntry slide) Returns all the comments for the given slideorg.openxmlformats.schemas.presentationml.x2006.main.CTSlideMastergetSlideMaster(org.openxmlformats.schemas.presentationml.x2006.main.CTSlideMasterIdListEntry master) Returns the low level slide master object from the supplied slide master referencegetSlideMasterPart(org.openxmlformats.schemas.presentationml.x2006.main.CTSlideMasterIdListEntry master) org.openxmlformats.schemas.presentationml.x2006.main.CTSlideMasterIdListReturns the references from the presentation to its slide masters.getSlidePart(org.openxmlformats.schemas.presentationml.x2006.main.CTSlideIdListEntry slide) org.openxmlformats.schemas.presentationml.x2006.main.CTSlideIdListReturns the references from the presentation to its slides.Methods inherited from class org.apache.poi.ooxml.POIXMLDocument
close, getAllEmbedds, getCorePart, getPackage, getProperties, getRelatedByType, load, openPackage, writeMethods inherited from class org.apache.poi.ooxml.POIXMLDocumentPart
_invokeOnDocumentRead, addRelation, commit, createRelationship, createRelationship, createRelationship, getNextPartNumber, getPackagePart, getParent, getRelationById, getRelationId, getRelationPartById, getRelationParts, getRelations, getTargetPart, isCommited, onDocumentCreate, onDocumentRead, onDocumentRemove, onSave, prepareForCommit, read, rebase, removeRelation, removeRelation, removeRelation, setCommited, toString
-
Constructor Details
-
XSLFSlideShow
public XSLFSlideShow(OPCPackage container) throws OpenXML4JException, IOException, org.apache.xmlbeans.XmlException - Throws:
OpenXML4JExceptionIOExceptionorg.apache.xmlbeans.XmlException
-
XSLFSlideShow
public XSLFSlideShow(String file) throws OpenXML4JException, IOException, org.apache.xmlbeans.XmlException - Throws:
OpenXML4JExceptionIOExceptionorg.apache.xmlbeans.XmlException
-
-
Method Details
-
getPresentation
@Internal public org.openxmlformats.schemas.presentationml.x2006.main.CTPresentation getPresentation()Returns the low level presentation base object -
getSlideReferences
@Internal public org.openxmlformats.schemas.presentationml.x2006.main.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 org.openxmlformats.schemas.presentationml.x2006.main.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(org.openxmlformats.schemas.presentationml.x2006.main.CTSlideMasterIdListEntry master) throws IOException, org.apache.xmlbeans.XmlException - Throws:
IOExceptionorg.apache.xmlbeans.XmlException
-
getSlideMaster
@Internal public org.openxmlformats.schemas.presentationml.x2006.main.CTSlideMaster getSlideMaster(org.openxmlformats.schemas.presentationml.x2006.main.CTSlideMasterIdListEntry master) throws IOException, org.apache.xmlbeans.XmlException Returns the low level slide master object from the supplied slide master reference- Throws:
IOExceptionorg.apache.xmlbeans.XmlException
-
getSlidePart
public PackagePart getSlidePart(org.openxmlformats.schemas.presentationml.x2006.main.CTSlideIdListEntry slide) throws IOException, org.apache.xmlbeans.XmlException - Throws:
IOExceptionorg.apache.xmlbeans.XmlException
-
getSlide
@Internal public org.openxmlformats.schemas.presentationml.x2006.main.CTSlide getSlide(org.openxmlformats.schemas.presentationml.x2006.main.CTSlideIdListEntry slide) throws IOException, org.apache.xmlbeans.XmlException Returns the low level slide object from the supplied slide reference- Throws:
IOExceptionorg.apache.xmlbeans.XmlException
-
getNodesPart
public PackagePart getNodesPart(org.openxmlformats.schemas.presentationml.x2006.main.CTSlideIdListEntry parentSlide) throws IOException, org.apache.xmlbeans.XmlException Gets the PackagePart of the notes for the given slide, or null if there isn't one.- Throws:
IOExceptionorg.apache.xmlbeans.XmlException
-
getNotes
@Internal public org.openxmlformats.schemas.presentationml.x2006.main.CTNotesSlide getNotes(org.openxmlformats.schemas.presentationml.x2006.main.CTSlideIdListEntry slide) throws IOException, org.apache.xmlbeans.XmlException Returns the low level notes object for the given slide, as found from the supplied slide reference- Throws:
IOExceptionorg.apache.xmlbeans.XmlException
-
getSlideComments
@Internal public org.openxmlformats.schemas.presentationml.x2006.main.CTCommentList getSlideComments(org.openxmlformats.schemas.presentationml.x2006.main.CTSlideIdListEntry slide) throws IOException, org.apache.xmlbeans.XmlException Returns all the comments for the given slide- Throws:
IOExceptionorg.apache.xmlbeans.XmlException
-
getAllEmbeddedParts
Get the document's embedded files.- Specified by:
getAllEmbeddedPartsin classPOIXMLDocument- Returns:
- the document's embedded files
- Throws:
OpenXML4JException- if the embedded parts can't be determined
-