Package org.apache.poi.xslf.usermodel
Class XSLFSlideLayout
java.lang.Object
org.apache.poi.ooxml.POIXMLDocumentPart
org.apache.poi.xslf.usermodel.XSLFSheet
org.apache.poi.xslf.usermodel.XSLFSlideLayout
- All Implemented Interfaces:
Iterable<XSLFShape>
,MasterSheet<XSLFShape,
,XSLFTextParagraph> ShapeContainer<XSLFShape,
,XSLFTextParagraph> Sheet<XSLFShape,
,XSLFTextParagraph> XSLFShapeContainer
@Beta
public class XSLFSlideLayout
extends XSLFSheet
implements MasterSheet<XSLFShape,XSLFTextParagraph>
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.poi.ooxml.POIXMLDocumentPart
POIXMLDocumentPart.RelationPart
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
copyLayout
(XSLFSlide slide) Copy placeholders from this layout to the destination slideboolean
getName()
protected String
Slide master object associated with this layout.getTheme()
getType()
org.openxmlformats.schemas.presentationml.x2006.main.CTSlideLayout
While developing only!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, draw, getPlaceholder, getPlaceholder, getPlaceholderDetails, getPlaceholders, getShapes, getSlideShow, getSpTree, getTextShapeByType, importContent, iterator, registerShapeId, removeShape
Methods 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, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.lang.Iterable
forEach, iterator, spliterator
Methods inherited from interface org.apache.poi.sl.usermodel.MasterSheet
getPlaceholder
Methods inherited from interface org.apache.poi.sl.usermodel.ShapeContainer
addShape, createOleShape, createTable, getShapes, removeShape
Methods inherited from interface org.apache.poi.sl.usermodel.Sheet
draw, getPlaceholderDetails, getSlideShow
-
Constructor Details
-
XSLFSlideLayout
- Throws:
IOException
org.apache.xmlbeans.XmlException
- Since:
- POI 3.14-Beta1
-
-
Method Details
-
getName
-
getXmlObject
While developing only!- Specified by:
getXmlObject
in classXSLFSheet
- Returns:
- top-level Xml bean representing this sheet
-
getRootElementName
- Specified by:
getRootElementName
in classXSLFSheet
-
getSlideMaster
Slide master object associated with this layout.- Returns:
- slide master. Never null.
- Throws:
IllegalStateException
- if slide master was not found
-
getMasterSheet
- Specified by:
getMasterSheet
in interfaceSheet<XSLFShape,
XSLFTextParagraph>
-
getTheme
- Overrides:
getTheme
in classXSLFSheet
- Returns:
- theme (shared styles) associated with this theme.
By default returns
null
which 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.
-
getFollowMasterGraphics
public boolean getFollowMasterGraphics()- Specified by:
getFollowMasterGraphics
in interfaceSheet<XSLFShape,
XSLFTextParagraph> - Overrides:
getFollowMasterGraphics
in 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
-
getBackground
- Specified by:
getBackground
in interfaceSheet<XSLFShape,
XSLFTextParagraph> - Overrides:
getBackground
in classXSLFSheet
- Returns:
- background for this sheet
-
copyLayout
Copy placeholders from this layout to the destination slide- Parameters:
slide
- destination slide
-
getType
- Returns:
- type of this layout
-