org.jfree.report
Class Watermark

java.lang.Object
  |
  +--org.jfree.report.Element
        |
        +--org.jfree.report.Band
              |
              +--org.jfree.report.Watermark

public class Watermark

extends Band

implements RootLevelBand

A report band used to print information at the background of every page in the report. There is an option to suppress the printing 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

Fields inherited from class org.jfree.report.Band

ANONYMOUS_BAND_PREFIX, CONTENT_TYPE

Fields inherited from class org.jfree.report.Element

ANONYMOUS_ELEMENT_PREFIX

Constructor Summary

Watermark()
Constructs a page header.

Watermark(boolean onFirstPage, boolean onLastPage)
Constructs a page footer containing no elements.

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.
void	setReportDefinition(ReportDefinition reportDefinition) Assigns the report definition.

Methods inherited from class org.jfree.report.Band

addElement, addElement, addElements, clone, createGlobalDefaultStyle, getContentType, getElement, getElement, getElementArray, getElementCount, getElements, getLayout, isPagebreakAfterPrint, isPagebreakBeforePrint, removeElement, setLayout, setPagebreakAfterPrint, setPagebreakBeforePrint, toString

Methods inherited from class org.jfree.report.Element

connectDataSource, disconnectDataSource, getDataSource, getHRefTarget, getMaximumSize, getMinimumSize, getName, getObjectID, getParent, getPreferredSize, getReportDefinition, getStyle, getTreeLock, getValue, isDynamicContent, isLayoutCacheable, isVisible, setDataSource, setDynamicContent, setHRefTarget, setLayoutCacheable, setMaximumSize, setMinimumSize, setName, setParent, setPreferredSize, setVisible

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Watermark

public Watermark()

Constructs a page header.

Watermark

public Watermark(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.

setReportDefinition

public void setReportDefinition(ReportDefinition reportDefinition)

Assigns the report definition. Don't play with that function, unless you know what you are doing. You might get burned.

Specified by:

setReportDefinition in interface RootLevelBand

Overrides:

setReportDefinition in class Band

Parameters:

reportDefinition - the report definition.