com.tplan.robot.preferences

Class UserConfiguration

java.lang.Object

com.tplan.robot.preferences.AbstractUserConfiguration

com.tplan.robot.preferences.UserConfiguration

All Implemented Interfaces:

PropertyChangeListener, EventListener

Direct Known Subclasses:

PreferenceContainer

public class UserConfiguration
extends AbstractUserConfiguration
implements PropertyChangeListener

A container for user preferences. Defines variables which affect the behavior of T-Plan Robot Enterprise and can be set by user.

Apart from get- and set- methods inherited from the base class, the configuration allows to save a Color instance or even an array of colors. Each color is converted to a vector of numbers where there are three integer numbers representing Red, Green and Blue portions as provided by the Color's RGB model. The vector of numbers is then saved using the setListOfNumbers() method which converts the vector of numbers into a String.

If a component depends on any option value in this class, it should register itself using the method addConfigurationListener() and it will be notified about any changes in the configuration.

T-Plan Robot Enterprise, (C) 2009-2022 T-Plan Limited. All rights reserved.

Field Summary

Fields

Modifier and Type	Field and Description
static String	WATCH_DOG_LIST_KEY

Method Summary

Modifier and Type	Method and Description
Boolean	checkSecurity()
static UserConfiguration	getCopy() Get a shared instance of this configuration.
static UserConfiguration	getDefaultConfiguration() Get a copy of the default configuration.
String	getDefaultValue(String key) Get default value for the given parameter
Color[]	getDefaultValueAsArrayOfColors(String key) Get default value of a parameter as an array of Color instances.
Color	getDefaultValueAsColor(String key) Get default value of a parameter as a Color instance.
Double	getDefaultValueAsDouble(String key) Get default value of a parameter as an Integer.
List	getDefaultValueAsListOfNumbers(String key) Get default value of a parameter as a vector of numbers.
static UserConfiguration	getInstance() Get a shared instance of this configuration.
KeyStroke	getKeyStroke(String parameterName, boolean fixForMacIfNeeded) Get the value as a key stroke.
Map<String,String>	getOverrideTable()
List<String>	getPreferenceNames()
Object	getRawValue(String key) Get the raw value stored in the internal map for the given key.
static void	load(InputStream inStream) Load the configuration from an input stream.
static void	loadDefaults(InputStream inStream) Load the default configuration from an input stream.
void	propertyChange(PropertyChangeEvent evt)
void	putRawValues(Map values)
void	remove(String configKey)
static void	resetToDefaults()
static void	save(OutputStream outStream) Save the configuration into an output stream.
static void	saveConfiguration()
void	setColors(String parameterName, Color[] colors) Save an array of colors to the configuration.
void	setOverrideTable(Map overrideTable)
void	startWatchDog()
void	updateListOfRecents(String newItem, String configKey, int sizeLimit)
void	updateListOfRecents(String newItem, String configKey, int sizeLimit, boolean caseSensitive) This method will try to load a vector of strings using the given key.If the vector already contains the new item, it gets moved to the first position.

Methods inherited from class com.tplan.robot.preferences.AbstractUserConfiguration

addConfigurationListener, addConfigurationListener, convertToListOfNumbers, fireConfigurationChanged, getArrayOfBytes, getArrayOfInts, getBoolean, getBooleanStrict, getColor, getColors, getDouble, getDoubleStrict, getInteger, getIntegerStrict, getListOfNumbers, getListOfStrings, getString, isModified, removeConfigurationListener, setBoolean, setDouble, setHTMLColor, setHTMLColorArray, setInteger, setListOfNumbers, setListOfObjects, setString

Methods inherited from class java.lang.Object

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

Field Detail

WATCH_DOG_LIST_KEY

public static final String WATCH_DOG_LIST_KEY

See Also:

Constant Field Values

Method Detail

startWatchDog

public void startWatchDog()

getInstance

public static UserConfiguration getInstance()

Get a shared instance of this configuration.

Returns:

a UserConfiguration instance.

getCopy

public static UserConfiguration getCopy()

Get a shared instance of this configuration.

Returns:

a UserConfiguration instance.

getDefaultConfiguration

public static UserConfiguration getDefaultConfiguration()

Get a copy of the default configuration.

Returns:

an copy of the default user configuration loaded from the internal configuration template.

resetToDefaults

public static void resetToDefaults()

load

public static void load(InputStream inStream)
                 throws IOException

Load the configuration from an input stream.

Parameters:

inStream - an input stream to load from.

Throws:

IOException - when in I/O error occurs, e.g. cannot read from file etc.

loadDefaults

public static void loadDefaults(InputStream inStream)
                         throws IOException

Load the default configuration from an input stream.

Parameters:

inStream - an input stream to load from.

Throws:

IOException - when in I/O error occurs, e.g. cannot read from file etc.

save

public static void save(OutputStream outStream)
                 throws IOException

Save the configuration into an output stream.

Parameters:

outStream - an output stream to save to.

Throws:

IOException - when in I/O error occurs, e.g. cannot write to a file etc.

saveConfiguration

public static void saveConfiguration()

checkSecurity

public final Boolean checkSecurity()

getDefaultValue

public String getDefaultValue(String key)

Get default value for the given parameter

Parameters:

key - parameter name

Returns:

default value or null when there's none

getDefaultValueAsDouble

public Double getDefaultValueAsDouble(String key)

Get default value of a parameter as an Integer.

Parameters:

key - parameter name

Returns:

default value or null when there's none

getDefaultValueAsListOfNumbers

public List getDefaultValueAsListOfNumbers(String key)

Get default value of a parameter as a vector of numbers.

Parameters:

key - parameter name

Returns:

default value or null when there's none

getDefaultValueAsArrayOfColors

public Color[] getDefaultValueAsArrayOfColors(String key)

Get default value of a parameter as an array of Color instances.

Parameters:

key - parameter name

Returns:

default value or null when there's none

getDefaultValueAsColor

public Color getDefaultValueAsColor(String key)

Get default value of a parameter as a Color instance.

Parameters:

key - parameter name

Returns:

default value or null when there's none

setColors

public void setColors(String parameterName,
                      Color[] colors)

Save an array of colors to the configuration. Each color is converted to a vector of numbers where there are three integer numbers representing Red, Green and Blue portions as defined by the Color's RGB model. The vector of numbers is then saved using the setListOfNumbers() method which converts the vector of numbers into a String.

Parameters:

parameterName - parameter name.

colors - an array of Color instances.

updateListOfRecents

public void updateListOfRecents(String newItem,
                                String configKey,
                                int sizeLimit,
                                boolean caseSensitive)

This method will try to load a vector of strings using the given key.If the vector already contains the new item, it gets moved to the first position. Otherwise it is inserted into the first position.

If you need to keep the vector up to a certain size long, you may use the third argument to specify max vector size. A negative number disables this feature.

This method is used by dynamic menus that list e.g. recently open documents. Whenever a document is opened, it needs to be placed into the first position in the list. Such a list is usually of limited size, it e.g. lists just five most recently opened documents.

Parameters:

newItem - a new item. If it already exists in the vector, it will be just moved.

configKey - a key identifying the configuration vector.

sizeLimit - maximum size of the vector. If the vector exceeds this size, it will be trimmed to the required size. Any negative number disables this feature.

caseSensitive - true to apply case sensitive approach when checking if the item is already in the list.

updateListOfRecents

public void updateListOfRecents(String newItem,
                                String configKey,
                                int sizeLimit)

getOverrideTable

public Map<String,String> getOverrideTable()

setOverrideTable

public void setOverrideTable(Map overrideTable)

putRawValues

public void putRawValues(Map values)

remove

public void remove(String configKey)

getPreferenceNames

public List<String> getPreferenceNames()

propertyChange

public final void propertyChange(PropertyChangeEvent evt)

Specified by:

propertyChange in interface PropertyChangeListener

getRawValue

public Object getRawValue(String key)

Get the raw value stored in the internal map for the given key. As this class maintains all the values as String instances it always returns a string. Subclasses such as SimplePreferenceContainer may return something else.

Parameters:

key - a key.

Returns:

the raw unformatted value as it is stored in the internal map.

Since:

3.1.2/3.2

getKeyStroke

public KeyStroke getKeyStroke(String parameterName,
                              boolean fixForMacIfNeeded)

Get the value as a key stroke.

Parameters:

parameterName - the parameter name.

fixForMacIfNeeded - if the value is the default one and the local OS is Mac the method will fix the key stroke to meet the Mac guidelines (Ctrl is converted to Command, Alt to Ctrl).

Returns:

the key stroke.

Since:

4.1.4