Package org.apache.poi.xslf.usermodel
Class XSLFSlideMaster
java.lang.Object
org.apache.poi.ooxml.POIXMLDocumentPart
org.apache.poi.xslf.usermodel.XSLFSheet
org.apache.poi.xslf.usermodel.XSLFSlideMaster
- All Implemented Interfaces:
Iterable<XSLFShape>,MasterSheet<XSLFShape,,XSLFTextParagraph> ShapeContainer<XSLFShape,,XSLFTextParagraph> Sheet<XSLFShape,,XSLFTextParagraph> XSLFShapeContainer
@Beta
public class XSLFSlideMaster
extends XSLFSheet
implements MasterSheet<XSLFShape,XSLFTextParagraph>
Slide master object associated with this layout.
Within a slide master slide are contained all elements that describe the objects and their corresponding formatting for within a presentation slide.
Within a slide master slide are two main elements. The cSld element specifies the common slide elements such as shapes and their attached text bodies. Then the txStyles element specifies the formatting for the text within each of these shapes. The other properties within a slide master slide specify other properties for within a presentation slide such as color information, headers and footers, as well as timing and transition information for all corresponding presentation slides.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.poi.ooxml.POIXMLDocumentPart
POIXMLDocumentPart.RelationPart -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGet the slide layout by name.getLayout(SlideLayout type) Get the slide layout by type.protected Stringprotected org.openxmlformats.schemas.drawingml.x2006.main.CTTextListStylegetTextProperties(Placeholder textType) org.openxmlformats.schemas.presentationml.x2006.main.CTSlideMasterMethods 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, getFollowMasterGraphics, getPlaceholder, getPlaceholder, getPlaceholderDetails, getPlaceholders, getShapes, getSlideShow, getSpTree, getTextShapeByType, getTheme, importContent, 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.MasterSheet
getPlaceholderMethods inherited from interface org.apache.poi.sl.usermodel.ShapeContainer
addShape, createOleShape, createTable, getShapes, removeShapeMethods inherited from interface org.apache.poi.sl.usermodel.Sheet
draw, getFollowMasterGraphics, getPlaceholderDetails, getSlideShow
-
Constructor Details
-
XSLFSlideMaster
- Throws:
IOExceptionorg.apache.xmlbeans.XmlException- Since:
- POI 3.14-Beta1
-
-
Method Details
-
getXmlObject
public org.openxmlformats.schemas.presentationml.x2006.main.CTSlideMaster getXmlObject()- Specified by:
getXmlObjectin classXSLFSheet- Returns:
- top-level Xml bean representing this sheet
-
getRootElementName
- Specified by:
getRootElementNamein classXSLFSheet
-
getMasterSheet
- Specified by:
getMasterSheetin interfaceSheet<XSLFShape,XSLFTextParagraph>
-
getSlideLayouts
- Returns:
- all slide layouts referencing this master
-
getLayout
Get the slide layout by type.- Parameters:
type- The layout type. Cannot be null.- Returns:
- the layout found or null on failure
-
getLayout
Get the slide layout by name.- Parameters:
name- The layout name (case-insensitive). Cannot be null.- Returns:
- the layout found or null on failure
-
getTextProperties
protected org.openxmlformats.schemas.drawingml.x2006.main.CTTextListStyle getTextProperties(Placeholder textType) -
getBackground
- Specified by:
getBackgroundin interfaceSheet<XSLFShape,XSLFTextParagraph> - Overrides:
getBackgroundin classXSLFSheet- Returns:
- background for this sheet
-