01: /*
02: * Copyright (C) 2005 - 2008 JasperSoft Corporation. All rights reserved.
03: * http://www.jaspersoft.com.
04: *
05: * Unless you have purchased a commercial license agreement from JasperSoft,
06: * the following license terms apply:
07: *
08: * This program is free software; you can redistribute it and/or modify
09: * it under the terms of the GNU General Public License version 2 as published by
10: * the Free Software Foundation.
11: *
12: * This program is distributed WITHOUT ANY WARRANTY; and without the
13: * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
14: * See the GNU General Public License for more details.
15: *
16: * You should have received a copy of the GNU General Public License
17: * along with this program; if not, see http://www.gnu.org/licenses/gpl.txt
18: * or write to:
19: *
20: * Free Software Foundation, Inc.,
21: * 59 Temple Place - Suite 330,
22: * Boston, MA USA 02111-1307
23: *
24: *
25: *
26: *
27: * IReportPlugin.java
28: *
29: * Created on 19 maggio 2004, 7.23
30: *
31: */
32:
33: package it.businesslogic.ireport.plugin;
34:
35: import it.businesslogic.ireport.gui.MainFrame;
36:
37: /**
38: * This class must be extended by all iReport plugin.
39: * To install a plugin into iReport, put the plugin xml in the plugin directory of iReport.
40: * See plugin documentation on how to create a plugin for iReport
41: *
42: * This is the first very simple interface to plugin. I hope to don't change it, but we can't say
43: * what it'll happen in he future...
44: *
45: * @author Administrator
46: */
47: public abstract class IReportPlugin {
48:
49: MainFrame mainFrame = null;
50: String name = "";
51:
52: /**
53: * This method is called when the plugin is selected from the plugin menu
54: */
55: public abstract void call();
56:
57: /**
58: * This method is called when the plugin configuration button on plugin list is selected.
59: * Configuration file of plugin should be stored in IREPORT_USER_HOME_DIR/plugins/
60: */
61: public void configure() {
62: }
63:
64: /**
65: * Retrive the plugin name. Please note that the plugin name must be unique and should be used as
66: * filename for the configuration file if needed. This name can be different from the name specified
67: * in XML, that is the name used for the menu item.
68: */
69: public String getName() {
70: return name;
71: }
72:
73: /** Getter for property mainFrame.
74: * @return Value of property mainFrame.
75: *
76: */
77: public it.businesslogic.ireport.gui.MainFrame getMainFrame() {
78: return mainFrame;
79: }
80:
81: /** Setter for property mainFrame.
82: * @param mainFrame New value of property mainFrame.
83: *
84: */
85: public void setMainFrame(
86: it.businesslogic.ireport.gui.MainFrame mainFrame) {
87: this.mainFrame = mainFrame;
88: }
89:
90: }
|