|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.sun.javatest.tool.Preferences
public class Preferences
A class which provides a collection of user preferences, and a GUI interface to edit them. Preferences are represented as named string values. For now, the data is stored in a standard Java properties file in the user's home directory; eventually, it will be converted to use the J2SE support for user preferences.
Nested Class Summary | |
---|---|
static interface |
Preferences.Observer
An observer interface for use by those that wishing to monitor changes to user preferences. |
static class |
Preferences.Pane
An abstract class for a GUI panel that can be displayed to allow the user to edit some of the user preferences. |
Method Summary | |
---|---|
static Preferences |
access()
Access the single Preferences object. |
void |
addObserver(java.lang.String[] prefixes,
Preferences.Observer o)
Add an observer to be notified of changes to all preferences whose name begins with any of a set of given prefixes. |
void |
addObserver(java.lang.String prefix,
Preferences.Observer o)
Add an observer to be notified of changes to all preferences whose name begins with a given prefix. |
java.lang.String |
getPreference(java.lang.String name)
Get a named preference value. |
java.lang.String |
getPreference(java.lang.String name,
java.lang.String defaultValue)
Get a named preference value, using a default if the named preference is not found. |
void |
removeObserver(java.lang.String[] prefixes,
Preferences.Observer o)
Remove an observer which was previously registered to be notified of changes to all preferences whose name begins with any of a set of prefixed. |
void |
removeObserver(java.lang.String prefix,
Preferences.Observer o)
Remove an observer which was previously registered to be notified of changes to all preferences whose name begins with a given prefix. |
void |
save()
Save the current set of user preferences. |
void |
setPreference(java.lang.String name,
java.lang.String newValue)
Set the value of a named preference. |
void |
showDialog(javax.swing.JFrame f,
Preferences.Pane[] panes,
javax.help.HelpBroker helpBroker)
Show a dialog to allow the user to edit the set of preferences. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static Preferences access()
public void save()
public java.lang.String getPreference(java.lang.String name)
name
- the name of the desired preference
setPreference(java.lang.String, java.lang.String)
public java.lang.String getPreference(java.lang.String name, java.lang.String defaultValue)
name
- the name of the desired preferencedefaultValue
- the default value to be returned if no such preference
is found
setPreference(java.lang.String, java.lang.String)
public void setPreference(java.lang.String name, java.lang.String newValue)
name
- the name of the preference to be setnewValue
- the new value for the preferencegetPreference(java.lang.String)
public void addObserver(java.lang.String prefix, Preferences.Observer o)
prefix
- the prefix to determine which preferences will
be observedo
- the observer to be addedremoveObserver(java.lang.String, com.sun.javatest.tool.Preferences.Observer)
public void addObserver(java.lang.String[] prefixes, Preferences.Observer o)
prefixes
- the prefix to determine which preferences will
be observedo
- the observer to be addedremoveObserver(java.lang.String, com.sun.javatest.tool.Preferences.Observer)
public void removeObserver(java.lang.String prefix, Preferences.Observer o)
prefix
- the prefix to identify which instance of the
observer to be removedo
- the observer to be removedaddObserver(java.lang.String, com.sun.javatest.tool.Preferences.Observer)
public void removeObserver(java.lang.String[] prefixes, Preferences.Observer o)
prefixes
- the prefix to identify which instances of the
observer to be removedo
- the observer to be removedaddObserver(java.lang.String, com.sun.javatest.tool.Preferences.Observer)
public void showDialog(javax.swing.JFrame f, Preferences.Pane[] panes, javax.help.HelpBroker helpBroker)
f
- the parent frame for the dialogpanes
- the editing panes to be displayed in the dialoghelpBroker
- a help broker to be used to provide context sensitive
help for the dialog
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |