org.kepler.util

Class StaticResources

java.lang.Object

org.kepler.util.StaticResources

Direct Known Subclasses:

StaticGUIResources

public class StaticResources
extends java.lang.Object

Static resources for accessing ResourceBundles.

Since:

Ptolemy II 7.1

Author:

Matthew Brooke

Pt.AcceptedRating:

Pt.ProposedRating:

Field Summary

Fields

Modifier and Type	Field and Description
protected static boolean	_isDebugging Set to true and recompile for debugging such as error messages.
static java.lang.String	RESOURCEBUNDLE_DIR

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StaticResources()

Method Summary

Modifier and Type	Method and Description
protected static int	_getInt(java.lang.String propertyKey, ConfigurationProperty property) Get the integer (int) property denoted by the propertyKey.
protected static java.lang.String	_getString(java.lang.String propertyKey, ConfigurationProperty property) Get the String property denoted by the propertyKey.
static boolean	getBoolean(java.lang.String key, boolean defaultVal) Search the uiDisplayText resourcebundle for the property specified by the key parameter.
static java.lang.String	getDisplayString(java.lang.String key, java.lang.String defaultString) Search the uiDisplayText resourcebundle for the property specified by the key parameter.
static ConfigurationProperty	getDisplayTextProperty() Search for the ResourceBundle containing the UI Display Text.
static java.lang.String	getSettingsString(java.lang.String key, java.lang.String defaultString) Search the uiSettings resourcebundle for the property specified by the key parameter.
static int	getSize(java.lang.String sizeKey, int defaultSize) Search the uiSettings resourcebundle for the size property specified by the sizeKey.
static ConfigurationProperty	getUISettingsProperty() Search for the ResourceBundle containing the ui settings.
static ConfigurationProperty	getUiSVGIconMappingsByClass() get the configuration property for the svg icon class mappings
static ConfigurationProperty	getUiSVGIconMappingsByLSID() get the configuraiton property for the svg icon lsid mappings
static java.lang.String	getValueFromName(ConfigurationProperty prop, java.lang.String name) get the value of a property based on the name

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCEBUNDLE_DIR

public static final java.lang.String RESOURCEBUNDLE_DIR

See Also:

Constant Field Values

_isDebugging

protected static final boolean _isDebugging

Set to true and recompile for debugging such as error messages.

See Also:

Constant Field Values

Constructor Detail

StaticResources

protected StaticResources()

Method Detail

getBoolean

public static boolean getBoolean(java.lang.String key,
                                 boolean defaultVal)

Search the uiDisplayText resourcebundle for the property specified by the key parameter. Return the boolean value of the property String corresponding to the specified key. If the property is not found, the defaultVal parameter is returned.

Parameters:

key - the properties key identifying the value to be found

defaultVal - - the default boolean value to be returned if the requested property cannot be found or read

Returns:

boolean value of the property String corresponding to the specified key. If the property is not found, the defaultVal parameter is returned.

getDisplayString

public static java.lang.String getDisplayString(java.lang.String key,
                                                java.lang.String defaultString)

Search the uiDisplayText resourcebundle for the property specified by the key parameter. Return the String value of the property value specified. If the property is not found, the default defaultString parameter is returned.

Parameters:

key - the properties key for the String to be found

defaultString - - the default String to be returned if the property cannot be found or read

Returns:

String value associated with the specified key, or the defaultString parameter if the property is not found.

getDisplayTextProperty

public static ConfigurationProperty getDisplayTextProperty()
                                                    throws java.io.IOException

Search for the ResourceBundle containing the UI Display Text.

Returns:

The resource bundle that corresponds with #UI_DISPLAY_TEXT_BUNDLE

Throws:

java.io.IOException - If the bundle that corresponds with #UI_DISPLAY_TEXT_BUNDLE cannot be loaded.

getSettingsString

public static java.lang.String getSettingsString(java.lang.String key,
                                                 java.lang.String defaultString)

Search the uiSettings resourcebundle for the property specified by the key parameter. Return the String value of the property value specified. If the property is not found, the default defaultString parameter is returned.

Parameters:

key - the properties key for the String to be found

defaultString - - the default String to be returned if the property cannot be found or read

Returns:

String value associated with the specified key, or the defaultString parameter if the property is not found.

getSize

public static int getSize(java.lang.String sizeKey,
                          int defaultSize)

Search the uiSettings resourcebundle for the size property specified by the sizeKey. Return the integer (int) value of the size specified. If the property is not found, the defaultSize parameter is returned.

Parameters:

sizeKey - the properties key String for the size setting

defaultSize - - the default size to be used if the property cannot be found

Returns:

integer (int) value of the size specified. If the property is not found, the defaultSize parameter is returned.

getUISettingsProperty

public static ConfigurationProperty getUISettingsProperty()
                                                   throws java.io.IOException

Search for the ResourceBundle containing the ui settings.

Returns:

The resource bundle that corresponds with #UI_SETTINGS_BUNDLE

Throws:

java.io.IOException - If the bundle that corresponds with #UI_SETTINGS_BUNDLE cannot be loaded.

getUiSVGIconMappingsByClass

public static ConfigurationProperty getUiSVGIconMappingsByClass()

get the configuration property for the svg icon class mappings

getUiSVGIconMappingsByLSID

public static ConfigurationProperty getUiSVGIconMappingsByLSID()

get the configuraiton property for the svg icon lsid mappings

getValueFromName

public static java.lang.String getValueFromName(ConfigurationProperty prop,
                                                java.lang.String name)

get the value of a property based on the name

_getString

protected static java.lang.String _getString(java.lang.String propertyKey,
                                             ConfigurationProperty property)
                                      throws java.lang.Exception

Get the String property denoted by the propertyKey.

Parameters:

propertyKey - the properties key String identifying the property

property - the ConfigurationProperty in which to search

Returns:

the String value identified by the propertyKey

Throws:

java.lang.Exception - if key is not found or cannot be read

_getInt

protected static int _getInt(java.lang.String propertyKey,
                             ConfigurationProperty property)
                      throws java.lang.Exception

Get the integer (int) property denoted by the propertyKey.

Parameters:

propertyKey - the properties key String identifying the property

property - the ConfigurationProperty in which to search

Returns:

the int value identified by the propertyKey

Throws:

java.lang.Exception - if key is not found, cannot be read, or cannot be parsed as an integer