at.mug.iqm.api.plugin

Class AbstractPlugin

java.lang.Object

at.mug.iqm.api.plugin.AbstractPlugin

All Implemented Interfaces:

IPlugin, Serializable

public abstract class AbstractPlugin
extends Object
implements IPlugin

The abstract super class for all plugins.

Author:

Philipp Kainz

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Properties	props The properties from the XML file.
private static long	serialVersionUID The UID for serialization.

Constructor Summary

Constructors

Constructor and Description
AbstractPlugin()

Method Summary

Modifier and Type	Method and Description
String	getActionCommand() This is a wrapper method and returns the UID of the plugin.
ImageIcon	getDisabledMenuIcon() Gets the menu icon for the disabled menu item of this plugin.
ImageIcon	getEnabledMenuIcon() Gets the menu icon for the enabled menu item of this plugin.
String	getName() The name of the plugin, which will be used for menu entry creation.
Properties	getProperties() Get the whole iqm-plugin.xml file as Properties.
String	getType() Get the type of the plugin.
String	getUID() The unique identifier of the plugin.
String	getVersion() Get the version of the plugin.
abstract IPlugin	init() Initialize this plugin.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

The UID for serialization.

See Also:

Constant Field Values

props

protected Properties props

The properties from the XML file.

Constructor Detail

AbstractPlugin

public AbstractPlugin()

Method Detail

init

public abstract IPlugin init()

Description copied from interface: IPlugin

Initialize this plugin. On this method, the plugin has to call at least the IPluginRegistry.register(IPlugin, String) using a self-reference as parameter.

If the plugin furthermore contains an IOperator, the second call will the registration of the operator descriptor.

Specified by:

init in interface IPlugin

See Also:

IPlugin.init()

getUID

public String getUID()

Description copied from interface: IPlugin

The unique identifier of the plugin. This is usually the fully-qualified path name to the implementing plugin class.

Specified by:

getUID in interface IPlugin

Returns:

the UID of the plugin

getName

public String getName()

Description copied from interface: IPlugin

The name of the plugin, which will be used for menu entry creation.

Specified by:

getName in interface IPlugin

Returns:

the name of the plugin (menu entry)

getActionCommand

public String getActionCommand()

Description copied from interface: IPlugin

This is a wrapper method and returns the UID of the plugin.

The UID will furthermore be used for adding ActionListener interfaces to the plugin.

Specified by:

getActionCommand in interface IPlugin

Returns:

the action command, usually the UID of the plugin

getVersion

public String getVersion()

Description copied from interface: IPlugin

Get the version of the plugin.

Specified by:

getVersion in interface IPlugin

Returns:

the version of the plugin

getType

public String getType()

Description copied from interface: IPlugin

Get the type of the plugin. This information is used for menu hierarchy construction.

Specified by:

getType in interface IPlugin

Returns:

the type of the plugin

getProperties

public Properties getProperties()

Description copied from interface: IPlugin

Get the whole iqm-plugin.xml file as Properties.

Specified by:

getProperties in interface IPlugin

Returns:

the plugin properties

getEnabledMenuIcon

public ImageIcon getEnabledMenuIcon()

Description copied from interface: IPlugin

Gets the menu icon for the enabled menu item of this plugin.

The class loader searches for a file named menu-item-enabled.png in the resource sub package icons of the IPlugin instance. For instance, if the implementing class of IPlugin is located in the package my.plugins, the loader looks up resources/my/plugins/icons/menu-item-enabled.png and constructs a new ImageIcon.

If menu-item-enabled.png is not contained in this package, the default icon from the public API is used.

One may specify a custom file name to be searched for in the mentioned resource directory. If these files are not found, the default icon is loaded.

Specified by:

getEnabledMenuIcon in interface IPlugin

Returns:

the menu icon for enabled menu items, if present, or the default enabled plugin menu item icon

getDisabledMenuIcon

public ImageIcon getDisabledMenuIcon()

Description copied from interface: IPlugin

Gets the menu icon for the disabled menu item of this plugin.

The class loader searches for a file named menu-item-disabled.png in the resource sub package icons of the IPlugin instance. For instance, if the implementing class of IPlugin is located in the package my.plugins, the loader looks up resources/my/plugins/icons/menu-item-disabled.png and constructs a new ImageIcon.

If menu-item-disabled.png is not contained in this package, the default icon from the public API is used.

One may specify a custom file name to be searched for in the mentioned resource directory. If these files are not found, the default icon is loaded.

Specified by:

getDisabledMenuIcon in interface IPlugin

Returns:

the menu icon for disabled menu items, if present, or the default disabled plugin menu item icon