01: /**
02: * ===========================================
03: * JFreeReport : a free Java reporting library
04: * ===========================================
05: *
06: * Project Info: http://reporting.pentaho.org/
07: *
08: * (C) Copyright 2001-2007, by Object Refinery Ltd, Pentaho Corporation and Contributors.
09: *
10: * This library is free software; you can redistribute it and/or modify it under the terms
11: * of the GNU Lesser General Public License as published by the Free Software Foundation;
12: * either version 2.1 of the License, or (at your option) any later version.
13: *
14: * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
15: * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
16: * See the GNU Lesser General Public License for more details.
17: *
18: * You should have received a copy of the GNU Lesser General Public License along with this
19: * library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
20: * Boston, MA 02111-1307, USA.
21: *
22: * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
23: * in the United States and other countries.]
24: *
25: * ------------
26: * RootLevelBand.java
27: * ------------
28: * (C) Copyright 2001-2007, by Object Refinery Ltd, Pentaho Corporation and Contributors.
29: */package org.jfree.report;
30:
31: /**
32: * A RootLevelBand is directly connected with a report definition or a group.
33: * RootLevelBands are used as entry points for the content creation.
34: *
35: * @author Thomas Morgner
36: */
37: public interface RootLevelBand {
38: /**
39: * Assigns the report definition. Don't play with that function, unless you
40: * know what you are doing. You might get burned.
41: *
42: * @param reportDefinition the report definition.
43: */
44: public void setReportDefinition(ReportDefinition reportDefinition);
45:
46: /**
47: * Returns the assigned report definition (or null).
48: *
49: * @return the report definition.
50: */
51: public ReportDefinition getReportDefinition();
52:
53: /**
54: * Returns the number of subreports attached to this root level band.
55: *
56: * @return the number of subreports.
57: */
58: public int getSubReportCount();
59:
60: /**
61: * Returns the subreport at the given index-position.
62: *
63: * @param index the index
64: * @return the subreport stored at the given index.
65: *
66: * @throws IndexOutOfBoundsException if there is no such subreport.
67: */
68: public SubReport getSubReport(int index);
69:
70: /**
71: * Returns all sub-reports as array.
72: *
73: * @return the sub-reports as array.
74: */
75: public SubReport[] getSubReports();
76: }
|