com.azalient.api.b.plugins
Interface IPluginInfo

All Superinterfaces:

Comparator<IPluginInfo>, IRecord, RecordR, RecordRW, RecordW, SortableData, StoreRecordRW

public interface IPluginInfo
extends StoreRecordRW, Comparator<IPluginInfo>

An object that holds information about each plugin

Field Summary

Fields inherited from interface com.azalient.api.a.tables.IRecord

DELETED, KEY_SEP, KEY_SEP_CHAR

Method Summary

String	classname() The java class name of the main plugin class
boolean	enabled() Returns the connected/ disconnected state of this plugin
void	enabled(boolean v) Sets the connected/ disconnected state of this plugin
void	initialise() [Internal use only] Initialise this plugin
boolean	isSecret() Returns true if this plugin is "secret"
boolean	isSystemPlugin() Returns true if this is a system plugin
boolean	isVisible() Returns true if this plugin is visible
String	label() A label for this plugin used in the plugin panel
IBasePlugin	plugin() Returns the plugin object associated with this information object
void	plugin(IBasePlugin bp) [INternal use only] Sets the reference to a plugin.
int	status() Returns the status of this plugin see StatusListener.
void	status(int value) Sets the status of this plugin see StatusListener.
String	statusMessage() [Internal use only]
void	statusMessage(String message) [Internal use only]

Methods inherited from interface com.azalient.api.file.StoreRecordRW

canRename, rename, store

Methods inherited from interface com.azalient.api.file.RecordR

extraSet, finished, isApplicable, isEditable, set

Methods inherited from interface com.azalient.api.a.tables.IRecord

name

Methods inherited from interface com.azalient.api.file.RecordW

extraCols, extraGet, extraGetB, extraGetD, extraGetI, extraGetS, extraGetT, get, isVolatile

Methods inherited from interface java.util.Comparator

compare, equals

Method Detail

classname

String classname()

The java class name of the main plugin class

label

String label()

A label for this plugin used in the plugin panel

enabled

void enabled(boolean v)

Sets the connected/ disconnected state of this plugin

enabled

boolean enabled()

Returns the connected/ disconnected state of this plugin

plugin

void plugin(IBasePlugin bp)

[INternal use only] Sets the reference to a plugin.

Internal - Not recommended for use. Public as a side-effect of implementation method

plugin

IBasePlugin plugin()

Returns the plugin object associated with this information object

status

void status(int value)

Sets the status of this plugin see StatusListener. This controls the icon on the plugin panel.

status

int status()

Returns the status of this plugin see StatusListener. This controls the icon on the plugin panel.

statusMessage

void statusMessage(String message)

[Internal use only]

Internal - Not recommended for use. Public as a side-effect of implementation method

statusMessage

String statusMessage()

[Internal use only]

Internal - Not recommended for use. Public as a side-effect of implementation method

isSystemPlugin

boolean isSystemPlugin()

Returns true if this is a system plugin

initialise

void initialise()

[Internal use only] Initialise this plugin

Internal - Not recommended for use. Public as a side-effect of implementation method

isVisible

boolean isVisible()

Returns true if this plugin is visible

Internal - Not recommended for use. Public as a side-effect of implementation method

isSecret

boolean isSecret()

Returns true if this plugin is "secret"

Internal - Not recommended for use. Public as a side-effect of implementation method