Package com.tagtraum.beatunes.plugin

Class PluginPreferences

java.lang.Object

com.tagtraum.beatunes.plugin.PluginPreferences

All Implemented Interfaces:

ConfigurableComponent

public class PluginPreferences
extends Object
implements ConfigurableComponent

PluginPreferences.

Author:

Hendrik Schreiber

Constructor Summary

Constructors

Constructor	Description
PluginPreferences(BeaTunes application)

Method Summary

Modifier and Type	Method	Description
JComponent	$$$getRootComponent$$$()
BeaTunes	getApplication()
Icon	getIcon()	Icon representing the component in the preferences dialog.
String	getId()	Identifier that is used to uniquely identify a given component.
String	getName()	Name that will be used in the preferences dialog for this component.
JComponent	getPreferenceView()	Returns a JComponent that allows the user to configure this component.
String	getToolTip()	Tooltip that will be shown in the preferences dialog.
void	load(nu.xom.Element parent)	Is called by the application when preferences are loaded.
void	store(nu.xom.Element parent)	Will be called by the application when it thinks that configurable components should store their configuration.

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginPreferences

public PluginPreferences(BeaTunes application)

Method Detail

getApplication

public BeaTunes getApplication()

getId

public String getId()

Description copied from interface: ConfigurableComponent

Identifier that is used to uniquely identify a given component. This id will be used to mark the component in the persistently stored configuration.

Specified by:

getId in interface ConfigurableComponent

Returns:

id

See Also:

PreferencesDialog.getConfigurableComponent(String)

getPreferenceView

public JComponent getPreferenceView()

Description copied from interface: ConfigurableComponent

Returns a JComponent that allows the user to configure this component. The preference view will be used as part of the preferences dialog.

Specified by:

getPreferenceView in interface ConfigurableComponent

Returns:

component

getIcon

public Icon getIcon()

Description copied from interface: ConfigurableComponent

Icon representing the component in the preferences dialog.

Specified by:

getIcon in interface ConfigurableComponent

Returns:

Icon

getName

public String getName()

Description copied from interface: ConfigurableComponent

Name that will be used in the preferences dialog for this component.

Specified by:

getName in interface ConfigurableComponent

Returns:

name of the component

getToolTip

public String getToolTip()

Description copied from interface: ConfigurableComponent

Tooltip that will be shown in the preferences dialog.

Specified by:

getToolTip in interface ConfigurableComponent

Returns:

tool tip

store

public void store(nu.xom.Element parent)
           throws ConfigurationException

Description copied from interface: ConfigurableComponent

Will be called by the application when it thinks that configurable components should store their configuration.

Specified by:

store in interface ConfigurableComponent

Parameters:

parent - empty parent element should contain all configuration children for this component once this method returns

Throws:

ConfigurationException

load

public void load(nu.xom.Element parent)
          throws ConfigurationException

Description copied from interface: ConfigurableComponent

Is called by the application when preferences are loaded. The component is responsible for interpreting the parent element.

Specified by:

load in interface ConfigurableComponent

Parameters:

parent - configuration

Throws:

ConfigurationException

$$$getRootComponent$$$

public JComponent $$$getRootComponent$$$()