org.jfree.report: public class: PageFooter

org.jfree.report
public class: PageFooter [javadoc | source]

java.lang.Object
   org.jfree.report.Element
      org.jfree.report.Section
         org.jfree.report.Band
            org.jfree.report.PageFooter

All Implemented Interfaces:
RootLevelBand, ReportElement, DataTarget

A report band that appears at the bottom of every page. The page-footer is the last band that is printed on a page. There is an option to suppress the page footer on the first page, and another option does the same for the last page. If the footer is marked sticky, the footer will even be printed for all sub-report pages.

A page header or footer cannot have subreports.

author: David - Gilbert

Fields inherited from org.jfree.report.Band:
CONTENT_TYPE, ANONYMOUS_BAND_PREFIX

Fields inherited from org.jfree.report.Element:
ANONYMOUS_ELEMENT_PREFIX

Constructor:

Constructor:
public PageFooter() { setElementType(new PageFooterType()); } Constructs a page footer containing no elements.
public PageFooter(boolean onFirstPage, boolean onLastPage) { super(); setDisplayOnFirstPage(onFirstPage); setDisplayOnLastPage(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.

 public PageFooter() {
            
    setElementType(new PageFooterType());
}

Constructs a page footer containing no elements.

 public PageFooter(boolean onFirstPage,
    boolean onLastPage) {
    super();
    setDisplayOnFirstPage(onFirstPage);
    setDisplayOnLastPage(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 from org.jfree.report.PageFooter Summary:
getSubReport, getSubReportCount, getSubReports, isDisplayOnFirstPage, isDisplayOnLastPage, isSticky, setDisplayOnFirstPage, setDisplayOnLastPage, setSticky

Methods from org.jfree.report.Band:
addElement, addElement, addElements, clear, clone, createGlobalDefaultStyle, getElement, getElement, getElementArray, getElementCount, isPagebreakAfterPrint, isPagebreakBeforePrint, removeElement, setPagebreakAfterPrint, setPagebreakBeforePrint, toString, unsafeGetElementArray

Methods from org.jfree.report.Section:
createGlobalDefaultStyle, getElement, getElementCount, registerAsChild, removeElement, unregisterAsChild, unregisterParent, validateLooping

Methods from org.jfree.report.Element:
clone, createGlobalDefaultStyle, getAttribute, getAttributeExpression, getAttributeExpressionNames, getAttributeExpressionNamespaces, getAttributeNames, getAttributeNamespaces, getAttributes, getContentBase, getDataSource, getDefinitionSource, getElementType, getElementTypeName, getHRefTarget, getId, getMetaData, getName, getObjectID, getParent, getParentSection, getReportDefinition, getStyle, getStyleExpression, getStyleExpressions, getTreeLock, getValue, isDynamicContent, isVisible, setAttribute, setAttributeExpression, setDataSource, setDynamicContent, setElementType, setHRefTarget, setId, setName, setParent, setStyleExpression, setVisible

Methods from org.jfree.report.Element:

clone, createGlobalDefaultStyle, getAttribute, getAttributeExpression, getAttributeExpressionNames, getAttributeExpressionNamespaces, getAttributeNames, getAttributeNamespaces, getAttributes, getContentBase, getDataSource, getDefinitionSource, getElementType, getElementTypeName, getHRefTarget, getId, getMetaData, getName, getObjectID, getParent, getParentSection, getReportDefinition, getStyle, getStyleExpression, getStyleExpressions, getTreeLock, getValue, isDynamicContent, isVisible, setAttribute, setAttributeExpression, setDataSource, setDynamicContent, setElementType, setHRefTarget, setId, setName, setParent, setStyleExpression, setVisible

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.jfree.report.PageFooter Detail:
public final SubReport getSubReport(int index) { throw new IndexOutOfBoundsException("PageFooter cannot have subreports."); } Throws an IndexOutOfBoundsException as page-footer cannot have sub-reports.
public final int getSubReportCount() { return 0; } Returns the number of subreports on this band. This returns zero, as page-bands cannot have subreports.
public SubReport[] getSubReports() { return PageFooter.EMPTY_REPORTS; } Returns an empty array, as page-footer cannot have subreports.
public boolean isDisplayOnFirstPage() { return getStyle().getBooleanStyleProperty(BandStyleKeys.DISPLAY_ON_FIRSTPAGE, false); } Returns true if the footer should be shown on page 1, and false otherwise.
public boolean isDisplayOnLastPage() { return getStyle().getBooleanStyleProperty(BandStyleKeys.DISPLAY_ON_LASTPAGE, false); } Returns true if the footer should be shown on the last page, and false otherwise.
public boolean isSticky() { return getStyle().getBooleanStyleProperty(BandStyleKeys.STICKY, false); } Returns true if the footer should be shown on all subreports.
public void setDisplayOnFirstPage(boolean b) { getStyle().setBooleanStyleProperty(BandStyleKeys.DISPLAY_ON_FIRSTPAGE, b); } Defines whether the footer should be shown on the first page.
public void setDisplayOnLastPage(boolean b) { getStyle().setBooleanStyleProperty(BandStyleKeys.DISPLAY_ON_LASTPAGE, b); } Defines whether the footer should be shown on the last page.
public void setSticky(boolean b) { getStyle().setBooleanStyleProperty(BandStyleKeys.STICKY, b); } Defines whether the footer should be shown on all subreports.

Method from org.jfree.report.PageFooter Detail:

 public final SubReport getSubReport(int index) {
    throw new IndexOutOfBoundsException("PageFooter cannot have subreports.");
}

Throws an IndexOutOfBoundsException as page-footer cannot have sub-reports.

 public final int getSubReportCount() {
    return 0;
}

Returns the number of subreports on this band. This returns zero, as page-bands cannot have subreports.

 public SubReport[] getSubReports() {
    return PageFooter.EMPTY_REPORTS;
}

Returns an empty array, as page-footer cannot have subreports.

 public boolean isDisplayOnFirstPage() {
    return getStyle().getBooleanStyleProperty(BandStyleKeys.DISPLAY_ON_FIRSTPAGE, false);
}

Returns true if the footer should be shown on page 1, and false otherwise.

 public boolean isDisplayOnLastPage() {
    return getStyle().getBooleanStyleProperty(BandStyleKeys.DISPLAY_ON_LASTPAGE, false);
}

Returns true if the footer should be shown on the last page, and false otherwise.

 public boolean isSticky() {
    return getStyle().getBooleanStyleProperty(BandStyleKeys.STICKY, false);
}

Returns true if the footer should be shown on all subreports.

 public  void setDisplayOnFirstPage(boolean b) {
    getStyle().setBooleanStyleProperty(BandStyleKeys.DISPLAY_ON_FIRSTPAGE, b);
}

Defines whether the footer should be shown on the first page.

 public  void setDisplayOnLastPage(boolean b) {
    getStyle().setBooleanStyleProperty(BandStyleKeys.DISPLAY_ON_LASTPAGE, b);
}

Defines whether the footer should be shown on the last page.

 public  void setSticky(boolean b) {
    getStyle().setBooleanStyleProperty(BandStyleKeys.STICKY, b);
}

Defines whether the footer should be shown on all subreports.