org.trianacode.gui.help

Class TrianaHelpProperties

java.lang.Object

java.util.Dictionary<K,V>

java.util.Hashtable<java.lang.Object,java.lang.Object>

java.util.Properties

org.trianacode.gui.help.PropertiesEx

org.trianacode.gui.help.TrianaHelpProperties

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Object,java.lang.Object>

public class TrianaHelpProperties
extends PropertiesEx

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.Properties

defaults

Constructor Summary

Constructors

Constructor and Description
TrianaHelpProperties()

Method Summary

Methods

Modifier and Type	Method and Description
void	checkDirectory(java.lang.String path)
static java.lang.String	getHomeDirectory() Returns the applications getApplicationDataDir directory.
static java.lang.String	getSettingsDirectory()
static java.lang.String	getUserHomeDirectory() Get the user's getApplicationDataDir directory
static java.lang.String	getUserName() Get the user's name
void	loadUserSettings()
void	savePropertiesFile(java.lang.String path, java.lang.String file, java.lang.String header) Saves properties to a file.
void	saveUserSettings()

Methods inherited from class org.trianacode.gui.help.PropertiesEx

loadPropertiesFile, loadPropertiesFile, loadPropertiesFile, savePropertiesFile, savePropertiesFile, setProperty

Methods inherited from class java.util.Properties

getProperty, getProperty, list, list, load, load, loadFromXML, propertyNames, save, store, store, storeToXML, storeToXML, stringPropertyNames

Methods inherited from class java.util.Hashtable

clear, clone, contains, containsKey, containsValue, elements, entrySet, equals, get, hashCode, isEmpty, keys, keySet, put, putAll, rehash, remove, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TrianaHelpProperties

public TrianaHelpProperties()

Method Detail

getHomeDirectory

public static final java.lang.String getHomeDirectory()

Returns the applications getApplicationDataDir directory. If it is null it uses the value set in TrianaCalcDefaults.

getUserHomeDirectory

public static final java.lang.String getUserHomeDirectory()

Get the user's getApplicationDataDir directory

Returns:

The user's getApplicationDataDir directory as a String

getUserName

public static final java.lang.String getUserName()

Get the user's name

Returns:

The user name as a String

getSettingsDirectory

public static final java.lang.String getSettingsDirectory()

loadUserSettings

public void loadUserSettings()

saveUserSettings

public void saveUserSettings()

savePropertiesFile

public void savePropertiesFile(java.lang.String path,
                      java.lang.String file,
                      java.lang.String header)
                        throws java.io.IOException

Saves properties to a file.

Parameters:

path - The path of the file to save

file - The name of the file to save

header - A text comment which is used as a header in the file

Throws:

java.io.IOException

See Also:

PropertiesEx.savePropertiesFile(File, String), PropertiesEx.savePropertiesFile(String, String), Properties.save(java.io.OutputStream, java.lang.String)

checkDirectory

public void checkDirectory(java.lang.String path)