com.altair.hwm.toolkit.preferences
Class HWMTplPreferences

java.lang.Object
  com.altair.hwm.toolkit.preferences.HWMTplPreferences

public class HWMTplPreferences
extends java.lang.Object

Title: HWMTplPreferences

Description:

Company: Altair Engineering, Inc.

Field Summary

static java.lang.String	ABOUT_IMAGE
static java.lang.String	ABOUT_STYLE
static java.lang.String	ABOUT_TEXT
static java.lang.String	ALLOW_OVERRIDE_POSITION The key for the allow override position pref.
static java.lang.String	ALLOW_OVERRIDE_SIZE The key for the allow override size pref.
static java.lang.String	APP_TYPE The key for the type of pmt i.e.
static java.lang.String	HDM_ENABLED Key for HDM enabled mode.
static java.lang.String	ICON_FILE The key for the icon file pref.
static java.lang.String	IMAGE_ONLY_ABOUT
static java.lang.String	IMAGE_ONLY_SPLASH
static java.lang.String	NO_PMI_NEW_DIALOG A flag that enables easy creation of instances
static java.lang.String	SHOW_WORKFLOW The key for the show workflow pref.
static java.lang.String	SPLASH_FILE The key for the splash image pref.
static java.lang.String	SPLASH_STYLE The key for the splash style.
static java.lang.String	SPLASH_TEXT The key for the splash text pref.
static java.lang.String	TEMPLATE_TITLE The key for the template title pref.
static java.lang.String	TEXT_AND_IMAGE_ABOUT
static java.lang.String	TEXT_AND_IMAGE_SPLASH
static java.lang.String	TEXT_ONLY_ABOUT
static java.lang.String	TEXT_ONLY_SPLASH
static java.lang.String	TPL_PREF_VERSION The version.
static java.lang.String	USER_EXIT The key for exit function class
static java.lang.String	WINDOW_BOUNDS The key for the window position and size pref.

Constructor Summary

HWMTplPreferences()
Constructor.

Method Summary

java.lang.Object	GetPreference(java.lang.String szPrefKey) Retrieves a preference value.
void	Load(java.io.ObjectInputStream streamIn) Loads the preferences
void	PutAll(java.util.Map mapPrefs) Puts an entire mapping of prefs
void	PutPreference(java.lang.String szPrefKey, java.lang.Object objPrefValue) Stores a template preference value.
java.lang.Object	RemovePreference(java.lang.String szPrefKey) Removes a pref value
void	Save(java.io.ObjectOutputStream streamOut) Saves the preference keys and values

Methods inherited from class java.lang.Object

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

Field Detail

TPL_PREF_VERSION

public static final java.lang.String TPL_PREF_VERSION

The version.

See Also:

Constant Field Values

ICON_FILE

public static final java.lang.String ICON_FILE

The key for the icon file pref. The value should be a String.

See Also:

Constant Field Values

USER_EXIT

public static final java.lang.String USER_EXIT

The key for exit function class

See Also:

Constant Field Values

TEMPLATE_TITLE

public static final java.lang.String TEMPLATE_TITLE

The key for the template title pref. The value should be a String

See Also:

Constant Field Values

SPLASH_FILE

public static final java.lang.String SPLASH_FILE

The key for the splash image pref. The value should be a String.

See Also:

Constant Field Values

SPLASH_TEXT

public static final java.lang.String SPLASH_TEXT

The key for the splash text pref. The value should be a string

See Also:

Constant Field Values

SPLASH_STYLE

public static final java.lang.String SPLASH_STYLE

The key for the splash style. The value should be one of the style constants in this class.

See Also:

Constant Field Values

ABOUT_IMAGE

public static final java.lang.String ABOUT_IMAGE

See Also:

Constant Field Values

ABOUT_TEXT

public static final java.lang.String ABOUT_TEXT

See Also:

Constant Field Values

ABOUT_STYLE

public static final java.lang.String ABOUT_STYLE

See Also:

Constant Field Values

WINDOW_BOUNDS

public static final java.lang.String WINDOW_BOUNDS

The key for the window position and size pref. The value should be a Rectangle.

See Also:

Constant Field Values

SHOW_WORKFLOW

public static final java.lang.String SHOW_WORKFLOW

The key for the show workflow pref. The value should be a Boolean.

See Also:

Constant Field Values

APP_TYPE

public static final java.lang.String APP_TYPE

The key for the type of pmt i.e. APP mode or TODO mode. The value should be a Boolean.

See Also:

Constant Field Values

HDM_ENABLED

public static final java.lang.String HDM_ENABLED

Key for HDM enabled mode. The value should be a Boolean

See Also:

Constant Field Values

NO_PMI_NEW_DIALOG

public static final java.lang.String NO_PMI_NEW_DIALOG

A flag that enables easy creation of instances

See Also:

Constant Field Values

ALLOW_OVERRIDE_POSITION

public static final java.lang.String ALLOW_OVERRIDE_POSITION

The key for the allow override position pref. The value should be a Boolean.

See Also:

Constant Field Values

ALLOW_OVERRIDE_SIZE

public static final java.lang.String ALLOW_OVERRIDE_SIZE

The key for the allow override size pref. The value should be a Boolean.

See Also:

Constant Field Values

TEXT_AND_IMAGE_SPLASH

public static final java.lang.String TEXT_AND_IMAGE_SPLASH

See Also:

Constant Field Values

TEXT_ONLY_SPLASH

public static final java.lang.String TEXT_ONLY_SPLASH

See Also:

Constant Field Values

IMAGE_ONLY_SPLASH

public static final java.lang.String IMAGE_ONLY_SPLASH

See Also:

Constant Field Values

TEXT_AND_IMAGE_ABOUT

public static final java.lang.String TEXT_AND_IMAGE_ABOUT

See Also:

Constant Field Values

TEXT_ONLY_ABOUT

public static final java.lang.String TEXT_ONLY_ABOUT

See Also:

Constant Field Values

IMAGE_ONLY_ABOUT

public static final java.lang.String IMAGE_ONLY_ABOUT

See Also:

Constant Field Values

Constructor Detail

HWMTplPreferences

public HWMTplPreferences()

Constructor.

Method Detail

PutPreference

public void PutPreference(java.lang.String szPrefKey,
                          java.lang.Object objPrefValue)

Stores a template preference value.

Parameters:

szPrefKey - The key to store the preference under

objPrefValue - The value of the preference

GetPreference

public java.lang.Object GetPreference(java.lang.String szPrefKey)

Retrieves a preference value. Will return null if value not set.

Parameters:

szPrefKey - The key of the preference

Returns:

Object The pref value

RemovePreference

public java.lang.Object RemovePreference(java.lang.String szPrefKey)

Removes a pref value

Parameters:

objPrefKey - The key of the value to remove

Returns:

Object The object the was removed

PutAll

public void PutAll(java.util.Map mapPrefs)

Puts an entire mapping of prefs

Save

public void Save(java.io.ObjectOutputStream streamOut)
          throws java.lang.Exception

Saves the preference keys and values

Parameters:

streamOut - The output stream to file.

Throws:

java.lang.Exception

Load

public void Load(java.io.ObjectInputStream streamIn)
          throws java.lang.Exception

Loads the preferences

Parameters:

streamIn - The input stream

Throws:

java.lang.Exception