org.xnap.plugin
Interface Plugin

All Known Implementing Classes:

AbstractLAFPlugin, AbstractPlugin, AbstractThemePlugin, AbstractViewer, AcrobatViewerPlugin, AlloyPlugin, AzureusPlugin, BitziPlugin, CalpaHtmlPlugin, EclipsePlugin, FestivalPlugin, FreewayPlugin, GiFTPlugin, ImageViewerPlugin, JMFPlayerPlugin, JOscarPlugin, JTellaPlugin, KunststoffPlugin, LimeWirePlugin, LiquidPlugin, LooksPlugin, MP3TagEditorPlugin, NewsPlugin, OAVPlugin, OpenNapPlugin, OvernetPlugin, PircBotPlugin, StatsPlugin, TechnicalPlugin, TextViewerPlugin, VideoInfoPlugin, VorbisViewerPlugin, ZipViewerPlugin

public interface Plugin

Plugins extend the functionality of the main program. Plugins are allowed to hook into XNap wherever they want. Each plugin will only be instantiated once. First start() is called. If the gui is enabled then startGUI() will be called next. The plugin has to setup all gui parts by itself. When the plugin is disabled or XNap is shutdown stopGUI() is called (if startGUI() was called) and stop() afterwards.

Method Summary

PluginInfo	getInfo() Returns information about this plugin.
void	setInfo(PluginInfo info) Sets the information record for this plugin.
void	start() Called each time the plugin is enabled.
void	startGUI() Called each time the gui part of the plugin is enabled.
void	stop() Called each time the plugin is disabled.
void	stopGUI() Called each time the gui part of the plugin is disabled.

Method Detail

getInfo

PluginInfo getInfo()

Returns information about this plugin.

setInfo

void setInfo(PluginInfo info)

Sets the information record for this plugin. Called by PluginManager.

Parameters:

info - the info record

start

void start()
           throws java.lang.Exception

Called each time the plugin is enabled.

Throws:

java.lang.Exception

startGUI

void startGUI()

Called each time the gui part of the plugin is enabled.

stop

void stop()

Called each time the plugin is disabled.

stopGUI

void stopGUI()

Called each time the gui part of the plugin is disabled.