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: * TriggerPageFooterFunction.java
27: * ------------
28: * (C) Copyright 2001-2007, by Object Refinery Ltd, Pentaho Corporation and Contributors.
29: */package org.jfree.report.function;
30:
31: import org.jfree.report.event.ReportEvent;
32:
33: /**
34: * This function enables a "PageFooter only on last page" functionality.
35: *
36: * @author Thomas Morgner
37: */
38: public class TriggerPageFooterFunction extends AbstractFunction {
39: /**
40: * Creates a new TriggerPageFooterFunction with no name. You have to define one using
41: * "setName" or the function will not work.
42: */
43: public TriggerPageFooterFunction() {
44: }
45:
46: /**
47: * Receives notification that report generation initializes the current run. <P> The
48: * event carries a ReportState.Started state. Use this to initialize the report.
49: *
50: * @param event The event.
51: */
52: public void reportInitialized(final ReportEvent event) {
53: event.getReport().getPageFooter().setVisible(false);
54: }
55:
56: /**
57: * Receives notification that report generation has completed, the report footer was
58: * printed, no more output is done. This is a helper event to shut down the output
59: * service.
60: *
61: * @param event The event.
62: */
63: public void reportDone(final ReportEvent event) {
64: event.getReport().getPageFooter().setVisible(true);
65: }
66:
67: /**
68: * This method returns nothing.
69: *
70: * @return the value of the function.
71: */
72: public Object getValue() {
73: return null;
74: }
75: }
|