|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.pentaho.reporting.engine.classic.core.Element
org.pentaho.reporting.engine.classic.core.Section
org.pentaho.reporting.engine.classic.core.Band
org.pentaho.reporting.engine.classic.core.PageHeader
public class PageHeader
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.
Field Summary |
---|
Fields inherited from class org.pentaho.reporting.engine.classic.core.Band |
---|
ANONYMOUS_BAND_PREFIX, CONTENT_TYPE |
Fields inherited from class org.pentaho.reporting.engine.classic.core.Element |
---|
ANONYMOUS_ELEMENT_PREFIX |
Constructor Summary | |
---|---|
PageHeader()
Constructs a page header. |
|
PageHeader(boolean onFirstPage,
boolean onLastPage)
Constructs a page footer containing no elements. |
Method Summary | |
---|---|
SubReport |
getSubReport(int index)
Throws an IndexOutOfBoundsException as page-footer cannot have sub-reports. |
int |
getSubReportCount()
Returns the number of subreports on this band. |
SubReport[] |
getSubReports()
Returns an empty array, as page-footer cannot have subreports. |
boolean |
isDisplayOnFirstPage()
Returns true if the header should be shown on page 1, and false otherwise. |
boolean |
isDisplayOnLastPage()
Returns true if the header should be shown on the last page, and false otherwise. |
boolean |
isSticky()
Returns true if the footer should be shown on all subreports. |
void |
setDisplayOnFirstPage(boolean b)
Defines whether the header should be shown on the first page. |
void |
setDisplayOnLastPage(boolean b)
Defines whether the header should be shown on the last page. |
void |
setSticky(boolean b)
Defines whether the footer should be shown on all subreports. |
Methods inherited from class org.pentaho.reporting.engine.classic.core.Band |
---|
addElement, addElement, addElements, clear, clone, derive, getElement, getElement, getElementArray, getElementCount, isPagebreakAfterPrint, isPagebreakBeforePrint, removeElement, setElementAt, setPagebreakAfterPrint, setPagebreakBeforePrint, toString, unsafeGetElementArray |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.pentaho.reporting.engine.classic.core.ReportElement |
---|
getAttribute, getAttributeExpression, getAttributeExpressionNames, getAttributeExpressionNamespaces, getAttributeNames, getAttributeNamespaces, getAttributes, getId, getMetaData, getName, getObjectID, getParentSection, getReportDefinition, getStyle, getStyleExpression, getStyleExpressions, getTreeLock, setAttribute, setAttributeExpression, setStyleExpression |
Constructor Detail |
---|
public PageHeader()
public PageHeader(boolean onFirstPage, boolean onLastPage)
onFirstPage
- defines, whether the page header will be printed on the first pageonLastPage
- defines, whether the page footer will be printed on the last page.Method Detail |
---|
public boolean isDisplayOnFirstPage()
public void setDisplayOnFirstPage(boolean b)
b
- a flag indicating whether or not the header is shown on the first page.public boolean isDisplayOnLastPage()
public void setDisplayOnLastPage(boolean b)
b
- a flag indicating whether or not the header is shown on the last page.public final int getSubReportCount()
getSubReportCount
in interface RootLevelBand
public final SubReport getSubReport(int index)
getSubReport
in interface RootLevelBand
index
- the index.
public boolean isSticky()
public void setSticky(boolean b)
b
- a flag indicating whether or not the footer is shown on the first page.public SubReport[] getSubReports()
getSubReports
in interface RootLevelBand
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |