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: * LayoutEvent.java
27: * ------------
28: * (C) Copyright 2001-2007, by Object Refinery Ltd, Pentaho Corporation and Contributors.
29: */package org.jfree.report.event;
30:
31: import org.jfree.report.Band;
32: import org.jfree.report.states.ReportState;
33:
34: /**
35: * The LayoutEvent describes the current report state and the current band, which had been
36: * laid out for printing.
37: *
38: * @author Thomas Morgner
39: * @deprecated The engine does no longer generate layout events.
40: */
41: public class LayoutEvent extends ReportEvent {
42: /**
43: * The type constant to mark a LayoutEvent.
44: */
45: public static final int LAYOUT_COMPLETE_EVENT = 0x20000;
46: /**
47: * The type constant to mark a Output-Complete event.
48: * @deprecated This event type is no longer used.
49: */
50: public static final int OUTPUT_COMPLETE_EVENT = 0x40000;
51:
52: /**
53: * the current band.
54: */
55: private Band layoutedBand;
56:
57: /**
58: * Creates a new LayoutEvent.
59: *
60: * @param state the current report state.
61: * @param band the layouted band.
62: * @param type the event type.
63: */
64: public LayoutEvent(final ReportState state, final Band band,
65: final int type) {
66: super (state, type);
67:
68: if (band == null) {
69: throw new NullPointerException();
70: }
71: this .layoutedBand = band;
72: }
73:
74: /**
75: * Gets the layouted band. This band will be printed next.
76: *
77: * @return the layouted band.
78: */
79: public Band getLayoutedBand() {
80: return layoutedBand;
81: }
82: }
|