Package adams.gui.core

Class GUIPrompt

java.lang.Object

adams.core.logging.LoggingObject

adams.gui.core.GUIPrompt

All Implemented Interfaces:

LoggingSupporter, SizeOfHandler, Serializable

public class GUIPrompt
extends LoggingObject

Helper class for GUI prompts that require updating values, e.g., only displaying a warning dialog once.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	FILENAME	the name of the props file.
protected Properties	m_Properties	the properties.
protected static GUIPrompt	m_Singleton	the singleton.

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GUIPrompt()	Initializes the class.

Method Summary

Modifier and Type	Method	Description
boolean	getBoolean(String key, boolean defValue)	Returns the stored value or, if not present, the default value.
Double	getDouble(String key, Double defValue)	Returns the stored value or, if not present, the default value.
Integer	getInteger(String key, Integer defValue)	Returns the stored value or, if not present, the default value.
static GUIPrompt	getSingleton()	Returns the singleton instance.
protected void	initialize()	Loads the properties.
void	setBoolean(String key, boolean value)	Sets the boolean value and stores the properties.
void	setDouble(String key, Double value)	Sets the Double value and stores the properties.
void	setInteger(String key, Integer value)	Sets the Integer value and stores the properties.
protected void	update()	Stores the properties on disk.

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Field Detail

FILENAME

public static final String FILENAME

the name of the props file.

See Also:

Constant Field Values

m_Properties

protected Properties m_Properties

the properties.

m_Singleton

protected static GUIPrompt m_Singleton

the singleton.

Constructor Detail

GUIPrompt

protected GUIPrompt()

Initializes the class.

Method Detail

initialize

protected void initialize()

Loads the properties.

update

protected void update()

Stores the properties on disk.

getBoolean

public boolean getBoolean(String key,
                          boolean defValue)

Returns the stored value or, if not present, the default value.

Parameters:

key - the property key to read the boolean from

defValue - the default value to use if absent

Returns:

the stored value or the default value (if absent)

setBoolean

public void setBoolean(String key,
                       boolean value)

Sets the boolean value and stores the properties.

Parameters:

key - the property to store the value under

value - the value to store

getInteger

public Integer getInteger(String key,
                          Integer defValue)

Returns the stored value or, if not present, the default value.

Parameters:

key - the property key to read the Integer from

defValue - the default value to use if absent

Returns:

the stored value or the default value (if absent)

setInteger

public void setInteger(String key,
                       Integer value)

Sets the Integer value and stores the properties.

Parameters:

key - the property to store the value under

value - the value to store

getDouble

public Double getDouble(String key,
                        Double defValue)

Returns the stored value or, if not present, the default value.

Parameters:

key - the property key to read the Double from

defValue - the default value to use if absent

Returns:

the stored value or the default value (if absent)

setDouble

public void setDouble(String key,
                      Double value)

Sets the Double value and stores the properties.

Parameters:

key - the property to store the value under

value - the value to store

getSingleton

public static GUIPrompt getSingleton()

Returns the singleton instance.

Returns:

the instance