com.jrefinery.report
Class PageHeader

java.lang.Object
  extended bycom.jrefinery.report.Element
      extended bycom.jrefinery.report.Band
          extended bycom.jrefinery.report.PageHeader
All Implemented Interfaces:
java.lang.Cloneable, DataTarget, java.io.Serializable

public class PageHeader
extends Band

A report band used to print information at the top of every page in the report. 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).

Author:
David Gilbert
See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.jrefinery.report.Band
CONTENT_TYPE
 
Fields inherited from class com.jrefinery.report.Element
BOTTOM, CENTER, LEFT, MIDDLE, RIGHT, TOP
 
Constructor Summary
PageHeader()
          Constructs a page header.
 
Method Summary
 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.
 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.
 
Methods inherited from class com.jrefinery.report.Band
addElement, addElement, addElements, clone, getBandDefaults, getContentType, getElement, getElement, getElementArray, getElementCount, getElements, getHeight, getLayout, invalidateLayout, registerStyleSheetCollection, removeElement, setHeight, setLayout, toString, unregisterStyleSheetCollection
 
Methods inherited from class com.jrefinery.report.Element
getDataSource, getName, getPaint, getParent, getStyle, getStyleSheetCollection, getValue, isVisible, setDataSource, setName, setPaint, setParent, setStyleSheetCollection, setVisible
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PageHeader

public PageHeader()
Constructs a page header.

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.