Apache POI - Common 5.3.0 · org.apache.poi.sl.usermodel.Slide

Method Summary

Modifier and Type	Method and Description
public List<? extends Comment>	Returns: the comment(s) for this slide getComments()
public default boolean	Returns: `true` if the placeholder should be displayed/rendered getDisplayPlaceholder(Placeholder the placeholder type placeholder) Deprecated in POI 5.2.0 - use `getDisplayPlaceholder(SimpleShape)` In XSLF, slidenumber and date shapes aren't marked as placeholders whereas in HSLF they are activated via a HeadersFooter configuration.
public default boolean	Returns: `true` if the placeholder should be displayed/rendered getDisplayPlaceholder(SimpleShape<?, ?> the shape which references to the placeholder placeholderRefShape) In XSLF, slidenumber and date shapes aren't marked as placeholders whereas in HSLF they are activated via a HeadersFooter configuration.
public boolean	getFollowMasterBackground()
public boolean	getFollowMasterColourScheme()
public boolean	getFollowMasterObjects()
public Notes<S, P>	getNotes()
public MasterSheet<S, P>	Returns: the assigned slide layout getSlideLayout()
public String	Returns: the slide name, defaults to "Slide[slideNumber]" getSlideName()
public int	Returns: the 1-based slide no. getSlideNumber()
public String	Returns: title of this slide or null if title is not set getTitle()
public boolean	Returns: the slide visibility, the slide is hidden when `true` - or shown when `false` isHidden()
public void	setFollowMasterBackground(boolean follow)
public void	setFollowMasterColourScheme(boolean follow)
public void	setFollowMasterObjects(boolean follow)
public void	setHidden(boolean slide visibility, if `true` the slide is hidden, `false` shows the slide hidden) Sets the slide visibility
public void	setNotes(Notes<S, P> notes)

Inherited from org.apache.poi.sl.usermodel.Sheet:: draw getBackground getFollowMasterGraphics getMasterSheet getPlaceholderDetails getSlideShow

Method Detail

getComments	back to summary
public List<? extends Comment> getComments() Returns:List<? extends Comment> the comment(s) for this slide Annotations @SuppressWarnings:java:S1452

getDisplayPlaceholder back to summary

getDisplayPlaceholder	back to summary
public default boolean getDisplayPlaceholder(Placeholder placeholder) Deprecated in POI 5.2.0 - use `getDisplayPlaceholder(SimpleShape)` 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:Placeholder the placeholder type Returns:boolean `true` if the placeholder should be displayed/rendered Annotations @Deprecated @Removal version:6.0.0 Since POI 3.16-beta2

public default boolean getDisplayPlaceholder(Placeholder placeholder)

Deprecated

in POI 5.2.0 - use getDisplayPlaceholder(SimpleShape)

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:Placeholder: the placeholder type

Returns:boolean

true if the placeholder should be displayed/rendered

Annotations

@Deprecated
@Removal
version:6.0.0

Since

POI 3.16-beta2

getDisplayPlaceholder back to summary

getDisplayPlaceholder	back to summary
public default boolean getDisplayPlaceholder(SimpleShape<?, ?> placeholderRefShape) 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 placeholderRefShape:SimpleShape<?, ?> the shape which references to the placeholder Returns:boolean `true` if the placeholder should be displayed/rendered Since POI 5.2.0

public default boolean getDisplayPlaceholder(SimpleShape<?, ?> placeholderRefShape)

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

placeholderRefShape:SimpleShape<?, ?>: the shape which references to the placeholder

Returns:boolean

true if the placeholder should be displayed/rendered

Since

POI 5.2.0

getFollowMasterBackground	back to summary
public boolean getFollowMasterBackground()

getFollowMasterColourScheme	back to summary
public boolean getFollowMasterColourScheme()

getFollowMasterObjects	back to summary
public boolean getFollowMasterObjects()

getNotes	back to summary
public Notes<S, P> getNotes()

getSlideLayout	back to summary
public MasterSheet<S, P> getSlideLayout() Returns:MasterSheet<S, P> the assigned slide layout Since POI 4.0.0

getSlideName	back to summary
public String getSlideName() Returns:String the slide name, defaults to "Slide[slideNumber]" Since POI 4.0.0

getSlideNumber	back to summary
public int getSlideNumber() Returns:int the 1-based slide no.

getTitle	back to summary
public String getTitle() Returns:String title of this slide or null if title is not set

isHidden	back to summary
public boolean isHidden() Returns:boolean the slide visibility, the slide is hidden when `true` - or shown when `false` Since POI 4.0.0

setFollowMasterBackground	back to summary
public void setFollowMasterBackground(boolean follow)

setFollowMasterColourScheme	back to summary
public void setFollowMasterColourScheme(boolean follow)

setFollowMasterObjects	back to summary
public void setFollowMasterObjects(boolean follow)

setHidden back to summary

setHidden	back to summary
public void setHidden(boolean hidden) Sets the slide visibility Parameters hidden:boolean slide visibility, if `true` the slide is hidden, `false` shows the slide Since POI 4.0.0

public void setHidden(boolean hidden)

Sets the slide visibility

Parameters

hidden:boolean: slide visibility, if true the slide is hidden, false shows the slide

Since

POI 4.0.0

setNotes	back to summary
public void setNotes(Notes<S, P> notes)

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

Method Summary

Method Detail