XSLFNotesMaster (POI API Documentation)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.poi.xslf.usermodel
Class XSLFNotesMaster

java.lang.Object
  org.apache.poi.POIXMLDocumentPart
      org.apache.poi.xslf.usermodel.XSLFSheet
          org.apache.poi.xslf.usermodel.XSLFNotesMaster

All Implemented Interfaces:: java.lang.Iterable<XSLFShape>, MasterSheet<XSLFShape,XSLFTextParagraph>, ShapeContainer<XSLFShape,XSLFTextParagraph>, Sheet<XSLFShape,XSLFTextParagraph>, XSLFShapeContainer

@Beta public class XSLFNotesMaster
extends XSLFSheet
implements MasterSheet<XSLFShape,XSLFTextParagraph>
extends XSLFSheet
implements MasterSheet<XSLFShape,XSLFTextParagraph>

Notes master object associated with this layout.

Within a notes master slide are contained all elements that describe the objects and their corresponding formatting for within a presentation slide.

Within a nodes master slide are two main elements. The cSld element specifies the common slide elements such as shapes and their attached text bodies. Then the notesStyles element specifies the formatting for the text within each of these shapes.

Author:: Yegor Kozlov

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.poi.POIXMLDocumentPart
`POIXMLDocumentPart.RelationPart`

Constructor Summary
`protected`	`XSLFNotesMaster(PackagePart part)`

Method Summary
`MasterSheet<XSLFShape,XSLFTextParagraph>`	`getMasterSheet()`
`protected java.lang.String`	`getRootElementName()`
`XSLFTheme`	`getTheme()`
`org.openxmlformats.schemas.presentationml.x2006.main.CTNotesMaster`	`getXmlObject()`

Methods inherited from class org.apache.poi.xslf.usermodel.XSLFSheet
`addShape, appendContent, buildShapes, canDraw, clear, commit, createAutoShape, createConnector, createFreeform, createGroup, createPicture, createTable, createTable, createTextBox, draw, getBackground, 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 org.apache.poi.sl.usermodel.Sheet
`draw, getBackground, getFollowMasterGraphics, getSlideShow`

Methods inherited from interface org.apache.poi.sl.usermodel.ShapeContainer
`addShape, createAutoShape, createConnector, createFreeform, createGroup, createPicture, createTable, createTextBox, getShapes, removeShape`

Methods inherited from interface java.lang.Iterable
`iterator`

Constructor Detail

XSLFNotesMaster

protected XSLFNotesMaster(PackagePart part)
                   throws java.io.IOException,
                          org.apache.xmlbeans.XmlException

Throws:: java.io.IOException; org.apache.xmlbeans.XmlException
Since:: POI 3.14-Beta1

Method Detail

getXmlObject

public org.openxmlformats.schemas.presentationml.x2006.main.CTNotesMaster 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 MasterSheet<XSLFShape,XSLFTextParagraph> getMasterSheet()

Specified by:: getMasterSheet in interface Sheet<XSLFShape,XSLFTextParagraph>

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.