com.canto.cumulus.modules.ejpregistries

Interface EJPPreferencePanel

All Known Implementing Classes:

DefaultEJPPreferencePanel

public interface EJPPreferencePanel

This interface is used by the Preference dialog of Cumulus to display the prefernce panel of an EJaP.

Since:

EJaP 6.0.0

Method Summary

Methods

Modifier and Type	Method and Description
javax.swing.Icon	getIcon() Return a Java Icon object to be displayed in the Preferences dialog in the list of EJaPs
java.lang.String	getName() Return a user-readable name for this EJaP to be displayed in the Preferences dialog.
javax.swing.JPanel	getPanel(Pack prefsPack) Return a JPanel that is added to the Preferences dialog.
void	savePreferences() Save the contents of the JPanel to the Pack object passed to the getPanel(com.canto.cumulus.Pack) method.

Method Detail

getIcon

javax.swing.Icon getIcon()

Return a Java Icon object to be displayed in the Preferences dialog in the list of EJaPs

Returns:

An Icon object or null if you want to use the default icon.

getName

java.lang.String getName()

Return a user-readable name for this EJaP to be displayed in the Preferences dialog.

Returns:

A user-readable name for your EJaP.

getPanel

javax.swing.JPanel getPanel(Pack prefsPack)

Return a JPanel that is added to the Preferences dialog. Your panel may contain any items but you should not assume any specific fixed destination size.

Parameters:

prefsPack - The preference data to be displayed by the panel.

Returns:

The JPanel.

savePreferences

void savePreferences()

Save the contents of the JPanel to the Pack object passed to the getPanel(com.canto.cumulus.Pack) method. This method gets called when the user clicks the "Apply" or "OK" button in the Preferences dialog.