Package org.pentaho.reporting.engine.classic.core

Class PageHeader

  • All Implemented Interfaces:
    Serializable, Cloneable, Iterable<Element>, DataTarget, ReportElement, RootLevelBand
    public class PageHeader
extends Band
implements RootLevelBand
    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
    See Also:
    Serialized Form

    • Constructor Detail

      • PageHeader

        public PageHeader()
        Constructs a page header.

      • PageHeader

        public PageHeader​(boolean onFirstPage,
                  boolean onLastPage)
        Constructs a page footer containing no elements.
        Parameters:
        onFirstPage - defines, whether the page header will be printed on the first page
        onLastPage - defines, whether the page footer will be printed on the last page.

    • Method Detail

      • isDisplayOnFirstPage

        public boolean isDisplayOnFirstPage()
        Returns true if the header should be shown on page 1, and false otherwise.
        Returns:
        true or false.

      • setDisplayOnFirstPage

        public void setDisplayOnFirstPage​(boolean b)
        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.

      • isDisplayOnLastPage

        public boolean isDisplayOnLastPage()
        Returns true if the header should be shown on the last page, and false otherwise.
        Returns:
        true or false.

      • setDisplayOnLastPage

        public void setDisplayOnLastPage​(boolean b)
        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.

      • getSubReportCount

        public final int getSubReportCount()
        Returns the number of subreports on this band. This returns zero, as page-bands cannot have subreports.
        Specified by:
        getSubReportCount in interface RootLevelBand
        Returns:
        the subreport count.

      • getSubReport

        public final SubReport getSubReport​(int index)
        Throws an IndexOutOfBoundsException as page-footer cannot have sub-reports.
        Specified by:
        getSubReport in interface RootLevelBand
        Parameters:
        index - the index.
        Returns:
        nothing, as an exception is thrown instead.

      • isSticky

        public boolean isSticky()
        Returns true if the footer should be shown on all subreports.
        Returns:
        true or false.

      • setSticky

        public void setSticky​(boolean b)
        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.

      • getSubReports

        public SubReport[] getSubReports()
        Returns an empty array, as page-footer cannot have subreports.
        Specified by:
        getSubReports in interface RootLevelBand
        Returns:
        the sub-reports as array.