Package org.apache.poi.xslf.usermodel
Class XSLFSlide
java.lang.Object
org.apache.poi.ooxml.POIXMLDocumentPart
org.apache.poi.xslf.usermodel.XSLFSheet
org.apache.poi.xslf.usermodel.XSLFSlide
- All Implemented Interfaces:
Iterable<XSLFShape>,ShapeContainer<XSLFShape,,XSLFTextParagraph> Sheet<XSLFShape,,XSLFTextParagraph> Slide<XSLFShape,,XSLFTextParagraph> XSLFShapeContainer
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.poi.ooxml.POIXMLDocumentPart
POIXMLDocumentPart.RelationPart -
Method Summary
Modifier and TypeMethodDescriptionvoiddraw(Graphics2D graphics) Render this sheet into the supplied graphics objectbooleangetDisplayPlaceholder(Placeholder placeholder) In XSLF, slidenumber and date shapes aren't marked as placeholders whereas in HSLF they are activated via a HeadersFooter configuration.booleanbooleanbooleanbooleangetNotes()protected StringintgetTheme()getTitle()org.openxmlformats.schemas.presentationml.x2006.main.CTSlideimportContent(XSLFSheet src) Set the contents of this sheet to be a copy of the source sheet.booleanisHidden()protected voidremoveChartRelation(XSLFChart chart) protected voidremoveLayoutRelation(XSLFSlideLayout layout) voidsetFollowMasterBackground(boolean follow) voidsetFollowMasterColourScheme(boolean follow) voidsetFollowMasterGraphics(boolean value) voidsetFollowMasterObjects(boolean follow) voidsetHidden(boolean hidden) Sets the slide visibilityvoidsetNotes(Notes<XSLFShape, XSLFTextParagraph> notes) Methods inherited from class org.apache.poi.xslf.usermodel.XSLFSheet
addShape, allocateShapeId, appendContent, buildShapes, clear, commit, createAutoShape, createConnector, createFreeform, createGroup, createOleShape, createPicture, createTable, createTable, createTextBox, deregisterShapeId, getPlaceholder, getPlaceholder, getPlaceholderDetails, getPlaceholders, getShapes, getSlideShow, getSpTree, getTextShapeByType, iterator, registerShapeId, removeShapeMethods inherited from class org.apache.poi.ooxml.POIXMLDocumentPart
_invokeOnDocumentRead, addRelation, createRelationship, createRelationship, createRelationship, getNextPartNumber, getPackagePart, getParent, getRelationById, getRelationId, getRelationPartById, getRelationParts, getRelations, getTargetPart, isCommited, onDocumentCreate, onDocumentRead, onDocumentRemove, onSave, prepareForCommit, read, rebase, removeRelation, removeRelation, removeRelation, setCommited, toStringMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface java.lang.Iterable
forEach, iterator, spliteratorMethods inherited from interface org.apache.poi.sl.usermodel.ShapeContainer
addShape, createOleShape, createTable, getShapes, removeShapeMethods inherited from interface org.apache.poi.sl.usermodel.Sheet
getPlaceholderDetails, getSlideShow
-
Method Details
-
getXmlObject
public org.openxmlformats.schemas.presentationml.x2006.main.CTSlide getXmlObject()- Specified by:
getXmlObjectin classXSLFSheet- Returns:
- top-level Xml bean representing this sheet
-
getRootElementName
- Specified by:
getRootElementNamein classXSLFSheet
-
removeChartRelation
-
removeLayoutRelation
-
getMasterSheet
- Specified by:
getMasterSheetin interfaceSheet<XSLFShape,XSLFTextParagraph>
-
getSlideLayout
- Specified by:
getSlideLayoutin interfaceSlide<XSLFShape,XSLFTextParagraph> - Returns:
- the assigned slide layout
-
getSlideMaster
-
getCommentsPart
- Returns:
- the comments part or
nullif there weren't any comments - Since:
- POI 4.0.0
-
getCommentAuthorsPart
- Returns:
- the comment authors part or
nullif there weren't any comments - Since:
- POI 4.0.0
-
getComments
- Specified by:
getCommentsin interfaceSlide<XSLFShape,XSLFTextParagraph> - Returns:
- the comment(s) for this slide
-
getNotes
- Specified by:
getNotesin interfaceSlide<XSLFShape,XSLFTextParagraph>
-
getTitle
- Specified by:
getTitlein interfaceSlide<XSLFShape,XSLFTextParagraph> - Returns:
- title of this slide or null if title is not set
-
getTheme
- Overrides:
getThemein classXSLFSheet- Returns:
- theme (shared styles) associated with this theme.
By default returns
nullwhich means that this sheet is theme-less. Sheets that support the notion of themes (slides, masters, layouts, etc.) should override this method and return the corresponding package part.
-
getBackground
- Specified by:
getBackgroundin interfaceSheet<XSLFShape,XSLFTextParagraph> - Overrides:
getBackgroundin classXSLFSheet- Returns:
- the information about background appearance of this slide
-
getFollowMasterGraphics
public boolean getFollowMasterGraphics()- Specified by:
getFollowMasterGraphicsin interfaceSheet<XSLFShape,XSLFTextParagraph> - Overrides:
getFollowMasterGraphicsin classXSLFSheet- Returns:
- whether shapes on the master sheet should be shown. By default master graphics is turned off. Sheets that support the notion of master (slide, slideLayout) should override it and check this setting in the sheet XML
-
setFollowMasterGraphics
public void setFollowMasterGraphics(boolean value) - Parameters:
value- whether shapes on the master slide should be shown or not.
-
getFollowMasterObjects
public boolean getFollowMasterObjects()- Specified by:
getFollowMasterObjectsin interfaceSlide<XSLFShape,XSLFTextParagraph>
-
setFollowMasterObjects
public void setFollowMasterObjects(boolean follow) - Specified by:
setFollowMasterObjectsin interfaceSlide<XSLFShape,XSLFTextParagraph>
-
importContent
Description copied from class:XSLFSheetSet the contents of this sheet to be a copy of the source sheet. This method erases any existing shapes and replaces them with object from the source sheet.- Overrides:
importContentin classXSLFSheet- Parameters:
src- the source sheet to copy data from- Returns:
- modified 'this'
-
getFollowMasterBackground
public boolean getFollowMasterBackground()- Specified by:
getFollowMasterBackgroundin interfaceSlide<XSLFShape,XSLFTextParagraph>
-
setFollowMasterBackground
- Specified by:
setFollowMasterBackgroundin interfaceSlide<XSLFShape,XSLFTextParagraph>
-
getFollowMasterColourScheme
public boolean getFollowMasterColourScheme()- Specified by:
getFollowMasterColourSchemein interfaceSlide<XSLFShape,XSLFTextParagraph>
-
setFollowMasterColourScheme
- Specified by:
setFollowMasterColourSchemein interfaceSlide<XSLFShape,XSLFTextParagraph>
-
setNotes
- Specified by:
setNotesin interfaceSlide<XSLFShape,XSLFTextParagraph>
-
getSlideNumber
public int getSlideNumber()- Specified by:
getSlideNumberin interfaceSlide<XSLFShape,XSLFTextParagraph> - Returns:
- the 1-based slide no.
-
draw
Render this sheet into the supplied graphics object -
getDisplayPlaceholder
Description copied from interface:SlideIn XSLF, slidenumber and date shapes aren't marked as placeholders whereas in HSLF they are activated via a HeadersFooter configuration. This method is used to generalize that handling.- Specified by:
getDisplayPlaceholderin interfaceSlide<XSLFShape,XSLFTextParagraph> - Parameters:
placeholder- the placeholder type- Returns:
trueif the placeholder should be displayed/rendered
-
setHidden
public void setHidden(boolean hidden) Description copied from interface:SlideSets the slide visibility- Specified by:
setHiddenin interfaceSlide<XSLFShape,XSLFTextParagraph> - Parameters:
hidden- slide visibility, iftruethe slide is hidden,falseshows the slide
-
isHidden
public boolean isHidden()- Specified by:
isHiddenin interfaceSlide<XSLFShape,XSLFTextParagraph> - Returns:
- the slide visibility, the slide is hidden when
true- or shown whenfalse
-
getSlideName
- Specified by:
getSlideNamein interfaceSlide<XSLFShape,XSLFTextParagraph> - Returns:
- the slide name, defaults to "Slide[slideNumber]"
-