org.pentaho.reporting.engine.classic.core
Interface RootLevelBand

All Superinterfaces:
Cloneable, ReportElement, Serializable
All Known Implementing Classes:
AbstractRootLevelBand, CrosstabSummaryFooter, CrosstabSummaryHeader, CrosstabTitleFooter, CrosstabTitleHeader, DetailsFooter, DetailsHeader, GroupFooter, GroupHeader, ItemBand, NoDataBand, PageFooter, PageHeader, ReportFooter, ReportHeader, Watermark

public interface RootLevelBand
extends ReportElement

A RootLevelBand is directly connected with a report definition or a group. RootLevelBands are used as entry points for the content creation.

Author:
Thomas Morgner

Method Summary
 SubReport getSubReport(int index)
          Returns the subreport at the given index-position.
 int getSubReportCount()
          Returns the number of subreports attached to this root level band.
 SubReport[] getSubReports()
          Returns all sub-reports as array.
 
Methods inherited from interface org.pentaho.reporting.engine.classic.core.ReportElement
getAttribute, getAttributeExpression, getAttributeExpressionNames, getAttributeExpressionNamespaces, getAttributeNames, getAttributeNamespaces, getAttributes, getId, getMetaData, getName, getObjectID, getParentSection, getReportDefinition, getStyle, getStyleExpression, getStyleExpressions, getTreeLock, setAttribute, setAttributeExpression, setStyleExpression
 

Method Detail

getSubReportCount

int getSubReportCount()
Returns the number of subreports attached to this root level band.

Returns:
the number of subreports.

getSubReport

SubReport getSubReport(int index)
Returns the subreport at the given index-position.

Parameters:
index - the index
Returns:
the subreport stored at the given index.
Throws:
IndexOutOfBoundsException - if there is no such subreport.

getSubReports

SubReport[] getSubReports()
Returns all sub-reports as array.

Returns:
the sub-reports as array.