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