com.azalient.api.a
Interface IBasePlugin

All Known Implementing Classes:

com.azalient.base.BaseInternals, BasePlugin

public interface IBasePlugin

The basic methods that each plugin must implement.

See Also:

BasePlugin

Method Summary

void	centralStatusListener(StatusListener sl) Set the pointer to the central status listener that is updated when the status of this plugin chages
void	enable(boolean on) Toggle to enable this plugin
boolean	isEnabled() Returns true if this plugin is enabled
void	pluginClose() The action called when the plugin is closed
void	pluginOpen() The action called when the plugin is opened
Window	pluginWindow() Return a pointer to the user interface window for this plugin, or null if there is none
void	raiseWindow() Display the user interface window for this plugin
String	status() A message describing the current status
void	unload() unload this plugin after closing.

Method Detail

status

String status()

A message describing the current status

enable

void enable(boolean on)

Toggle to enable this plugin

isEnabled

boolean isEnabled()

Returns true if this plugin is enabled

raiseWindow

void raiseWindow()

Display the user interface window for this plugin

pluginWindow

Window pluginWindow()

Return a pointer to the user interface window for this plugin, or null if there is none

centralStatusListener

void centralStatusListener(StatusListener sl)

Set the pointer to the central status listener that is updated when the status of this plugin chages

pluginOpen

void pluginOpen()

The action called when the plugin is opened

pluginClose

void pluginClose()

The action called when the plugin is closed

unload

void unload()

unload this plugin after closing. This is public as an implementation side-effect. It is not wise to call this out of sequence