org.apache.poi.hslf.usermodel

Class HSLFPlaceholderDetails

java.lang.Object

org.apache.poi.hslf.usermodel.HSLFPlaceholderDetails

All Implemented Interfaces:

PlaceholderDetails

Direct Known Subclasses:

HSLFShapePlaceholderDetails

public class HSLFPlaceholderDetails
extends Object
implements PlaceholderDetails

Extended placeholder details for HSLF sheets - mainly for headers and footers

Since:

POI 4.0.0

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.poi.sl.usermodel.PlaceholderDetails

PlaceholderDetails.PlaceholderSize

Method Summary

Modifier and Type	Method and Description
Placeholder	getPlaceholder()
PlaceholderDetails.PlaceholderSize	getSize()
String	getText()
boolean	isVisible()
void	setPlaceholder(Placeholder placeholder)
void	setSize(PlaceholderDetails.PlaceholderSize size)
void	setText(String text)
void	setVisible(boolean isVisible)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.poi.sl.usermodel.PlaceholderDetails

getDateFormat, getUserDate

Method Detail

isVisible

public boolean isVisible()

Specified by:

isVisible in interface PlaceholderDetails

setVisible

public void setVisible(boolean isVisible)

Specified by:

setVisible in interface PlaceholderDetails

getPlaceholder

public Placeholder getPlaceholder()

Specified by:

getPlaceholder in interface PlaceholderDetails

setPlaceholder

public void setPlaceholder(Placeholder placeholder)

Specified by:

setPlaceholder in interface PlaceholderDetails

Throws:

UnsupportedOperationException - Only sub class(es) of HSLFPlaceholderDetails allow setting the placeholder

getSize

public PlaceholderDetails.PlaceholderSize getSize()

Specified by:

getSize in interface PlaceholderDetails

setSize

public void setSize(PlaceholderDetails.PlaceholderSize size)

Specified by:

setSize in interface PlaceholderDetails

Throws:

UnsupportedOperationException - Only sub class(es) of HSLFPlaceholderDetails allow setting the placeholder

getText

public String getText()

Specified by:

getText in interface PlaceholderDetails

setText

public void setText(String text)

Specified by:

setText in interface PlaceholderDetails