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 XSLFSlide

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

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

    @Beta
    public final class XSLFSlide

extends XSLFSheet
implements Slide<XSLFShape,XSLFTextParagraph>

Nested Class Summary

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

Method Summary
`void` | `draw(java.awt.Graphics2D graphics)` Render this sheet into the supplied graphics object
`XSLFBackground` | `getBackground()`
`XSLFComments` | `getComments()`
`boolean` | `getDisplayPlaceholder(Placeholder placeholder)` In XSLF, slidenumber and date shapes aren't marked as placeholders whereas in HSLF they are activated via a HeadersFooter configuration.
`boolean` | `getFollowMasterBackground()`
`boolean` | `getFollowMasterColourScheme()`
`boolean` | `getFollowMasterGraphics()`
`boolean` | `getFollowMasterObjects()`
`XSLFSlideLayout` | `getMasterSheet()`
`XSLFNotes` | `getNotes()`
`protected java.lang.String` | `getRootElementName()`
`XSLFSlideLayout` | `getSlideLayout()`
`XSLFSlideMaster` | `getSlideMaster()`
`int` | `getSlideNumber()`
`XSLFTheme` | `getTheme()`
`java.lang.String` | `getTitle()`
`org.openxmlformats.schemas.presentationml.x2006.main.CTSlide` | `getXmlObject()`
`XSLFSlide` | `importContent(XSLFSheet src)` Set the contents of this sheet to be a copy of the source sheet.
`void` | `setFollowMasterBackground(boolean follow)`
`void` | `setFollowMasterColourScheme(boolean follow)`
`void` | `setFollowMasterGraphics(boolean value)`
`void` | `setFollowMasterObjects(boolean follow)`
`void` | `setNotes(Notes<XSLFShape,XSLFTextParagraph> notes)`

Methods inherited from class org.apache.poi.xslf.usermodel.XSLFSheet
`addShape, appendContent, buildShapes, canDraw, clear, commit, createAutoShape, createConnector, createFreeform, createGroup, createPicture, createTable, createTable, createTextBox, getCommonSlideData, getPlaceholder, getPlaceholders, getShapes, getSlideShow, getSpTree, getTextShapeByType, 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
`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`

Method Detail

### getXmlObject

    public org.openxmlformats.schemas.presentationml.x2006.main.CTSlide 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 XSLFSlideLayout getMasterSheet()

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

### getSlideLayout

    public XSLFSlideLayout getSlideLayout()

### getSlideMaster

    public XSLFSlideMaster getSlideMaster()

### getComments

    public XSLFComments getComments()

### getNotes

    public XSLFNotes getNotes()

  Specified by:
    `getNotes` in interface `Slide<XSLFShape,XSLFTextParagraph>`

### getTitle

    public java.lang.String getTitle()

  Specified by:
    `getTitle` in interface `Slide<XSLFShape,XSLFTextParagraph>`
  Returns:
    title of this slide or null if title is not set

### 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.

### getBackground

    public XSLFBackground getBackground()

  Specified by:
    `getBackground` in interface `Sheet<XSLFShape,XSLFTextParagraph>`
  Overrides:
    `getBackground` in class `XSLFSheet`
  Returns:
    the information about background appearance of this slide

### getFollowMasterGraphics

    public boolean getFollowMasterGraphics()

  Specified by:
    `getFollowMasterGraphics` in interface `Sheet<XSLFShape,XSLFTextParagraph>`
  Overrides:
    `getFollowMasterGraphics` in class `XSLFSheet`
  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

### setFollowMasterGraphics

    public void setFollowMasterGraphics(boolean value)

  Parameters:
    `value` - whether shapes on the master slide should be shown or not.

### getFollowMasterObjects

    public boolean getFollowMasterObjects()

  Specified by:
    `getFollowMasterObjects` in interface `Slide<XSLFShape,XSLFTextParagraph>`

### setFollowMasterObjects

    public void setFollowMasterObjects(boolean follow)

  Specified by:
    `setFollowMasterObjects` in interface `Slide<XSLFShape,XSLFTextParagraph>`

### importContent

    public XSLFSlide importContent(XSLFSheet src)

  Description copied from class: `XSLFSheet`
  Set the contents of this sheet to be a copy of the source sheet. This method erases any existing shapes and replaces them with object from the source sheet.

  Overrides:
    `importContent` in class `XSLFSheet`
  Parameters:
    `src` - the source sheet to copy data from
  Returns:
    modified 'this'

### getFollowMasterBackground

    public boolean getFollowMasterBackground()

  Specified by:
    `getFollowMasterBackground` in interface `Slide<XSLFShape,XSLFTextParagraph>`

### setFollowMasterBackground

    @NotImplemented
    public void setFollowMasterBackground(boolean follow)

  Specified by:
    `setFollowMasterBackground` in interface `Slide<XSLFShape,XSLFTextParagraph>`

### getFollowMasterColourScheme

    public boolean getFollowMasterColourScheme()

  Specified by:
    `getFollowMasterColourScheme` in interface `Slide<XSLFShape,XSLFTextParagraph>`

### setFollowMasterColourScheme

    @NotImplemented
    public void setFollowMasterColourScheme(boolean follow)

  Specified by:
    `setFollowMasterColourScheme` in interface `Slide<XSLFShape,XSLFTextParagraph>`

### setNotes

    @NotImplemented
    public void setNotes(Notes<XSLFShape,XSLFTextParagraph> notes)

  Specified by:
    `setNotes` in interface `Slide<XSLFShape,XSLFTextParagraph>`

### getSlideNumber

    public int getSlideNumber()

  Specified by:
    `getSlideNumber` in interface `Slide<XSLFShape,XSLFTextParagraph>`
  Returns:
    the 1-based slide no.

### draw

    public void draw(java.awt.Graphics2D graphics)

  Render this sheet into the supplied graphics object

  Specified by:
    `draw` in interface `Sheet<XSLFShape,XSLFTextParagraph>`
  Overrides:
    `draw` in class `XSLFSheet`
  Parameters:
    `graphics` -

### getDisplayPlaceholder

    public boolean getDisplayPlaceholder(Placeholder placeholder)

  Description copied from interface: `Slide`
  In XSLF, slidenumber and date shapes aren't marked as placeholders whereas in HSLF they are activated via a HeadersFooter configuration. This method is used to generalize that handling.

  Specified by:
    `getDisplayPlaceholder` in interface `Slide<XSLFShape,XSLFTextParagraph>`
  Returns:
    `true` if the placeholder should be displayed/rendered

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright 2017 The Apache Software Foundation or its licensors, as applicable.