com.plealog.prefs4j.ui

Interface PreferenceEditor

public interface PreferenceEditor

This interfaces defines a Preference Editor.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PreferenceEditor.PROPERTY UI properties associated to a Preference Section.
static class	PreferenceEditor.TYPE Default Editor types available in the Framework.

Method Summary

Methods

Modifier and Type	Method and Description
void	editorShowed() Method invoked by the framework when the editor is showed.
JComponent	getEditor() Returns the GUI component of the editor.
String	getName() Returns the name of the editor.
PreferenceSection	getPreferenceSection() Returns the ConfigurationFeature associated to the editor.
boolean	isEdited() Figures out whether something has been edited.
PreferenceEditor	newInstance(PreferenceSection cf, HashSet<PreferenceEditor.PROPERTY> props) Creates a new instance of an editor.
void	saveData() Saves data.

Method Detail

newInstance

PreferenceEditor newInstance(PreferenceSection cf,
                           HashSet<PreferenceEditor.PROPERTY> props)

Creates a new instance of an editor.

Parameters:

cf - the PreferenceSection for which the editor has to be created

props - the set of properties to apply to the editor

Returns:

a new instance of an editor

getName

String getName()

Returns the name of the editor.

isEdited

boolean isEdited()

Figures out whether something has been edited.

saveData

void saveData()
              throws PreferenceException

Saves data.

Throws:

PreferenceException - implementation should throw a PreferenceException if any kind of errors occurs while saving data.

getEditor

JComponent getEditor()

Returns the GUI component of the editor.

editorShowed

void editorShowed()

Method invoked by the framework when the editor is showed.

getPreferenceSection

PreferenceSection getPreferenceSection()

Returns the ConfigurationFeature associated to the editor.