com.canto.cumulus.prefs

Class ModulePreferences

java.lang.Object

com.canto.cumulus.prefs.BaseManager

com.canto.cumulus.prefs.ModulePreferences

public class ModulePreferences
extends BaseManager

This class manages the preferences of a single module.

See Also:

ModulePreferencesList.getModulePreferences(String)

Nested Class Summary

Nested classes/interfaces inherited from class com.canto.cumulus.prefs.BaseManager

BaseManager.PackEntryChangeListener, BaseManager.RegistryEntry

Field Summary

Fields inherited from class com.canto.cumulus.prefs.BaseManager

TYPE_EJP, TYPE_NATIVE

Method Summary

Methods

Modifier and Type	Method and Description
JPack	getDisplayPrefs(PackListener listener) Returns the display preferences pack.
JPack	getGeneralPrefs(PackListener listener) Returns the general preferences pack.
JPack	getSearchPrefs(PackListener listener) Returns the search preferences pack.
int	getType() Returns this modules type.
java.lang.String	getUID() Returns the UID of this module.
void	setDisplayPrefs(PackListener listener, JPack pack) Saves the display preferences pack.
void	setGeneralPrefs(PackListener listener, JPack pack) Saves the general preferences pack.
void	setSearchPrefs(PackListener listener, JPack pack) Saves the search preferences pack.

Methods inherited from class com.canto.cumulus.prefs.BaseManager

addChangeListener, addChangeListener, addGlobalChangeListener, addPackListener, forgetPush, getPack, isShared, popPack, pushPack, removeChangeListener, removeChangeListener, removeGlobalChangeListener, removePackListener, save, save, toString, writeAsXML

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getUID

public java.lang.String getUID()

Returns the UID of this module.

Returns:

module UID

getType

public int getType()

Returns this modules type.

Returns:

module type

getGeneralPrefs

public JPack getGeneralPrefs(PackListener listener)

Returns the general preferences pack. The listener provided will get a notification if the configuration should be saved back into the given pack.

Parameters:

listener - the listener to be notified to save the changes

Returns:

the pack containing the general preferences

setGeneralPrefs

public void setGeneralPrefs(PackListener listener,
                   JPack pack)

Saves the general preferences pack. The listener provided needs to be the same as provided to the getGeneralPrefs(PackListener) method. The listener is automatically removed as well.

Parameters:

listener - the listener to be notified to save the changes

pack - the pack with the new settings for this module

getDisplayPrefs

public JPack getDisplayPrefs(PackListener listener)

Returns the display preferences pack. The listener provided will get a notification if the configuration should be saved back into the given pack.
This is only used by the Cumulus Client application.

Parameters:

listener - the listener to be notified to save the changes

Returns:

the pack containing the general preferences

setDisplayPrefs

public void setDisplayPrefs(PackListener listener,
                   JPack pack)

Saves the display preferences pack. The listener provided needs to be the same as provided to the getGeneralPrefs(PackListener) method. The listener is automatically removed as well.
This is only used by the Cumulus Client application.

Parameters:

listener - the listener to be notified to save the changes

pack - the pack with the new settings for this module

getSearchPrefs

public JPack getSearchPrefs(PackListener listener)

Returns the search preferences pack. The listener provided will get a notification if the configuration should be saved back into the given pack.
This is only used by the Cumulus Client application.

Parameters:

listener - the listener to be notified to save the changes

Returns:

the pack containing the general preferences

setSearchPrefs

public void setSearchPrefs(PackListener listener,
                  JPack pack)

Saves the search preferences pack. The listener provided needs to be the same as provided to the getGeneralPrefs(PackListener) method. The listener is automatically removed as well.
This is only used by the Cumulus Client application.

Parameters:

listener - the listener to be notified to save the changes

pack - the pack with the new settings for this module