01: /**
02: * ========================================
03: * JFreeReport : a free Java report library
04: * ========================================
05: *
06: * Project Info: http://reporting.pentaho.org/
07: *
08: * (C) Copyright 2000-2007, by Object Refinery Limited, 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: * $Id: ReportController.java 3048 2007-07-28 18:02:42Z tmorgner $
27: * ------------
28: * (C) Copyright 2000-2005, by Object Refinery Limited.
29: * (C) Copyright 2005-2007, by Pentaho Corporation.
30: */package org.jfree.report.modules.gui.swing.preview;
31:
32: import javax.swing.JComponent;
33: import javax.swing.JMenu;
34:
35: /**
36: * A report controler. This provides some means of configuring the
37: * preview components.
38: * <p>
39: * The controler should use the propertyChange events provided by
40: * the PreviewProxyBase and the ReportPane to update its state.
41: * <p>
42: * To force a new repagination, use the <code>refresh</code> method of
43: * the PreviewProxyBase.
44: *
45: * @author Thomas Morgner
46: */
47: public interface ReportController {
48: /**
49: * Returns the graphical representation of the controler.
50: * This component will be added between the menu bar and
51: * the toolbar.
52: * <p>
53: * Changes to this property are not detected automaticly,
54: * you have to call "refreshController" whenever you want to
55: * display a completly new control panel.
56: *
57: * @return the controler component.
58: */
59: public JComponent getControlPanel();
60:
61: /**
62: * Returns the menus that should be inserted into the menubar.
63: * <p>
64: * Changes to this property are not detected automaticly,
65: * you have to call "refreshControler" whenever the contents
66: * of the menu array changed.
67: *
68: * @return the menus as array, never null.
69: */
70: public JMenu[] getMenus();
71:
72: /**
73: * Defines, whether the controler component is placed between
74: * the preview pane and the toolbar.
75: *
76: * @return true, if this is a inner component.
77: */
78: public boolean isInnerComponent();
79:
80: /**
81: * Returns the location for the report controler, one of
82: * BorderLayout.NORTH, BorderLayout.SOUTH, BorderLayout.EAST
83: * or BorderLayout.WEST.
84: *
85: * @return the location;
86: */
87: public String getControllerLocation();
88:
89: public void initialize(PreviewPane pane);
90: }
|