com.jrefinery.report
Class ReportHeader

java.lang.Object
  |
  +--com.jrefinery.report.Element
        |
        +--com.jrefinery.report.Band
              |
              +--com.jrefinery.report.ReportHeader
All Implemented Interfaces:
java.lang.Cloneable, DataTarget, java.io.Serializable

public class ReportHeader
extends Band

A report band that is printed once only at the beginning of the report.

A flag can be set forcing the report generator to start a new page after printing the report header.

Note that if there is a page header on the first page of your report, it will be printed above the report header, the logic being that the page header *always* appears at the top of the page. In many cases, it makes better sense to suppress the page header on the first page of the report (leaving just the report header on page 1).

Author:
David Gilbert, Thomas Morgner
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
ReportHeader()
          Constructs a report header, initially containing no elements.
 
Method Summary
 boolean isOwnPage()
          Returns true if the report header appears on its own page, and false otherwise.
 void setOwnPage(boolean b)
          Defines whether the report header appears on its own 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

ReportHeader

public ReportHeader()
Constructs a report header, initially containing no elements.

Method Detail

setOwnPage

public void setOwnPage(boolean b)
Defines whether the report header appears on its own page. The pagebreak is forced after the report header was printed.

Parameters:
b - the new flag indicating whether to force a pagebreak.

isOwnPage

public boolean isOwnPage()
Returns true if the report header appears on its own page, and false otherwise.

Returns:
a flag indicating whether or not the header appears on its own page.