Package org.apache.poi.sl.usermodel
Interface Sheet<S extends Shape<S,P>,P extends TextParagraph<S,P,? extends TextRun>>
-
- All Superinterfaces:
java.lang.Iterable<S>
,ShapeContainer<S,P>
- All Known Subinterfaces:
MasterSheet<S,P>
,Notes<S,P>
,Slide<S,P>
- All Known Implementing Classes:
HSLFMasterSheet
,HSLFNotes
,HSLFSheet
,HSLFSlide
,HSLFSlideMaster
,HSLFTitleMaster
,XSLFNotes
,XSLFNotesMaster
,XSLFSheet
,XSLFSlide
,XSLFSlideLayout
,XSLFSlideMaster
public interface Sheet<S extends Shape<S,P>,P extends TextParagraph<S,P,? extends TextRun>> extends ShapeContainer<S,P>
Common parent of Slides, Notes and Masters
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
draw(java.awt.Graphics2D graphics)
Convenience method to draw a sheet to a graphics contextBackground<S,P>
getBackground()
boolean
getFollowMasterGraphics()
MasterSheet<S,P>
getMasterSheet()
PlaceholderDetails
getPlaceholderDetails(Placeholder placeholder)
Get the placeholder details for the given placeholder type.SlideShow<S,P>
getSlideShow()
-
Methods inherited from interface org.apache.poi.sl.usermodel.ShapeContainer
addShape, createAutoShape, createConnector, createFreeform, createGroup, createOleShape, createPicture, createTable, createTextBox, getShapes, removeShape
-
-
-
-
Method Detail
-
getFollowMasterGraphics
boolean getFollowMasterGraphics()
- 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
-
getMasterSheet
MasterSheet<S,P> getMasterSheet()
-
getBackground
Background<S,P> getBackground()
-
draw
void draw(java.awt.Graphics2D graphics)
Convenience method to draw a sheet to a graphics context
-
getPlaceholderDetails
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
- the placeholder type- Returns:
- the placeholder details or
null
, if the placeholder isn't contained in the sheet - Since:
- POI 4.0.0
-
-