KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > it > businesslogic > ireport > plugin > IReportPlugin


1 /*
2  * Copyright (C) 2005 - 2006 JasperSoft Corporation. All rights reserved.
3  * http://www.jaspersoft.com.
4  *
5  * Unless you have purchased a commercial license agreement from JasperSoft,
6  * the following license terms apply:
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * 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  * This class must be extended by all iReport plugin.
38  * To install a plugin into iReport, put the plugin xml in the plugin directory of iReport.
39  * See plugin documentation on how to create a plugin for iReport
40  *
41  * This is the first very simple interface to plugin. I hope to don't change it, but we can't say
42  * what it'll happen in he future...
43  *
44  * @author Administrator
45  */
46 public abstract class IReportPlugin {
47     
48     MainFrame mainFrame = null;
49     String JavaDoc name = "";
50         
51     /**
52      * This method is called when the plugin is selected from the plugin menu
53      */
54     public abstract void call();
55     
56     /**
57      * This method is called when the plugin configuration button on plugin list is selected.
58      * Configuration file of plugin should be stored in IREPORT_USER_HOME_DIR/plugins/
59      */
60     public void configure(){}
61
62     /**
63      * Retrive the plugin name. Please note that the plugin name must be unique and should be used as
64      * filename for the configuration file if needed. This name can be different from the name specified
65      * in XML, that is the name used for the menu item.
66      */
67     public String JavaDoc getName(){
68         return name;
69     }
70     
71     /** Getter for property mainFrame.
72      * @return Value of property mainFrame.
73      *
74      */
75     public it.businesslogic.ireport.gui.MainFrame getMainFrame() {
76         return mainFrame;
77     }
78     
79     /** Setter for property mainFrame.
80      * @param mainFrame New value of property mainFrame.
81      *
82      */
83     public void setMainFrame(it.businesslogic.ireport.gui.MainFrame mainFrame) {
84         this.mainFrame = mainFrame;
85     }
86     
87 }
88
Popular Tags