Top Description Methods
org.apache.poi.sl.usermodel

public Interface Sheet<S extends Shape<S, P>, P extends TextParagraph<S, P, ? extends TextRun>>

extends ShapeContainer<S extends Shape<S, P>, P extends TextParagraph<S, P, ? extends TextRun>>
Known Direct Subinterfaces
org.apache.poi.sl.usermodel.Slide, org.apache.poi.sl.usermodel.MasterSheet, org.apache.poi.sl.usermodel.Notes
Annotations
@SuppressWarnings:java:S1452
Imports
java.awt.Graphics2D
Common parent of Slides, Notes and Masters

Method Summary

Modifier and TypeMethod and Description
public void
draw(Graphics2D graphics)

Convenience method to draw a sheet to a graphics context

public Background<S, P>
getBackground()

public boolean

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
getFollowMasterGraphics()

public MasterSheet<S, P>
getMasterSheet()

public PlaceholderDetails

Returns:

the placeholder details or null, if the placeholder isn't contained in the sheet
getPlaceholderDetails(Placeholder
the placeholder type
placeholder)

Get the placeholder details for the given placeholder type.

public SlideShow<S, P>
getSlideShow()

Inherited from org.apache.poi.sl.usermodel.ShapeContainer:
addShapecreateAutoShapecreateConnectorcreateFreeformcreateGroupcreateOleShapecreatePicturecreateTablecreateTextBoxgetShapesremoveShape

Method Detail

drawback to summary
public void draw(Graphics2D graphics)

Convenience method to draw a sheet to a graphics context

getBackgroundback to summary
public Background<S, P> getBackground()
getFollowMasterGraphicsback to summary
public boolean getFollowMasterGraphics()
Returns:boolean

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

getMasterSheetback to summary
public MasterSheet<S, P> getMasterSheet()
getPlaceholderDetailsback to summary
public PlaceholderDetails getPlaceholderDetails(Placeholder placeholder)

Get the placeholder details for the given placeholder type. Not all placeholders are also shapes - this is especially true for old HSLF slideshows, which notes have header/footers elements which aren't shapes.

Parameters
placeholder:Placeholder

the placeholder type

Returns:PlaceholderDetails

the placeholder details or null, if the placeholder isn't contained in the sheet

Since
POI 4.0.0
getSlideShowback to summary
public SlideShow<S, P> getSlideShow()