charger.prefs

Class PreferencesWriter

Object

charger.prefs.PreferencesWriter

public class PreferencesWriter
extends Object

Handles the formatting and output of preferences to a configuration file. Preferences are saved in a form suitable to be read by a standard Java Properties class. They are read in to the Global class all in one go, and thence accessed by the Global setup() to initialize most of the global constants.

Author:

Harry S. Delugach (delugach@uah.edu)

Field Summary

Fields

Modifier and Type	Field and Description
(package private) ActorsPrefPanel	actors
(package private) AppearancePrefPanel	appearance
(package private) CompatibilityPrefPanel	compat
(package private) ConfigurationPrefPanel	configPanel

Constructor Summary

Constructors

Constructor and Description
PreferencesWriter(AppearancePrefPanel appearance, CompatibilityPrefPanel compat, ActorsPrefPanel actors, ConfigurationPrefPanel configPanel)

Method Summary

Modifier and Type	Method and Description
protected String	booleanPrefToString(String name, boolean value, String help) Format the given setting as a string, for output to the preferences file.
String	colorPrefToString(String classname, String foreback) Given a class name and whether text or fill, creates the preferences file entry for it.
protected String	doublePrefToString(String name, double value, String help) Format the given setting as a string, for output to the preferences file.
String	fileToString(String filename) Handles occurrence of backslash in Windows filenames, replacing them with forward slashes in writing.
protected String	floatPrefToString(String name, float value, String help) Format the given setting as a string, for output to the preferences file.
protected String	intPrefToString(String name, int value, String help) Format the given setting as a string, for output to the preferences file.
protected String	prefsToString() When creating a new Preference, the following places need to be changed: the Preferences class (and window) need to have some sort of control for the preference charger.Global (or other appropriate class) needs to have a "global" with the preference current value (and default value) getPrefsAsString needs to have an entry for the preference methods need to be provided in this class to handle changes to the Hub's value
void	savePreferences(String prefsFilename) Saves the global preferences to the global preference file.
protected String	StringPrefToString(String name, String value, String help) Format the given setting as a string, for output to the preferences file.
String	textAndFillDefaultToString(String classname) Given a class name, return two text lines conveying the class's default color scheme suitable for writing to a preferences file.

Methods inherited from class Object

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

Field Detail

appearance

AppearancePrefPanel appearance

compat

CompatibilityPrefPanel compat

actors

ActorsPrefPanel actors

configPanel

ConfigurationPrefPanel configPanel

Constructor Detail

PreferencesWriter

public PreferencesWriter(AppearancePrefPanel appearance,
                         CompatibilityPrefPanel compat,
                         ActorsPrefPanel actors,
                         ConfigurationPrefPanel configPanel)

Method Detail

intPrefToString

protected String intPrefToString(String name,
                                 int value,
                                 String help)

Format the given setting as a string, for output to the preferences file.

Parameters:

name - the key in the Prefs property list

value - an integer value

help - a descriptive string (e.g., one obtained from a tool tip)

Returns:

string formatted for a property list file

floatPrefToString

protected String floatPrefToString(String name,
                                   float value,
                                   String help)

Format the given setting as a string, for output to the preferences file.

Parameters:

name - the key in the Prefs property list

value - a float value

help - a descriptive string (e.g., one obtained from a tool tip)

Returns:

string formatted for a property list file

doublePrefToString

protected String doublePrefToString(String name,
                                    double value,
                                    String help)

Format the given setting as a string, for output to the preferences file.

Parameters:

name - the key in the Prefs property list

value - a double value

help - a descriptive string (e.g., one obtained from a tool tip)

Returns:

string formatted for a property list file

StringPrefToString

protected String StringPrefToString(String name,
                                    String value,
                                    String help)

Format the given setting as a string, for output to the preferences file.

Parameters:

name - the key in the Prefs property list

value - a string value

help - a descriptive string (e.g., one obtained from a tool tip)

Returns:

string formatted for a property list file

booleanPrefToString

protected String booleanPrefToString(String name,
                                     boolean value,
                                     String help)

Format the given setting as a string, for output to the preferences file.

Parameters:

name - the key in the Prefs property list

value - a boolean value

help - a descriptive string (e.g., one obtained from a tool tip)

Returns:

string formatted for a property list file

textAndFillDefaultToString

public String textAndFillDefaultToString(String classname)

Given a class name, return two text lines conveying the class's default color scheme suitable for writing to a preferences file. First line is the text color, the second is the fill color.

Parameters:

classname - the (unqualified) class name (i.e., without package info)

fileToString

public String fileToString(String filename)

Handles occurrence of backslash in Windows filenames, replacing them with forward slashes in writing.

Parameters:

filename -

Returns:

if Windows, then replace backslashes with forward slashes, otherwise return original.

colorPrefToString

public String colorPrefToString(String classname,
                                String foreback)

Given a class name and whether text or fill, creates the preferences file entry for it. It returns a single line of the form:
defaultColor-classname-<text|fill<=R,G,B
e.g., defaultColor-Concept-text=255,255,255

savePreferences

public void savePreferences(String prefsFilename)
                     throws CGFileException

Saves the global preferences to the global preference file. If there are any plugins active, saves their preferences too.

Parameters:

prefsFilename -

Throws:

CGFileException

prefsToString

protected String prefsToString()

When creating a new Preference, the following places need to be changed:

• the Preferences class (and window) need to have some sort of control for the preference
• charger.Global (or other appropriate class) needs to have a "global" with the preference current value (and default value)
• getPrefsAsString needs to have an entry for the preference
• methods need to be provided in this class to handle changes to the Hub's value