verinec.gui.core
Interface IConfigurable

All Known Implementing Classes:

AdaptationModule, DrawPanel, NetworkTypes, VerinecStudio

public interface IConfigurable

Interface for configurable modules and other configurable parts of the application. Modules implementing IVerinecModule that want to display a configuration panel in the application preferences dialog also implement this IConfigurable interface. They must provide a panel extending ConfigPanel as configuration dialog element.

The configuration must also work if the module is not currently loaded. Saving of settings should be accomplished via the VerinecStudio.loadConfig(String) and VerinecStudio.saveConfig(String,org.jdom.Document) methods.

Author:

david.buchmann at unifr.ch

Method Summary

ConfigPanel	getConfigPanel() Get the configuration dialog panel.
void	saveConfiguration(Document config) Save the configuration from the ConfigPanel permanently as well as use it for running configuration.

Method Detail

getConfigPanel

ConfigPanel getConfigPanel()
                           throws VerinecException

Get the configuration dialog panel. The module may not rely on being loaded when this method is called.

Returns:

A panel to be displayed in the configuration tabbed pane.

Throws:

VerinecException - if the panel can not be instantiated.

saveConfiguration

void saveConfiguration(Document config)

Save the configuration from the ConfigPanel permanently as well as use it for running configuration. The module may not rely on being loaded when this method is called. If

Parameters:

config - The new configuration document.