All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface semper.preferences.PrefGroupToAdd

public interface PrefGroupToAdd
This interface must be implemented by all manager who want to add preferences groups but are initialised before the Preferences manager. For instance when the ACM is initialised, some standard roles are created. Some of them need a password to be unlocked. These must be modifiable by the user through its preferences. So the ACM at initialisation uses an implementation of this interface in order to build its preferences groups prior the moment these groups will be added to the preferences manager. This interface contains only three functions (methods with output value and only relevent through this output value): the build() function returns the new group to be added, wichSubGroup() which tell in which subgroup the new group must be added and getName() which returns the name of the group to be added.

Version:
$Revision: 1.3 $ $Date: 1997/09/01 12:24:55 $
Author:
Louis Salvail (CWI)
See Also:
PrefField

Method Index

o build()
This method is called when the preferences group to add is built.
o getName()
Returns the name of the group built by build().
o whichSubGroup()
This method is called to update the preferences menu-structure according to the addition of this prefGroup.

Methods

o getName 
 public abstract String getName()
Returns the name of the group built by build().

Returns:
the name.
o build 
 public abstract PrefGroup build() throws PreferencesException
This method is called when the preferences group to add is built.

Returns:
The new prefGroup to be added to the preferences manager.
Throws: PreferencesException
when an error occurs.
See Also:
PrefGroup
o whichSubGroup 
 public abstract String whichSubGroup()
This method is called to update the preferences menu-structure according to the addition of this prefGroup. Returns the subgroup in which the group will be added.

Returns:
a String describing the name of the subgroup in which this group will be added. If the group is added to the first level this methid should return Preferences.root.
See Also:
Preferences 
All Packages  Class Hierarchy  This Package  Previous  Next  Index