| java.lang.Object
 org.apache.batik.util.PreferenceManager
| PreferenceManager | | public class PreferenceManager (Code) | | This class allows to manage users preferences.
Here is a short usage example:
// at application intialization
HashMap defaults = new HashMap();
defaults.put("windowSize", new Dimension(640, 480));
defaults.put("antialias", Boolean.TRUE);
PreferenceManager prefs = new PreferenceManager("application.ini", defaults);
try {
prefs.load();
} catch (IOException e) {
//
}
myApplication.setSize(prefs.getDimension("windowSize"));
myApplication.setAntialiasingOn(prefs.getBoolean("antialias"));
// later a dialog box may customize preferences
myApplication.setAntialiasingOn(antialiasCheckBox.getState());
prefs.setBoolean("antialias", antialiasCheckBox.getState());
// when leaving the application we need to save the preferences
prefs.setDimension("windowSize", myApplication.getSize());
prefs.setFiles("history", lastVisitedFileArray);
try {
prefs.save()
} catch (IOException e) {
//
}
author:
Christophe Jolif
version:
$Id$ |
| Method Summary | |
| public boolean | getBoolean(String key)
Gets a boolean preference. | | public Color | getColor(String key)
Retruns a Color preference. | | public Dimension | getDimension(String key)
Returns a Dimension preference. | | public File | getFile(String key)
Returns a File preference. | | public File[] | getFiles(String mkey)
Returns an array of Files preference. | | public float | getFloat(String key)
Gets a float preference. | | public Font | getFont(String key)
Returns a font preference. | | public int | getInteger(String key)
Gets an int preference. | | public Point | getPoint(String key)
Returns a point preference. | | public static String | getPreferenceDirectory()
Returns a String representing the directory
where PreferenceManager instances should look
for preferences. | | public Rectangle | getRectangle(String key)
Returns a Rectangle preference. | | public String | getString(String key)
Returns a String preference. | | public String[] | getStrings(String mkey)
Returns an array of String preference. | | protected static String | getSystemProperty(String prop)
Gets a System property if accessible. | | public URL | getURL(String key)
Returns an URL preference. | | public URL[] | getURLs(String mkey)
Returns an array of URLs preference. | | public void | load()
Loads the preference file. | | public void | save()
Saves the preference file. | | public void | setBoolean(String key, boolean value)
Sets a boolean property. | | public void | setColor(String key, Color value)
Sets a Color preference. | | public void | setDimension(String key, Dimension value)
Sets a Dimension preference. | | public void | setFile(String key, File value)
Sets a File property. | | public void | setFiles(String mkey, File[] values)
Sets an array of Files property. | | public void | setFloat(String key, float value)
Sets a float property. | | public void | setFont(String key, Font value)
Sets a Font preference. | | public void | setInteger(String key, int value)
Sets an int property. | | public void | setPoint(String key, Point value)
Sets a Point preference. | | public static void | setPreferenceDirectory(String dir)
Sets a String representing the directory
where PreferenceManager instances should look
for preferences files. | | public void | setRectangle(String key, Rectangle value)
Sets a Rectangle preference. | | public void | setString(String key, String value)
Sets a String preference. | | public void | setStrings(String mkey, String[] values)
Sets a String array preference. | | public void | setURL(String key, URL value)
Sets an URL property. | | public void | setURLs(String mkey, URL[] values)
Sets an array of URLs property. |
| PreferenceManager | | public PreferenceManager(String prefFileName)(Code) | | Creates a preference manager.
Parameters:
prefFileName - the name of the preference file. |
| PreferenceManager | | public PreferenceManager(String prefFileName, Map defaults)(Code) | | Creates a preference manager with a default values
initialization map.
Parameters:
prefFileName - the name of the preference file.
Parameters:
defaults - where to get defaults value if the value isnot specified in the file. |
| getBoolean | | public boolean getBoolean(String key)(Code) | | Gets a boolean preference. If not found and no default returns false.
|
| getFiles | | public File[] getFiles(String mkey)(Code) | | Returns an array of Files preference.
|
| getFloat | | public float getFloat(String key)(Code) | | Gets a float preference.
|
| getInteger | | public int getInteger(String key)(Code) | | Gets an int preference.
|
| getStrings | | public String[] getStrings(String mkey)(Code) | | Returns an array of String preference.
|
| getSystemProperty | | protected static String getSystemProperty(String prop)(Code) | | Gets a System property if accessible. Returns an empty string
otherwise
|
| getURLs | | public URL[] getURLs(String mkey)(Code) | | Returns an array of URLs preference.
|
| load | | public void load() throws IOException(Code) | | Loads the preference file. If the file has already been previously
sucessfuly loaded or saved, it will first try to reaload it from
this location. Otherwise, it will try to find the file
in the following order: in the directory set by
PreferenceManager.setPreferenceDirectory if it exists, in the user
home directory and then in the current user directory.
exception:
IOException - if an error occured when reading the file.
See Also: PreferenceManager.save |
| save | | public void save() throws IOException(Code) | | Saves the preference file. If it has previously sucessfuly been
loaded or save it will save it at the same location. In other cases
it will save it in the directory set by
PreferenceManager.setPreferenceDirectory if has been set and exists, otherwise in the user home directory.
exception:
IOException - if an error occured when writing the file orif is impossible to write the file at all available locations.
See Also: PreferenceManager.load |
| setBoolean | | public void setBoolean(String key, boolean value)(Code) | | Sets a boolean property.
|
| setColor | | public void setColor(String key, Color value)(Code) | | Sets a Color preference. If null removes it.
|
| setDimension | | public void setDimension(String key, Dimension value)(Code) | | Sets a Dimension preference. If null removes it.
|
| setFile | | public void setFile(String key, File value)(Code) | | Sets a File property. If null removes it.
|
| setFiles | | public void setFiles(String mkey, File[] values)(Code) | | Sets an array of Files property. If null or size null removes
previous preference.
|
| setFloat | | public void setFloat(String key, float value)(Code) | | Sets a float property.
|
| setFont | | public void setFont(String key, Font value)(Code) | | Sets a Font preference. If null removes it.
|
| setInteger | | public void setInteger(String key, int value)(Code) | | Sets an int property.
|
| setPoint | | public void setPoint(String key, Point value)(Code) | | Sets a Point preference. If null removes it.
|
| setPreferenceDirectory | | public static void setPreferenceDirectory(String dir)(Code) | | Sets a String representing the directory
where PreferenceManager instances should look
for preferences files. The default value is null
which means the automatic mechanism for looking for preferences
is used.
See Also: PreferenceManager.load |
| setRectangle | | public void setRectangle(String key, Rectangle value)(Code) | | Sets a Rectangle preference. If null removes it.
|
| setString | | public void setString(String key, String value)(Code) | | Sets a String preference. If null removes it.
|
| setStrings | | public void setStrings(String mkey, String[] values)(Code) | | Sets a String array preference. If null or size null removes
previous preference.
|
| setURL | | public void setURL(String key, URL value)(Code) | | Sets an URL property. If null removes it.
|
| setURLs | | public void setURLs(String mkey, URL[] values)(Code) | | Sets an array of URLs property. If null or size null removes
previous preference.
|
|
|