Package org.apache.poi.hslf.model
Class HeadersFooters
java.lang.Object
org.apache.poi.hslf.model.HeadersFooters
Header / Footer settings.
You can get these on slides, or across all notes
-
Constructor Summary
ConstructorsConstructorDescriptionHeadersFooters
(HSLFSheet sheet, short headerFooterType) HeadersFooters
(HSLFSlideShow ppt, short headerFooterType) -
Method Summary
Modifier and TypeMethodDescriptionint
An integer that specifies the format ID to be used to style the datetime.This is the date that the user wants in the footers, instead of today's date.Footer's textHeaders's textboolean
whether the date is displayed in the footer.boolean
whether the footer text is displayed.boolean
whether the header text is displayed.boolean
boolean
whether the slide number is displayed in the footer.boolean
whether the custom user date is used instead of today's date.void
setDateTimeFormat
(int formatId) An integer that specifies the format ID to be used to style the datetime.void
setDateTimeText
(String text) Sets custom user date to be displayed instead of today's date.void
setDateTimeVisible
(boolean flag) whether the date is displayed in the footer.void
setFootersText
(String text) Sets footers's textvoid
setFooterVisible
(boolean flag) whether the footer text is displayed.void
setHeaderText
(String text) Sets headers's textvoid
setHeaderVisible
(boolean flag) whether the header text is displayed.void
setSlideNumberVisible
(boolean flag) whether the slide number is displayed in the footer.void
setUserDateVisible
(boolean flag) whether the date is displayed in the footer.
-
Constructor Details
-
HeadersFooters
-
HeadersFooters
-
-
Method Details
-
getHeaderText
Headers's text- Returns:
- Headers's text
-
setHeaderText
Sets headers's text- Parameters:
text
- headers's text
-
getDateTimeText
This is the date that the user wants in the footers, instead of today's date.- Returns:
- custom user date
-
setDateTimeText
Sets custom user date to be displayed instead of today's date.- Parameters:
text
- custom user date
-
isHeaderVisible
public boolean isHeaderVisible()whether the header text is displayed. -
setHeaderVisible
public void setHeaderVisible(boolean flag) whether the header text is displayed. -
isDateTimeVisible
public boolean isDateTimeVisible()whether the date is displayed in the footer. -
setDateTimeVisible
public void setDateTimeVisible(boolean flag) whether the date is displayed in the footer. -
isUserDateVisible
public boolean isUserDateVisible()whether the custom user date is used instead of today's date. -
setUserDateVisible
public void setUserDateVisible(boolean flag) whether the date is displayed in the footer. -
isSlideNumberVisible
public boolean isSlideNumberVisible()whether the slide number is displayed in the footer. -
setSlideNumberVisible
public void setSlideNumberVisible(boolean flag) whether the slide number is displayed in the footer. -
getDateTimeFormat
public int getDateTimeFormat()An integer that specifies the format ID to be used to style the datetime.- Returns:
- an integer that specifies the format ID to be used to style the datetime.
-
setDateTimeFormat
public void setDateTimeFormat(int formatId) An integer that specifies the format ID to be used to style the datetime.- Parameters:
formatId
- an integer that specifies the format ID to be used to style the datetime.
-
isPpt2007
public boolean isPpt2007()- Returns:
- true, if this is a ppt 2007 document and header/footer are stored as placeholder shapes
-