|
| |
|
| java.lang.Object
 org.jfree.report.Element
org.jfree.report.Band
org.jfree.report.PageHeader
| PageHeader | | public class PageHeader extends Band implements RootLevelBand(Code) | | A report band used to print information at the top of every page in the report. The page header is the first band
that is printed on each page. There is an option to suppress the page header on the first page and the last page of
the report (this is often useful if you are using a report header and/or report footer). If the header is marked
sticky, the header will even be printed for all sub-report pages.
A page header or footer cannot have subreports.
author:
David Gilbert |
| Constructor Summary | |
| public | PageHeader()
Constructs a page header. | | public | PageHeader(boolean onFirstPage, boolean onLastPage)
Constructs a page footer containing no elements. |
| Method Summary | |
| final public SubReport | getSubReport(int index)
Throws an IndexOutOfBoundsException as page-footer cannot have sub-reports.
Parameters:
index - the index. | | final public int | getSubReportCount()
Returns the number of subreports on this band. | | public SubReport[] | getSubReports()
Returns an empty array, as page-footer cannot have subreports. | | public boolean | isDisplayOnFirstPage()
Returns true if the header should be shown on page 1, and false otherwise. | | public boolean | isDisplayOnLastPage()
Returns true if the header should be shown on the last page, and false otherwise. | | public boolean | isSticky()
Returns true if the footer should be shown on all subreports. | | public void | setDisplayOnFirstPage(boolean b)
Defines whether the header should be shown on the first page. | | public void | setDisplayOnLastPage(boolean b)
Defines whether the header should be shown on the last page. | | public void | setReportDefinition(ReportDefinition reportDefinition)
Assigns the report definition. | | public void | setSticky(boolean b)
Defines whether the footer should be shown on all subreports. |
| PageHeader | | public PageHeader()(Code) | | Constructs a page header.
|
| PageHeader | | public PageHeader(boolean onFirstPage, boolean onLastPage)(Code) | | Constructs a page footer containing no elements.
Parameters:
onFirstPage - defines, whether the page header will be printed on the first page
Parameters:
onLastPage - defines, whether the page footer will be printed on the last page. |
| getSubReport | | final public SubReport getSubReport(int index)(Code) | | Throws an IndexOutOfBoundsException as page-footer cannot have sub-reports.
Parameters:
index - the index. nothing, as an exception is thrown instead. |
| getSubReportCount | | final public int getSubReportCount()(Code) | | Returns the number of subreports on this band. This returns zero, as page-bands cannot have subreports.
the subreport count. |
| getSubReports | | public SubReport[] getSubReports()(Code) | | Returns an empty array, as page-footer cannot have subreports.
the sub-reports as array. |
| isDisplayOnFirstPage | | public boolean isDisplayOnFirstPage()(Code) | | Returns true if the header should be shown on page 1, and false otherwise.
true or false. |
| isDisplayOnLastPage | | public boolean isDisplayOnLastPage()(Code) | | Returns true if the header should be shown on the last page, and false otherwise.
true or false. |
| isSticky | | public boolean isSticky()(Code) | | Returns true if the footer should be shown on all subreports.
true or false. |
| setDisplayOnFirstPage | | public void setDisplayOnFirstPage(boolean b)(Code) | | Defines whether the header should be shown on the first page.
Parameters:
b - a flag indicating whether or not the header is shown on the first page. |
| setDisplayOnLastPage | | public void setDisplayOnLastPage(boolean b)(Code) | | Defines whether the header should be shown on the last page.
Parameters:
b - a flag indicating whether or not the header is shown on the last page. |
| setReportDefinition | | public void setReportDefinition(ReportDefinition reportDefinition)(Code) | | Assigns the report definition. Don't play with that function, unless you know what you are doing. You might get
burned.
Parameters:
reportDefinition - the report definition. |
| setSticky | | public void setSticky(boolean b)(Code) | | Defines whether the footer should be shown on all subreports.
Parameters:
b - a flag indicating whether or not the footer is shown on the first page. |
| Fields inherited from org.jfree.report.Element | final public static String ANONYMOUS_ELEMENT_PREFIX(Code)(Java Doc)
|
|
|
|