Package com.tagtraum.beatunes

Interface ConfigurableComponent

All Known Implementing Classes:

AnalysisQueuePreferences, GeneralPreferences, InspectionPreferences, MatchTablePreferences, PlaybackPreferences, PluginPreferences

public interface ConfigurableComponent

Configurable component allows you to display a pane in the preferences dialog.

Author:

Hendrik Schreiber

Method Summary

Modifier and Type	Method	Description
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.

Method Detail

getId

String getId()

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

Returns:

id

See Also:

PreferencesDialog.getConfigurableComponent(String)

getPreferenceView

JComponent getPreferenceView()

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

Returns:

component

getIcon

Icon getIcon()

Icon representing the component in the preferences dialog.

Returns:

Icon

getName

String getName()

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

Returns:

name of the component

getToolTip

String getToolTip()

Tooltip that will be shown in the preferences dialog.

Returns:

tool tip

store

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

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

Parameters:

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

Throws:

ConfigurationException

load

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

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

Parameters:

parent - configuration

Throws:

ConfigurationException