ca.uwaterloo.epad.util

Class Settings

java.lang.Object

ca.uwaterloo.epad.util.Settings

public class Settings
extends java.lang.Object

This class contains all of the settings and parameters used by ePad application and it can retrieve them dynamically from a XML file.

Version:

1.0

Author:

Dmitry Pyryeskin

Field Summary

Fields

Modifier and Type	Field and Description
static int	brushPromptDelay Delay until the setup prompt for the brush drawer is displayed (in milliseconds).
static java.lang.String	chimeFile Path to the sound file with the chime sound.
static java.lang.String	colouringFolder Location of the folder that contains the colouring pages.
static java.lang.String	dataFolder Location of the main data folder.
static java.lang.String	defaultLayoutFile Location of the default workspace layout file.
static int	drawerAutoClosingSpeed The rate at which a drawer should be closed automatically (in pixels per frame).
static int	engagementPromptDelay How long can the application be inactive until the first engagement prompt is displayed (in milliseconds).
static int	engagementPromptRepeatDelay How long can the application be inactive until the following engagement prompt is displayed (in milliseconds).
static int	fileBrowserColumns The number of columns of items in a file browser dialog.
static int	fileBrowserRows The number of rows of items in a file browser dialog.
static java.lang.String	guiFile Location of the default GUI layout file.
static int	height Height of the application.
static java.util.Locale	locale Locale of the application, used to select an appropriate resource bundle.
static int	paintPromptDelay Delay until the setup prompt for the paint drawer is displayed (in milliseconds).
static int	promptTTL How long should a prompt remain on the screen (in milliseconds).
static int	resetDelay How long should the reset prompt wait until resetting the application automatically (in milliseconds).
static int	resetPromptDelay How long can the application be inactive until the reset prompt is displayed (in milliseconds).
static int	rotatingContainerOffsetAngle The angle between neighbouring items in a rotating container.
static int	rotatingContainerOffsetDistance The distance between circles of items in a rotating container.
static java.lang.String	saveFolder Location of the save file folder.
static boolean	showDebugInfo Flag indicating whether or not the debug information should be displayed on the screen.
static boolean	showPrintDialog Flag indicating whether or not a dialog should be displayed when attempting to print a painting.
static float	targetFPS Target number of frames per second.
static java.lang.String	touchSourse Source of the touch events.
static boolean	TTSEnabled Flag indicating whether or not the Text-To-Speech system should be enabled.
static float	TTSSpeechRate The rate of speech of the TTS system.
static java.lang.String	TTSVoice The TTS voice to use.
static int	width Width of the application.

Constructor Summary

Constructors

Constructor and Description
Settings()

Method Summary

Methods

Modifier and Type	Method and Description
static void	unmarshallSettings(java.lang.String filename) Retrieve the settings from the provided XML file.

Methods inherited from class java.lang.Object

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

Field Detail

locale

public static java.util.Locale locale

Locale of the application, used to select an appropriate resource bundle.

width

public static int width

Width of the application.

height

public static int height

Height of the application.

targetFPS

public static float targetFPS

Target number of frames per second.

touchSourse

public static java.lang.String touchSourse

Source of the touch events. This may be one of the following: TUIO_DEVICE, MOUSE, WM_TOUCH, ANDROID or SMART.

showPrintDialog

public static boolean showPrintDialog

Flag indicating whether or not a dialog should be displayed when attempting to print a painting.

dataFolder

public static java.lang.String dataFolder

Location of the main data folder.

saveFolder

public static java.lang.String saveFolder

Location of the save file folder.

colouringFolder

public static java.lang.String colouringFolder

Location of the folder that contains the colouring pages.

guiFile

public static java.lang.String guiFile

Location of the default GUI layout file.

defaultLayoutFile

public static java.lang.String defaultLayoutFile

Location of the default workspace layout file.

TTSEnabled

public static boolean TTSEnabled

Flag indicating whether or not the Text-To-Speech system should be enabled.

TTSVoice

public static java.lang.String TTSVoice

The TTS voice to use.

TTSSpeechRate

public static float TTSSpeechRate

The rate of speech of the TTS system.

chimeFile

public static java.lang.String chimeFile

Path to the sound file with the chime sound.

drawerAutoClosingSpeed

public static int drawerAutoClosingSpeed

The rate at which a drawer should be closed automatically (in pixels per frame).

rotatingContainerOffsetAngle

public static int rotatingContainerOffsetAngle

The angle between neighbouring items in a rotating container. Should be increased for the screens with smaller resolution.

rotatingContainerOffsetDistance

public static int rotatingContainerOffsetDistance

The distance between circles of items in a rotating container. Should be decreased for the screens with smaller resolution.

fileBrowserColumns

public static int fileBrowserColumns

The number of columns of items in a file browser dialog.

fileBrowserRows

public static int fileBrowserRows

The number of rows of items in a file browser dialog.

showDebugInfo

public static boolean showDebugInfo

Flag indicating whether or not the debug information should be displayed on the screen.

promptTTL

public static int promptTTL

How long should a prompt remain on the screen (in milliseconds).

brushPromptDelay

public static int brushPromptDelay

Delay until the setup prompt for the brush drawer is displayed (in milliseconds).

paintPromptDelay

public static int paintPromptDelay

Delay until the setup prompt for the paint drawer is displayed (in milliseconds).

engagementPromptDelay

public static int engagementPromptDelay

How long can the application be inactive until the first engagement prompt is displayed (in milliseconds).

engagementPromptRepeatDelay

public static int engagementPromptRepeatDelay

How long can the application be inactive until the following engagement prompt is displayed (in milliseconds).

resetPromptDelay

public static int resetPromptDelay

How long can the application be inactive until the reset prompt is displayed (in milliseconds).

resetDelay

public static int resetDelay

How long should the reset prompt wait until resetting the application automatically (in milliseconds).

Constructor Detail

Settings

public Settings()

Method Detail

unmarshallSettings

public static void unmarshallSettings(java.lang.String filename)
                               throws javax.xml.transform.TransformerFactoryConfigurationError,
                                      javax.xml.transform.TransformerException,
                                      java.lang.IllegalArgumentException,
                                      java.lang.IllegalAccessException

Retrieve the settings from the provided XML file.

Parameters:

filename - valid path to the XML file with the settings.

Throws:

javax.xml.transform.TransformerFactoryConfigurationError

javax.xml.transform.TransformerException

java.lang.IllegalArgumentException

java.lang.IllegalAccessException