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: * GroupHeader.java
27: * ------------
28: * (C) Copyright 2001-2007, by Object Refinery Ltd, Pentaho Corporation and Contributors.
29: */package org.jfree.report;
30:
31: import org.jfree.report.style.BandStyleKeys;
32:
33: /**
34: * A report band that appears at the beginning of each instance of a group. A group-header can be marked as repeating
35: * header causing the header to be printed at the top of each page as long as the group is active. If the header is
36: * marked sticky, the header will even be printed for all sub-report pages.
37: * <p/>
38: * Subreports defined for a repeating group header will be ignored for all repeating instances.
39: *
40: * @author David Gilbert
41: */
42: public class GroupHeader extends AbstractRootLevelBand {
43: /**
44: * Constructs a group header band, containing no elements.
45: */
46: public GroupHeader() {
47: }
48:
49: /**
50: * Checks, whether this group header should be repeated on new pages.
51: *
52: * @return true, if the header will be repeated, false otherwise
53: */
54: public boolean isRepeat() {
55: return getStyle().getBooleanStyleProperty(
56: BandStyleKeys.REPEAT_HEADER);
57: }
58:
59: /**
60: * Defines, whether this group header should be repeated on new pages.
61: *
62: * @param repeat true, if the header will be repeated, false otherwise
63: */
64: public void setRepeat(final boolean repeat) {
65: getStyle().setBooleanStyleProperty(BandStyleKeys.REPEAT_HEADER,
66: repeat);
67: }
68:
69: /**
70: * Returns true if the footer should be shown on all subreports.
71: *
72: * @return true or false.
73: */
74: public boolean isSticky() {
75: return getStyle().getBooleanStyleProperty(BandStyleKeys.STICKY,
76: false);
77: }
78:
79: /**
80: * Defines whether the footer should be shown on all subreports.
81: *
82: * @param b a flag indicating whether or not the footer is shown on the first page.
83: */
84: public void setSticky(final boolean b) {
85: getStyle().setBooleanStyleProperty(BandStyleKeys.STICKY, b);
86: }
87:
88: }
|