plugin.java

具有不同语法高亮的编辑器实例

/*
 * 12/28/2004
 *
 * Plugin.java - A generic plugin for a GUIApplication.
 * Copyright (C) 2004 Robert Futrell
 * [e-mail]
 * www.website.com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */
package org.fife.ui.app;

import javax.swing.Icon;
import javax.swing.JMenu;


/**
 * A "plugin" in a GUI application is a class that extends that application
 * in some way.  There are several base classes of plugins that you can
 * subclass to make a plugin for your application, including:
 *
 * <ul>
 *   <li><code>GUIPlugin</code> is an actual GUI panel containing widgets,
 *       etc., and is either docked on one of the four sides of the main
 *       window or in its own floating window.</li>
 *   <li><code>WizardPlugin</code> is a series of dialogs that guides the
 *       user through some process.</li>
 * </ul>
 *
 * @author Robert Futrell
 * @version 0.1
 * @see org.fife.ui.app.GUIApplication
 * @see org.fife.ui.app.GUIPlugin
 * @see org.fife.ui.app.WizardPlugin
 */
public interface Plugin {


/*****************************************************************************/


	/**
	 * Returns the author of the plugin.
	 *
	 * @return The author.
	 */
	public String getAuthor();


/*****************************************************************************/


	/**
	 * Returns the icon to display beside the name of this plugin in the
	 * application's interface.
	 *
	 * @return The icon for this plugin.  This value may be <code>null</code>
	 *         to represent no icon.
	 */
	public Icon getIcon();


/*****************************************************************************/


	/**
	 * Returns the menu for this plugin.
	 *
	 * @return The menu for this plugin.
	 */
	public JMenu getMenu();


/*****************************************************************************/


	/**
	 * Returns the name of the plugin.
	 *
	 * @return The plugin name.
	 */
	public String getName();


/*****************************************************************************/


	/**
	 * Returns an options panel for use in an Options dialog.  This panel
	 * should contain all options pertaining to this plugin.
	 *
	 * @return The options panel.
	 */
	public PluginOptionsDialogPanel getOptionsDialogPanel();


/*****************************************************************************/


	/**
	 * Returns the version of the plugin.
	 *
	 * @return The version number of this plugin.
	 */
	public String getVersion();


/*****************************************************************************/


	/**
	 * Called just after a plugin is added to a GUI application.  If this is
	 * a <code>GUIPlugin</code>, it has already been added visually.  Plugins
	 * should use this method to register any listeners to the GUI application
	 * and do any other necessary setup.
	 *
	 * @param app The application to which this plugin was just added.
	 * @see #uninstall
	 */
	public void install(AbstractPluggableGUIApplication app);


/*****************************************************************************/


	/**
	 * Called when the GUI application is shutting down.  When this method is
	 * called, the <code>Plugin</code> should save any properties via the
	 * Java Preferences API.
	 *
	 * @see PluginPreferences
	 */
	public void savePreferences();


/*****************************************************************************/


	/**
	 * Called just before this <code>Plugin</code> is removed from an
	 * <code>GUIApplication</code>.  This gives the plugin a chance to clean
	 * up any loose ends (kill any threads, close any files, remove listeners,
	 * etc.).
	 *
	 * @return Whether the uninstall went cleanly.
	 * @see #install
	 */
	public boolean uninstall();


/*****************************************************************************/

}