Class GlobalPrefs

java.lang.Object

VASSAL.preferences.Prefs

VASSAL.preferences.GlobalPrefs

All Implemented Interfaces:

Closeable, AutoCloseable

public class GlobalPrefs
extends Prefs

A set of global preferences shared by all modules. This superclass exists primarily to make sure that the Global Preferences file gets written whenever a preference setting is changed.

Field Summary

Fields inherited from class Prefs

BAD_DATA_AUDIT_TRAILS, DISABLE_D3D, DISABLE_OGL_FBO, MAIN_WINDOW_HEIGHT, MAIN_WINDOW_REMEMBER, MAIN_WINDOW_WIDTH, MODULES_DIR_KEY, OVERRIDE_DEFAULT_FONT_SIZE, TRANSLATABLE_SUPPORT

Modifier and Type	Field	Description
static final String	BAD_DATA_AUDIT_TRAILS
static final String	DISABLE_D3D
static final String	DISABLE_OGL_FBO
static final String	MAIN_WINDOW_HEIGHT
static final String	MAIN_WINDOW_REMEMBER
static final String	MAIN_WINDOW_WIDTH
static final String	MODULES_DIR_KEY	Preferences key for the directory containing modules
static final String	OVERRIDE_DEFAULT_FONT_SIZE
static final String	TRANSLATABLE_SUPPORT

Constructor Summary

Constructors

Constructor	Description
GlobalPrefs(PrefsEditor editor, File file)
GlobalPrefs(PrefsEditor editor, String name)

Method Summary

Modifier and Type	Method	Description
void	addOption(String category, Configurer o, String prompt)	Adds the preference, and adds a listener for property changes, so that global preference file will be automatically written after any change.
boolean	isDisableAutoWrite()
void	saveGlobal()	Save the global preferences
void	setDisableAutoWrite(boolean b)

Methods inherited from class Prefs

addOption, addOption, close, getEditor, getFile, getGlobalPrefs, getOption, getStoredValue, getValue, initSharedGlobalPrefs, read, sanitize, save, setValue, write

Modifier and Type	Method	Description
void	addOption(String category, Configurer o)
void	addOption(Configurer o)
void	close()
PrefsEditor	getEditor()
File	getFile()
static Prefs	getGlobalPrefs()	A global set of preferences that exists independent of any individual module.
Configurer	getOption(String s)
String	getStoredValue(String key)	Return the value of a given preference.
Object	getValue(String key)
static void	initSharedGlobalPrefs()	Initialize visible Global Preferences that are shared between the Module Manager and the Editor/Player.
protected void	read()
static String	sanitize(String str)
void	save()	Store this set of preferences
void	setValue(String option, Object value)
void	write()	Deprecated, for removal: This API element is subject to removal in a future version.

Methods inherited from class Object

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

Constructor Details

GlobalPrefs

public GlobalPrefs(PrefsEditor editor,
 String name)

GlobalPrefs

public GlobalPrefs(PrefsEditor editor,
 File file)

Method Details

isDisableAutoWrite

public boolean isDisableAutoWrite()

Overrides:

isDisableAutoWrite in class Prefs

Returns:

true if our auto-write function has been temporarily disabled.

setDisableAutoWrite

public void setDisableAutoWrite(boolean b)

Overrides:

setDisableAutoWrite in class Prefs

Parameters:

b - true if auto-write function should be temporarily disabled; false to re-enable it.

saveGlobal

public void saveGlobal()

Save the global preferences

addOption

public void addOption(String category,
 Configurer o,
 String prompt)

Adds the preference, and adds a listener for property changes, so that global preference file will be automatically written after any change.

Overrides:

addOption in class Prefs

Parameters:

category - the tab under which to add the Configurer's controls in the editor window. If null, do not add controls.

o - Configurer for the preference

prompt - If non-null and the value was not read from the preferences file on initialization