Package org.apache.poi.hslf.model

Class HeadersFooters

  • public final class HeadersFooters
extends java.lang.Object
    Header / Footer settings. You can get these on slides, or across all notes

    • Constructor Detail

      • HeadersFooters

        public HeadersFooters​(HSLFSlideShow ppt,
                      short headerFooterType)

      • HeadersFooters

        public HeadersFooters​(HSLFSheet sheet,
                      short headerFooterType)

    • Method Detail

      • getHeaderText

        public java.lang.String getHeaderText()
        Headers's text
        Returns:
        Headers's text

      • setHeaderText

        public void setHeaderText​(java.lang.String text)
        Sets headers's text
        Parameters:
        text - headers's text

      • getFooterText

        public java.lang.String getFooterText()
        Footer's text
        Returns:
        Footer's text

      • setFootersText

        public void setFootersText​(java.lang.String text)
        Sets footers's text
        Parameters:
        text - footers's text

      • getDateTimeText

        public java.lang.String getDateTimeText()
        This is the date that the user wants in the footers, instead of today's date.
        Returns:
        custom user date

      • setDateTimeText

        public void setDateTimeText​(java.lang.String text)
        Sets custom user date to be displayed instead of today's date.
        Parameters:
        text - custom user date

      • isFooterVisible

        public boolean isFooterVisible()
        whether the footer text is displayed.

      • setFooterVisible

        public void setFooterVisible​(boolean flag)
        whether the footer text is displayed.

      • 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.

      • getHeaderAtom

        public CString getHeaderAtom()

      • getFooterAtom

        public CString getFooterAtom()

      • getUserDateAtom

        public CString getUserDateAtom()

      • setUserDateVisible

        public void setUserDateVisible​(boolean flag)
        whether the date is displayed in the footer.

      • isTodayDateVisible

        public boolean isTodayDateVisible()
        whether today's date is used.

      • setTodayDateVisible

        public void setTodayDateVisible​(boolean flag)
        whether the todays 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