org.apache.poi.xslf.usermodel
Class XSLFSlideMaster
java.lang.Object
org.apache.poi.POIXMLDocumentPart
org.apache.poi.xslf.usermodel.XSLFSheet
org.apache.poi.xslf.usermodel.XSLFSlideMaster
- All Implemented Interfaces:
- java.lang.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.
| Methods inherited from class org.apache.poi.xslf.usermodel.XSLFSheet |
addShape, appendContent, buildShapes, clear, commit, createAutoShape, createConnector, createFreeform, createGroup, createPicture, createTable, createTable, createTextBox, draw, getCommonSlideData, getFollowMasterGraphics, getPlaceholder, getPlaceholders, getShapes, getSlideShow, getSpTree, getTextShapeByType, importContent, iterator, removeShape, setCommonSlideData |
| Methods inherited from class org.apache.poi.POIXMLDocumentPart |
_invokeOnDocumentRead, addRelation, createRelationship, createRelationship, createRelationship, getNextPartNumber, getPackagePart, getParent, getRelationById, getRelationId, getRelationParts, getRelations, getTargetPart, onDocumentCreate, onDocumentRead, 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 java.lang.Iterable |
iterator |
XSLFSlideMaster
protected XSLFSlideMaster(PackagePart part)
throws java.io.IOException,
org.apache.xmlbeans.XmlException
- Throws:
java.io.IOException
org.apache.xmlbeans.XmlException- Since:
- POI 3.14-Beta1
getXmlObject
public org.openxmlformats.schemas.presentationml.x2006.main.CTSlideMaster getXmlObject()
- Specified by:
getXmlObject in class XSLFSheet
- Returns:
- top-level Xml bean representing this sheet
getRootElementName
protected java.lang.String getRootElementName()
- Specified by:
getRootElementName in class XSLFSheet
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(java.lang.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
getTheme
public XSLFTheme getTheme()
- 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.
getTextProperties
protected org.openxmlformats.schemas.drawingml.x2006.main.CTTextListStyle getTextProperties(Placeholder textType)
canDraw
protected boolean canDraw(XSLFShape shape)
- Render this sheet into the supplied graphics object
- Overrides:
canDraw in class XSLFSheet
getBackground
public XSLFBackground getBackground()
- Specified by:
getBackground in interface Sheet<XSLFShape,XSLFTextParagraph>- Overrides:
getBackground in class XSLFSheet
- Returns:
- background for this sheet