Class MasterPage
java.lang.Object
com.independentsoft.office.odf.styles.MasterPage
Represents the content of headers and footers.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()Creates a new object that is a deep copy of the current instance.Contains a collection of BaseStyle objects.Gets the name that defines a style.Gets the content for the footer for the first page.Gets the content for the header for the first page.Gets the content of the footer.Gets the content of the header.Gets the content for the footer for the left page, if different from the right page.Gets the content for the header for the left page, if different from the right page.getName()Gets the name.Gets the name of the master page that is used for the next page if the current page is entirely filled.Gets the page layout style that contains sizes, border and orientation attributes.Gets the page style.Contains a collection of Shape objects.voidrenameStyle(Style style, String newName)Rename style.voidsetDisplayName(String displayName)Sets the name that defines a style.voidsetFirstPageFooter(Footer firstPageFooter)Sets the content for the footer for the first page.voidsetFirstPageHeader(Header firstPageHeader)Sets the content for the header for the first page.voidSets the content of the footer.voidSets the content of the header.voidsetLeftPageFooter(Footer leftPageFooter)Sets the content for the footer for the left page, if different from the right page.voidsetLeftPageHeader(Header leftPageHeader)Sets the content for the header for the left page, if different from the right page.voidSets the name.voidsetNextStyle(String nextStyle)Sets the name of the master page that is used for the next page if the current page is entirely filled.voidsetPageLayout(String pageLayout)Sets the page layout style that contains sizes, border and orientation attributes.voidsetPageStyle(String pageStyle)Sets the page style.toString()Converts the value of the current MasterPage object to its equivalent string representation.
-
Constructor Details
-
MasterPage
public MasterPage()Initializes a new instance of the MasterPage class.
-
-
Method Details
-
renameStyle
Rename style.- Parameters:
style- the stylenewName- the new name
-
clone
Creates a new object that is a deep copy of the current instance. -
toString
Converts the value of the current MasterPage object to its equivalent string representation. -
getName
Gets the name.- Returns:
- the name
-
setName
Sets the name.- Parameters:
name- the new name
-
getDisplayName
Gets the name that defines a style.- Returns:
- the display name
-
setDisplayName
Sets the name that defines a style.- Parameters:
displayName- the new display name
-
getPageLayout
Gets the page layout style that contains sizes, border and orientation attributes.- Returns:
- the page layout
-
setPageLayout
Sets the page layout style that contains sizes, border and orientation attributes.- Parameters:
pageLayout- the new page layout
-
getPageStyle
Gets the page style.- Returns:
- the page style
-
setPageStyle
Sets the page style.- Parameters:
pageStyle- the new page style
-
getNextStyle
Gets the name of the master page that is used for the next page if the current page is entirely filled.- Returns:
- the next style
-
setNextStyle
Sets the name of the master page that is used for the next page if the current page is entirely filled.- Parameters:
nextStyle- the new next style
-
getHeader
Gets the content of the header.- Returns:
- the header
-
setHeader
Sets the content of the header.- Parameters:
header- the new header
-
getLeftPageHeader
Gets the content for the header for the left page, if different from the right page.- Returns:
- the left page header
-
setLeftPageHeader
Sets the content for the header for the left page, if different from the right page.- Parameters:
leftPageHeader- the new left page header
-
getFirstPageHeader
Gets the content for the header for the first page.- Returns:
- the first page header
-
setFirstPageHeader
Sets the content for the header for the first page.- Parameters:
firstPageHeader- the new left page header
-
getBaseStyles
Contains a collection of BaseStyle objects.- Returns:
- the base styles
-
getShapes
Contains a collection of Shape objects.- Returns:
- the shapes
-