org.jfree.report
Class Watermark

java.lang.Object
  extended byorg.jfree.report.Element
      extended byorg.jfree.report.Band
          extended byorg.jfree.report.Watermark
All Implemented Interfaces:
java.lang.Cloneable, DataTarget, java.io.Serializable

public class Watermark
extends Band

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

Field Summary
 
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.
 
Methods inherited from class org.jfree.report.Band
addElement, addElement, addElements, clone, getBandDefaults, getContentType, getElement, getElement, getElementArray, getElementCount, getElements, getLayout, handleRegisterStyleSheetCollection, handleUnregisterStyleSheetCollection, invalidateLayout, isPagebreakAfterPrint, isPagebreakBeforePrint, removeElement, setLayout, setPagebreakAfterPrint, setPagebreakBeforePrint, toString, updateStyleSheetCollection
 
Methods inherited from class org.jfree.report.Element
getDataSource, getMaximumSize, getMinimumSize, getName, getParent, getPreferredSize, getStyle, getStyleSheetCollection, getTreeLock, getValue, isDynamicContent, isLayoutCacheable, isVisible, registerStyleSheetCollection, setDataSource, setDynamicContent, setLayoutCacheable, setMaximumSize, setMinimumSize, setName, setParent, setPreferredSize, setVisible, unregisterStyleSheetCollection
 
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.