KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > sf > jasperreports > engine > JRGroup


1 /*
2  * ============================================================================
3  * GNU Lesser General Public License
4  * ============================================================================
5  *
6  * JasperReports - Free Java report-generating library.
7  * Copyright (C) 2001-2006 JasperSoft Corporation http://www.jaspersoft.com
8  *
9  * This library is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Lesser General Public
11  * License as published by the Free Software Foundation; either
12  * 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,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17  * Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public
20  * License along with this library; if not, write to the Free Software
21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
22  *
23  * JasperSoft Corporation
24  * 303 Second Street, Suite 450 North
25  * San Francisco, CA 94107
26  * http://www.jaspersoft.com
27  */
28 package net.sf.jasperreports.engine;
29
30
31 /**
32  * Groups represent a flexible way to organize data on a report. A report group is represented by sequence
33  * of consecutive records in the data source that have something in common, like the value of a certain report
34  * field for example.
35  * <p>
36  * The value of the associated group expression is what makes group records stick together. This value is the
37  * thing that they have in common.
38  * @author Teodor Danciu (teodord@users.sourceforge.net)
39  * @version $Id: JRGroup.java 1229 2006-04-19 13:27:35 +0300 (Wed, 19 Apr 2006) teodord $
40  */
41 public interface JRGroup
42 {
43
44
45     /**
46      * Gets the group name
47      */
48     public String JavaDoc getName();
49     
50     /**
51      * Gets the flag that signals if the group header should be printed always on a new column.
52      */
53     public boolean isStartNewColumn();
54         
55     /**
56      * Sets the flag that signals if the group header should be printed always on a new column.
57      */
58     public void setStartNewColumn(boolean isStart);
59         
60     /**
61      * Gets the flag that signals if the group header should be printed always on a new page.
62      */
63     public boolean isStartNewPage();
64         
65     /**
66      * Sets the flag that signals if the group header should be printed always on a new page.
67      */
68     public void setStartNewPage(boolean isStart);
69         
70     /**
71      * Gets the flag that signals if the group header should be printed always on a new page, along with the
72      * re-initialization of the page number.
73      */
74     public boolean isResetPageNumber();
75         
76     /**
77      * Sets the flag that signals if the group header should be printed always on a new page, along with the
78      * re-initialization of the page number.
79      */
80     public void setResetPageNumber(boolean isReset);
81         
82     /**
83      * Gets the flag that signals if the group header should be reprinted at the beginning of each page.
84      */
85     public boolean isReprintHeaderOnEachPage();
86         
87     /**
88      * Sets the flag that signals if the group header should be reprinted at the beginning of each page.
89      */
90     public void setReprintHeaderOnEachPage(boolean isReprint);
91         
92     /**
93      * Gets the minimum amount of vertical space needed at the bottom of the column in order to place the
94      * group header on the current column.
95      */
96     public int getMinHeightToStartNewPage();
97
98     /**
99      * Gets the minimum amount of vertical space needed at the bottom of the column in order to place the
100      * group header on the current column.
101      */
102     public void setMinHeightToStartNewPage(int minHeight);
103         
104     /**
105      * Gets the expression that defines what records in the group have in common.
106      */
107     public JRExpression getExpression();
108     
109     /**
110      * Gets the header band created for this group.
111      */
112     public JRBand getGroupHeader();
113         
114     /**
115      * Gets the footer band created for this group.
116      */
117     public JRBand getGroupFooter();
118
119     /**
120      *
121      */
122     public JRVariable getCountVariable();
123
124
125 }
126
Popular Tags