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

Method Summary

Modifier and Type	Method	Description
XSLFBackground	getBackground()
XSLFSlideLayout	getLayout(String name)	Get the slide layout by name.
XSLFSlideLayout	getLayout(SlideLayout type)	Get the slide layout by type.
XSLFSlideMaster	getMasterSheet()
XSLFSlideLayout[]	getSlideLayouts()
CTSlideMaster	getXmlObject()

Methods inherited from class org.apache.poi.xslf.usermodel.XSLFSheet

addChart, addChart, addShape, appendContent, clear, createAutoShape, createConnector, createFreeform, createGroup, createOleShape, createPicture, createTable, createTable, createTextBox, draw, getFollowMasterGraphics, getPlaceholder, getPlaceholder, getPlaceholder, getPlaceholderDetails, getPlaceholders, getShapes, getSlideShow, getTheme, importContent, iterator, removeShape

Methods inherited from class org.apache.poi.ooxml.POIXMLDocumentPart

_invokeOnDocumentRead, addRelation, createRelationship, createRelationship, createRelationship, getNextPartNumber, getPackagePart, getParent, getRelationById, getRelationId, getRelationPartById, getRelationParts, getRelations, isCommitted, setCommitted, toString

Methods inherited from class java.lang.Object

equals, 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, getFollowMasterGraphics, getPlaceholderDetails, getSlideShow

Method Details

getXmlObject

public CTSlideMaster getXmlObject()

Specified by:

getXmlObject in class XSLFSheet

Returns:

top-level Xml bean representing this sheet

getMasterSheet

public XSLFSlideMaster getMasterSheet()

Specified by:

getMasterSheet in interface Sheet<XSLFShape,XSLFTextParagraph>

getSlideLayouts

public XSLFSlideLayout[] getSlideLayouts()

Returns:

all slide layouts referencing this master

getLayout

public XSLFSlideLayout getLayout(SlideLayout type)

Get the slide layout by type.

Parameters:

type - The layout type. Cannot be null.

Returns:

the layout found or null on failure

getLayout

public XSLFSlideLayout getLayout(String name)

Get the slide layout by name.

Parameters:

name - The layout name (case-insensitive). Cannot be null.

Returns:

the layout found or null on failure

getBackground

public XSLFBackground getBackground()

Specified by:

getBackground in interface Sheet<XSLFShape,XSLFTextParagraph>

Overrides:

getBackground in class XSLFSheet

Returns:

background for this sheet