|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.poi.POIXMLDocumentPart
org.apache.poi.POIXMLDocument
org.apache.poi.xslf.usermodel.XMLSlideShow
@Beta public class XMLSlideShow
High level representation of a ooxml slideshow. This is the first object most users will construct whether they are reading or writing a slideshow. It is also the top level object for creating new slides/etc.
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class org.apache.poi.POIXMLDocumentPart |
|---|
POIXMLDocumentPart.RelationPart |
| Field Summary |
|---|
| Fields inherited from class org.apache.poi.POIXMLDocument |
|---|
DOCUMENT_CREATOR, OLE_OBJECT_REL_TYPE, PACK_OBJECT_REL_TYPE |
| Constructor Summary | |
|---|---|
XMLSlideShow()
|
|
XMLSlideShow(java.io.InputStream is)
|
|
XMLSlideShow(OPCPackage pkg)
|
|
| Method Summary | |
|---|---|
XSLFPictureData |
addPicture(byte[] pictureData,
PictureData.PictureType format)
Adds a picture to the workbook. |
XSLFPictureData |
addPicture(java.io.File pict,
PictureData.PictureType format)
Adds a picture to the presentation. |
XSLFPictureData |
addPicture(java.io.InputStream is,
PictureData.PictureType format)
Adds a picture to the slideshow. |
protected void |
commit()
Save the content in the underlying package part. |
MasterSheet<XSLFShape,XSLFTextParagraph> |
createMasterSheet()
|
void |
createNotesMaster()
Create a notes master. |
XSLFSlide |
createSlide()
Create a blank slide using the default (first) master. |
XSLFSlide |
createSlide(XSLFSlideLayout layout)
Create a slide and initialize it from the specified layout. |
XSLFSlideLayout |
findLayout(java.lang.String name)
Scan the master slides for the first slide layout with the given name. |
XSLFPictureData |
findPictureData(byte[] pictureData)
check if a picture with this picture data already exists in this presentation |
java.util.List<PackagePart> |
getAllEmbedds()
Get the document's embedded files. |
XSLFCommentAuthors |
getCommentAuthors()
Returns the list of comment authors, if there is one. |
org.openxmlformats.schemas.presentationml.x2006.main.CTPresentation |
getCTPresentation()
|
XSLFNotesMaster |
getNotesMaster()
Return the Notes Master, if there is one. |
XSLFNotes |
getNotesSlide(XSLFSlide slide)
Return notes slide for the specified slide or create new if it does not exist yet. |
java.awt.Dimension |
getPageSize()
Returns the current page size |
java.util.List<XSLFPictureData> |
getPictureData()
Returns all Pictures of this slideshow. |
Resources |
getResources()
|
java.util.List<XSLFSlideMaster> |
getSlideMasters()
Returns all slide masters. |
java.util.List<XSLFSlide> |
getSlides()
Return all the slides in the slideshow |
XSLFTableStyles |
getTableStyles()
|
protected void |
onDocumentRead()
Fired when a package part is read |
XSLFSlide |
removeSlide(int index)
|
void |
setPageSize(java.awt.Dimension pgSize)
Change the current page size |
void |
setSlideOrder(XSLFSlide slide,
int newIndex)
|
| Methods inherited from class org.apache.poi.POIXMLDocument |
|---|
close, getCorePart, getPackage, getProperties, getRelatedByType, load, openPackage, write |
| Methods inherited from class org.apache.poi.POIXMLDocumentPart |
|---|
_invokeOnDocumentRead, addRelation, createRelationship, createRelationship, createRelationship, getNextPartNumber, getPackagePart, getParent, getRelationById, getRelationId, getRelationParts, getRelations, getTargetPart, onDocumentCreate, onDocumentRemove, onSave, prepareForCommit, read, rebase, removeRelation, removeRelation, toString |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface org.apache.poi.sl.usermodel.SlideShow |
|---|
write |
| Methods inherited from interface java.io.Closeable |
|---|
close |
| Constructor Detail |
|---|
public XMLSlideShow()
public XMLSlideShow(OPCPackage pkg)
public XMLSlideShow(java.io.InputStream is)
throws java.io.IOException
java.io.IOException| Method Detail |
|---|
protected void onDocumentRead()
throws java.io.IOException
POIXMLDocumentPart
onDocumentRead in class POIXMLDocumentPartjava.io.IOException - a subclass may throw an IOException when a document is read
protected void commit()
throws java.io.IOException
POIXMLDocumentPart
protected void commit() throws IOException {
PackagePart part = getPackagePart();
OutputStream out = part.getOutputStream();
XmlObject bean = getXmlBean(); //the "model" which holds changes in memory
bean.save(out, DEFAULT_XML_OPTIONS);
out.close();
}
commit in class POIXMLDocumentPartjava.io.IOException - a subclass may throw an IOException if the changes can't be committed
public java.util.List<PackagePart> getAllEmbedds()
throws OpenXML4JException
getAllEmbedds in class POIXMLDocumentOpenXML4JException - if the embedded parts can't be determinedpublic java.util.List<XSLFPictureData> getPictureData()
SlideShowList is unmodifiable.
getPictureData in interface SlideShow<XSLFShape,XSLFTextParagraph>List of PictureData.public XSLFSlide createSlide(XSLFSlideLayout layout)
layout - The layout to use for the new slide.
public XSLFSlide createSlide()
createSlide in interface SlideShow<XSLFShape,XSLFTextParagraph>public XSLFNotes getNotesSlide(XSLFSlide slide)
public void createNotesMaster()
public XSLFNotesMaster getNotesMaster()
public java.util.List<XSLFSlideMaster> getSlideMasters()
SlideShow
getSlideMasters in interface SlideShow<XSLFShape,XSLFTextParagraph>public java.util.List<XSLFSlide> getSlides()
getSlides in interface SlideShow<XSLFShape,XSLFTextParagraph>public XSLFCommentAuthors getCommentAuthors()
public void setSlideOrder(XSLFSlide slide,
int newIndex)
newIndex - 0-based index of the slidepublic XSLFSlide removeSlide(int index)
public java.awt.Dimension getPageSize()
SlideShow
getPageSize in interface SlideShow<XSLFShape,XSLFTextParagraph>public void setPageSize(java.awt.Dimension pgSize)
SlideShow
setPageSize in interface SlideShow<XSLFShape,XSLFTextParagraph>pgSize - page size (in points)@Internal public org.openxmlformats.schemas.presentationml.x2006.main.CTPresentation getCTPresentation()
public XSLFPictureData addPicture(byte[] pictureData,
PictureData.PictureType format)
addPicture in interface SlideShow<XSLFShape,XSLFTextParagraph>pictureData - The bytes of the pictureformat - The format of the picture.
public XSLFPictureData addPicture(java.io.InputStream is,
PictureData.PictureType format)
throws java.io.IOException
addPicture in interface SlideShow<XSLFShape,XSLFTextParagraph>is - The stream to read image fromformat - The format of the picture
java.io.IOException
public XSLFPictureData addPicture(java.io.File pict,
PictureData.PictureType format)
throws java.io.IOException
addPicture in interface SlideShow<XSLFShape,XSLFTextParagraph>pict - The file containing the image to addformat - The format of the picture.
java.io.IOExceptionpublic XSLFPictureData findPictureData(byte[] pictureData)
findPictureData in interface SlideShow<XSLFShape,XSLFTextParagraph>pictureData - The picture data to find in the SlideShow
null if picture data is not found in this slideshowpublic XSLFSlideLayout findLayout(java.lang.String name)
name - The layout name (case-insensitive). Cannot be null.
public XSLFTableStyles getTableStyles()
public MasterSheet<XSLFShape,XSLFTextParagraph> createMasterSheet()
throws java.io.IOException
createMasterSheet in interface SlideShow<XSLFShape,XSLFTextParagraph>java.io.IOExceptionpublic Resources getResources()
getResources in interface SlideShow<XSLFShape,XSLFTextParagraph>
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||