com.aspose.slides
Class HeaderFooter

java.lang.Object
  extended by com.aspose.slides.HeaderFooter

public class HeaderFooter
extends java.lang.Object

Represents the header, footer, slide number, date and time on a slide.


Method Summary
 int getDateTimeFormat()
          Returns the format of a datetime on a slide.
 java.lang.String getDateTimeText()
          Returns the fixed datetime text for a slide.
 java.lang.String getFooterText()
          Returns the footer text for a slide.
 java.lang.String getHeaderText()
          Returns the header text for a slide.
 boolean isDateTimeFixed()
          Determines whether the datetime is a fixed text.
 boolean isDateTimeVisible()
          Determines whether the datetime is visible on a slide.
 boolean isFooterVisible()
          Determines whether the footer is visible on a slide.
 boolean isHeaderVisible()
          Determines whether the header is visible on a slide.
 boolean isPageNumberVisible()
          Determines whether the page number is visible on a slide.
 boolean isShowOnTitleSlide()
          Determines whether the header, footer, page number and datetime are visible on a title slide.
 void setDateTimeFixed(boolean value)
          Sets whether the datetime is a fixed text.
 void setdateTimeText(java.lang.String value)
          Sets the fixed datetime text for a slide.
 void setDateTimeVisible(boolean value)
          Sets whether the datetime is visible on a slide.
 void setFooterText(java.lang.String value)
          Sets the footer text for a slide.
 void setFooterVisible(boolean value)
          Sets whether the footer is visible on a slide.
 void setHeaderText(java.lang.String value)
          Sets the header text for a slide.
 void setHeaderVisible(boolean value)
          Sets whether the header is visible on a slide.
 void setPageNumberVisible(boolean value)
          Sets whether the page number is visible on a slide.
 void setShowOnTitleSlide(boolean value)
          Sets whether the header, footer, page number and datetime are visible on a title slide.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

isHeaderVisible

public boolean isHeaderVisible()
Determines whether the header is visible on a slide.

Returns:
True if the header is visible.

setHeaderVisible

public void setHeaderVisible(boolean value)
Sets whether the header is visible on a slide.

Parameters:
value - True if the header is visible.

getHeaderText

public java.lang.String getHeaderText()
Returns the header text for a slide.

Returns:
the header text.

setHeaderText

public void setHeaderText(java.lang.String value)
Sets the header text for a slide.

Parameters:
value - the header text.

isFooterVisible

public boolean isFooterVisible()
Determines whether the footer is visible on a slide.

Returns:
True if the footer is visible.

setFooterVisible

public void setFooterVisible(boolean value)
Sets whether the footer is visible on a slide.

Parameters:
value - True if the footer is visible.

getFooterText

public java.lang.String getFooterText()
Returns the footer text for a slide.

Returns:
the footer text.

setFooterText

public void setFooterText(java.lang.String value)
Sets the footer text for a slide.

Parameters:
value - the footer text.

isDateTimeVisible

public boolean isDateTimeVisible()
Determines whether the datetime is visible on a slide.

Returns:
True if the datetime is visible.

setDateTimeVisible

public void setDateTimeVisible(boolean value)
Sets whether the datetime is visible on a slide.

Parameters:
value - True if the datetime is visible.

isDateTimeFixed

public boolean isDateTimeFixed()
Determines whether the datetime is a fixed text.

Returns:
True if the datetime is a fixed text.

setDateTimeFixed

public void setDateTimeFixed(boolean value)
Sets whether the datetime is a fixed text.

Parameters:
value - True if the datetime is a fixed text.

getDateTimeText

public java.lang.String getDateTimeText()
Returns the fixed datetime text for a slide.

Returns:
the fixed datetime text.

setdateTimeText

public void setdateTimeText(java.lang.String value)
Sets the fixed datetime text for a slide.

Parameters:
value - the fixed datetime text.

getDateTimeFormat

public int getDateTimeFormat()
Returns the format of a datetime on a slide.

Returns:
the format of a datetime. See DateTimeFormat.

isPageNumberVisible

public boolean isPageNumberVisible()
Determines whether the page number is visible on a slide.

Returns:
True if the page number is visible.

setPageNumberVisible

public void setPageNumberVisible(boolean value)
Sets whether the page number is visible on a slide.

Parameters:
value - True if the page number is visible.

isShowOnTitleSlide

public boolean isShowOnTitleSlide()
Determines whether the header, footer, page number and datetime are visible on a title slide.

Returns:
True if the header, footer, page number and datetime are visible.

setShowOnTitleSlide

public void setShowOnTitleSlide(boolean value)
Sets whether the header, footer, page number and datetime are visible on a title slide.

Parameters:
value - True if the header, footer, page number and datetime are visible.