at.mug.iqm.api.plugin

Class PluginPropertyManager

java.lang.Object

at.mug.iqm.commons.util.PropertyManager

at.mug.iqm.commons.util.XMLPropertyManager

at.mug.iqm.api.plugin.PluginPropertyManager

public class PluginPropertyManager
extends XMLPropertyManager

A reader for XML-formatted Properties and other plugin related stuff.

The class reads the content of iqm-plugin.xml, which is located right next to the implementing class of IPlugin in the class path.

This class also constructs the enabled/disabled icons for the menu items. They can either be default or customized.

Author:

Philipp Kainz

Constructor Summary

Constructors

Constructor and Description
PluginPropertyManager()

Method Summary

Modifier and Type	Method and Description
static ImageIcon	getCustomMenuIcon(IPlugin plugin, String fileName) Gets a custom menu item for a plugin.
static ImageIcon	getDefaultDisabledMenuIcon() Gets the default menu icon for an active plugin menu item.
static ImageIcon	getDefaultEnabledMenuIcon() Gets the default menu icon for an active plugin menu item.
static Properties	readPluginProperties(IPlugin plugin) Read the properties from iqm-plugin.xml.

Methods inherited from class at.mug.iqm.commons.util.XMLPropertyManager

main, readXML, writeXML

Methods inherited from class at.mug.iqm.commons.util.PropertyManager

getManager, getProperty, getPropFile, read, read, setProperty, setPropFile, write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginPropertyManager

public PluginPropertyManager()

Method Detail

readPluginProperties

public static Properties readPluginProperties(IPlugin plugin)

Read the properties from iqm-plugin.xml.

Parameters:

plugin -

Returns:

the Properties from the plugin

getDefaultEnabledMenuIcon

public static ImageIcon getDefaultEnabledMenuIcon()

Gets the default menu icon for an active plugin menu item.

The use of a 16x16 PNG image is encouraged.

Returns:

the ImageIcon located in "/icons/plugin/menu/default-enabled.png"

getDefaultDisabledMenuIcon

public static ImageIcon getDefaultDisabledMenuIcon()

Gets the default menu icon for an active plugin menu item.

The use of a 16x16 PNG image is encouraged.

Returns:

the ImageIcon located in "/icons/plugin/menu/default-disabled.png"

getCustomMenuIcon

public static ImageIcon getCustomMenuIcon(IPlugin plugin,
                                          String fileName)

Gets a custom menu item for a plugin.

The use of a 16x16 PNG image is encouraged.

Returns:

the ImageIcon located in the plugin's resource directory