processing.app

Class Preferences

Object

Preferences

public class Preferences
extends Object

Storage class for user preferences and environment settings.

This class does not use the Properties class because .properties files use ISO 8859-1 encoding, which is highly likely to be a problem when trying to save sketch folders and locations. Like the rest of Processing, we use UTF8.

We don't use the Java Preferences API because it would entail writing to the registry (on Windows), or an obscure file location (on Mac OS X) and make it far more difficult (impossible) to remove the preferences.txt to reset them (when they become corrupt), or to find the the file to make edits for numerous obscure preferences that are not part of the preferences window. If we added a generic editor (e.g. about:config in Mozilla) for such things, we could start using the Java Preferences API. But wow, that sounds like a lot of work. Not unlike writing this paragraph.

Constructor Summary

Constructors

Constructor and Description
Preferences()

Method Summary

Modifier and Type	Method and Description
static String	get(String attribute)
static boolean	getBoolean(String attribute)
static Color	getColor(String name)
static String	getDefault(String attribute)
static Font	getFont(String attr)
static int	getInteger(String attribute)
static String	getOldSketchbookPath()
static String	getPreferencesPath()
static String	getSketchbookPath()
static void	init()
static void	load(InputStream input) Load a set of key/value pairs from a UTF-8 encoded file into 'table'.
static void	save()
static void	set(String attribute, String value)
static void	setBoolean(String attribute, boolean value)
static void	setColor(String attr, Color what)
static void	setInteger(String key, int value)
static void	unset(String attribute)

Methods inherited from class Object

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

Constructor Detail

Preferences

public Preferences()

Method Detail

init

public static void init()

getPreferencesPath

public static String getPreferencesPath()

load

public static void load(InputStream input)
                 throws IOException

Load a set of key/value pairs from a UTF-8 encoded file into 'table'. For 3.0a6, this removes any platform-specific extensions from keys, so that we don't have platform-specific entries in a user's preferences.txt file, which would require all prefs to be changed twice, or risk being overwritten by the unchanged platform-specific version on reload.

Throws:

IOException

save

public static void save()

get

public static String get(String attribute)

getDefault

public static String getDefault(String attribute)

set

public static void set(String attribute,
                       String value)

unset

public static void unset(String attribute)

getBoolean

public static boolean getBoolean(String attribute)

setBoolean

public static void setBoolean(String attribute,
                              boolean value)

getInteger

public static int getInteger(String attribute)

setInteger

public static void setInteger(String key,
                              int value)

getColor

public static Color getColor(String name)

setColor

public static void setColor(String attr,
                            Color what)

getFont

public static Font getFont(String attr)

getOldSketchbookPath

public static String getOldSketchbookPath()

getSketchbookPath

public static String getSketchbookPath()