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: * BandLayoutManager.java
27: * ------------
28: * (C) Copyright 2001-2007, by Object Refinery Ltd, Pentaho Corporation and Contributors.
29: */package org.jfree.report.layout;
30:
31: import org.jfree.report.Band;
32: import org.jfree.report.function.ExpressionRuntime;
33: import org.jfree.report.style.StyleKey;
34: import org.jfree.report.util.geom.StrictDimension;
35:
36: /**
37: * An interface that defines the methods to be supported by a band layout manager.
38: * <p/>
39: * See the AWT LayoutManager for the idea :)
40: *
41: * @author Thomas Morgner
42: * @see org.jfree.report.layout.StaticLayoutManager
43: * @deprecated This layout manager is no longer used.
44: */
45: public interface BandLayoutManager {
46: /**
47: * The LayoutManager styleKey. All bands must define their LayoutManager by using this
48: * key when using the PageableReportProcessor.
49: */
50: public static final StyleKey LAYOUTMANAGER = StyleKey.getStyleKey(
51: "layoutmanager", BandLayoutManager.class, false, false);
52:
53: /**
54: * Calculates the preferred layout size for a band.
55: *
56: * @param b the band.
57: * @param containerDims the bounds of the surrounding container.
58: * @param maxUsableSize the maximum size that can be granted by the surrounding container.
59: * @param support the layout support used to compute sizes.
60: * @return the preferred size.
61: */
62: public StrictDimension preferredLayoutSize(Band b,
63: StrictDimension containerDims,
64: StrictDimension maxUsableSize, LayoutSupport support,
65: final ExpressionRuntime runtime);
66:
67: /**
68: * Calculates the minimum layout size for a band.
69: *
70: * @param b the band.
71: * @param containerDims the bounds of the surrounding container.
72: * @param maxUsableSize
73: * @param support the layout support used to compute sizes.
74: * @return the minimum size.
75: */
76: public StrictDimension minimumLayoutSize(Band b,
77: StrictDimension containerDims,
78: StrictDimension maxUsableSize, LayoutSupport support,
79: final ExpressionRuntime runtime);
80:
81: /**
82: * Performs the layout of a band.
83: *
84: * @param b the band.
85: * @param support the layout support used to compute sizes.
86: */
87: public void doLayout(Band b, LayoutSupport support,
88: final ExpressionRuntime runtime);
89: }
|