org.jfree.report
Interface ReportDefinition

All Superinterfaces:

java.lang.Cloneable

All Known Implementing Classes:

ReportDefinitionImpl

public interface ReportDefinition

extends java.lang.Cloneable

A report definition. This the working copy of the JFreeReport object. This object is not serializable, as it is used internally.

Author:

Thomas Morgner.

Method Summary

Group	getGroup(int count) Returns the group at the specified index or null, if there is no such group.
int	getGroupCount() Returns the number of groups in this report.
GroupList	getGroups() Returns the list of groups for the report.
ItemBand	getItemBand() Returns the item band.
PageFooter	getPageFooter() Returns the page footer.
PageHeader	getPageHeader() Returns the page header.
ReportProperties	getProperties() Returns the report properties.
ReportConfiguration	getReportConfiguration() Returns the report configuration.
ReportFooter	getReportFooter() Returns the report footer.
ReportHeader	getReportHeader() Returns the report header.
StyleSheetCollection	getStyleSheetCollection() Returns the stylesheet collection of this report definition.
Watermark	getWatermark() Returns the watermark band.

Method Detail

getGroups

public GroupList getGroups()

Returns the list of groups for the report.

Returns:

The list of groups.

getReportHeader

public ReportHeader getReportHeader()

Returns the report header.

Returns:

The report header.

getReportFooter

public ReportFooter getReportFooter()

Returns the report footer.

Returns:

The report footer.

getPageHeader

public PageHeader getPageHeader()

Returns the page header.

Returns:

The page header.

getPageFooter

public PageFooter getPageFooter()

Returns the page footer.

Returns:

The page footer.

getItemBand

public ItemBand getItemBand()

Returns the item band.

Returns:

The item band.

getWatermark

public Watermark getWatermark()

Returns the watermark band.

Returns:

The watermark band.

getProperties

public ReportProperties getProperties()

Returns the report properties.

Returns:

The report properties.

getReportConfiguration

public ReportConfiguration getReportConfiguration()

Returns the report configuration.

Returns:

The report configuration.

getGroupCount

public int getGroupCount()

Returns the number of groups in this report.

Every report has at least one group defined.

Returns:

the group count.

getGroup

public Group getGroup(int count)

Returns the group at the specified index or null, if there is no such group.

Parameters:

count - the group index.

Returns:

the requested group.

Throws:

java.lang.IllegalArgumentException - if the count is negative.

java.lang.IndexOutOfBoundsException - if the count is greater than the number of defined groups.

getStyleSheetCollection

public StyleSheetCollection getStyleSheetCollection()

Returns the stylesheet collection of this report definition. The stylesheet collection is fixed for the report definition and all elements of the report. When a band or group is added to the report it will get registered with this stylesheet collection and cannot be used in an different report.

Returns:

the stylesheet collection of the report, never null.