Class Footer
java.lang.Object
com.independentsoft.office.odf.styles.Footer
- All Implemented Interfaces:
IContentElement
Represents footer of the document.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidAdds a Change object to the content.voidAdds a ChangeEnd object to the content.voidadd(ChangeStart changeStart)Adds a ChangeStart object to the content.voidAdds a Heading object to the content.voidadd(IndexOfIllustrations index)Adds an IndexOfIllustrations object to the content.voidAdds a List object to the content.voidAdds a Paragraph object to the content.voidAdds a Section object to the content.voidadd(IHeaderFooterContent headerContent)Adds an IHeaderFooterContent object to the content.voidAdds a Table object to the content.voidadd(TableOfContents toc)Adds a TableOfContents object to the content.clone()Creates a new object that is a deep copy of the current instance.Specifies the center-aligned portion of a footer.Contains a collection of HeaderFooterContent objects.Returns all content elements.Specifies a left-aligned portion of a footer.Returns the parent content element.Specifies the right-aligned portion of a footer.booleanSpecifies whether the footer is displayed or not.voidsetDisplay(boolean display)Specifies whether the footer is displayed or not.voidsetParent(IContentElement parent)Sets the parent content element.toString()Converts the value of the current Footer object to its equivalent string representation.
-
Constructor Details
-
Footer
public Footer()Initializes a new instance of the Footer class.
-
-
Method Details
-
add
Adds a Change object to the content.- Parameters:
change- the change
-
add
Adds a ChangeEnd object to the content.- Parameters:
changeEnd- the change end
-
add
Adds a ChangeStart object to the content.- Parameters:
changeStart- the change start
-
add
Adds a Heading object to the content.- Parameters:
heading- the heading
-
add
Adds an IndexOfIllustrations object to the content.- Parameters:
index- the index
-
add
Adds a List object to the content.- Parameters:
list- the list
-
add
Adds a Paragraph object to the content.- Parameters:
paragraph- the paragraph
-
add
Adds a Section object to the content.- Parameters:
section- the section
-
add
Adds a Table object to the content.- Parameters:
table- the table
-
add
Adds a TableOfContents object to the content.- Parameters:
toc- the toc
-
getContentElements
Returns all content elements.- Specified by:
getContentElementsin interfaceIContentElement- Returns:
- A collection of content elements.
-
getParent
Returns the parent content element.- Specified by:
getParentin interfaceIContentElement- Returns:
- the parent
-
setParent
Sets the parent content element.- Specified by:
setParentin interfaceIContentElement- Parameters:
parent- the new parent
-
clone
Creates a new object that is a deep copy of the current instance.- Specified by:
clonein interfaceIContentElement- Overrides:
clonein classObject- Returns:
- A new object that is a copy of this instance.
-
toString
Converts the value of the current Footer object to its equivalent string representation. -
isDisplay
public boolean isDisplay()Specifies whether the footer is displayed or not.- Returns:
- true, if is display
-
setDisplay
public void setDisplay(boolean display)Specifies whether the footer is displayed or not.- Parameters:
display- the new display
-
getContent
Contains a collection of HeaderFooterContent objects.- Returns:
- the content
-
getLeftRegion
Specifies a left-aligned portion of a footer.- Returns:
- the left region
-
getRightRegion
Specifies the right-aligned portion of a footer.- Returns:
- the right region
-
getCenterRegion
Specifies the center-aligned portion of a footer.- Returns:
- the center region
-