freenet.pluginmanager

Interface FredPluginConfigurable

All Superinterfaces:

FredPluginL10n

public interface FredPluginConfigurable
extends FredPluginL10n

Implement this if your plugin needs to store configuration parameters. The node will handle loading and saving the parameters. It will also provide a user interface to modify them. An entry will be made in the global Configuration menu dedicated to the plugin's configuration. The plugin must implement the @link FredPluginL10n interface, to allow translation of the config parameter descriptions. The l10n key for the menu label is "ConfigToadlet.full.package.Classname.label". The key for the menu tooltip is "ConfigToadlet.full.package.Classname.tooltip". The parameters are stored in an unencrypted plaintext file in the node's configuration directory using the filename plugin-full.package.Classname.ini. Plugins may force a write of the configuration file by calling pluginRespirator.storeConfig(), but this is only necessary if the plugin modifes a parameter behind the user's back.

Method Summary

Modifier and Type	Method and Description
void	setupConfig(SubConfig subconfig) Setup the plugin's configuration options.

Methods inherited from interface freenet.pluginmanager.FredPluginL10n

getString, setLanguage

Method Detail

setupConfig

void setupConfig(SubConfig subconfig)

Setup the plugin's configuration options. This method is called before the plugin's runPlugin method, but not in a new thread. Plugins should register options on the supplied SubConfig, but they should not do any other initialization.