Package org.apache.poi.sl.usermodel
Interface Slide<S extends Shape<S,P>,P extends TextParagraph<S,P,? extends TextRun>>
- All Superinterfaces:
Iterable<S>
,ShapeContainer<S,
,P> Sheet<S,
P>
public interface Slide<S extends Shape<S,P>,P extends TextParagraph<S,P,? extends TextRun>>
extends Sheet<S,P>
-
Method Summary
Modifier and TypeMethodDescriptionboolean
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
boolean
boolean
getNotes()
int
getTitle()
boolean
isHidden()
void
setFollowMasterBackground
(boolean follow) void
setFollowMasterColourScheme
(boolean follow) void
setFollowMasterObjects
(boolean follow) void
setHidden
(boolean hidden) Sets the slide visibilityvoid
Methods inherited from interface java.lang.Iterable
forEach, iterator, spliterator
Methods inherited from interface org.apache.poi.sl.usermodel.ShapeContainer
addShape, createAutoShape, createConnector, createFreeform, createGroup, createOleShape, createPicture, createTable, createTextBox, getShapes, removeShape
Methods inherited from interface org.apache.poi.sl.usermodel.Sheet
draw, getBackground, getFollowMasterGraphics, getMasterSheet, getPlaceholderDetails, getSlideShow
-
Method Details
-
getNotes
-
setNotes
-
getFollowMasterBackground
boolean getFollowMasterBackground() -
setFollowMasterBackground
void setFollowMasterBackground(boolean follow) -
getFollowMasterColourScheme
boolean getFollowMasterColourScheme() -
setFollowMasterColourScheme
void setFollowMasterColourScheme(boolean follow) -
getFollowMasterObjects
boolean getFollowMasterObjects() -
setFollowMasterObjects
void setFollowMasterObjects(boolean follow) -
getSlideNumber
int getSlideNumber()- Returns:
- the 1-based slide no.
-
getTitle
String getTitle()- Returns:
- title of this slide or null if title is not set
-
getDisplayPlaceholder
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.- Parameters:
placeholder
- the placeholder type- Returns:
true
if the placeholder should be displayed/rendered- Since:
- POI 3.16-beta2
-
setHidden
void setHidden(boolean hidden) Sets the slide visibility- Parameters:
hidden
- slide visibility, iftrue
the slide is hidden,false
shows the slide- Since:
- POI 4.0.0
-
isHidden
boolean isHidden()- Returns:
- the slide visibility, the slide is hidden when
true
- or shown whenfalse
- Since:
- POI 4.0.0
-
getComments
- Returns:
- the comment(s) for this slide
-
getSlideLayout
MasterSheet getSlideLayout()- Returns:
- the assigned slide layout
- Since:
- POI 4.0.0
-
getSlideName
String getSlideName()- Returns:
- the slide name, defaults to "Slide[slideNumber]"
- Since:
- POI 4.0.0
-