nz.org.venice.prefs.settings
Class AbstractSettings

java.lang.Object
  nz.org.venice.prefs.settings.AbstractSettings

All Implemented Interfaces:

Settings

Direct Known Subclasses:

AnalyserModuleSettings, AnalyserResultSettings, ChartModuleSettings, GraphSettings, HelpModuleSettings, ModuleFrameSettings, PortfolioModuleSettings, PreferencesModuleSettings, QuoteModuleSettings, TransactionModuleSettings, WatchScreenSettings

public abstract class AbstractSettings
extends java.lang.Object
implements Settings

This class can save the toplevel Module data which is common to all modules.

Author:

Mark Hummel

See Also:

Settings, SettingsWriter

Field Summary

Fields inherited from interface nz.org.venice.prefs.settings.Settings

ANALYSER, ANNMODULE, ANNRESULTS, CHART, CHARTMODULE, FRAME, GAMODULE, GARESULTS, GPMODULE, GPRESULTS, GRAPHS, HELP, HELPMODULE, MODULE, PAPERTRADEMODULE, PAPERTRADERESULTS, PORTFOLIO, PORTFOLIOMODULE, PREFERENCES, PREFERENCESMODULE, PREFS, QUOTEMODULE, ROOTMODULE, TABLE, TRANSACTIONMODULE, WATCHSCREENMODULE

Constructor Summary

AbstractSettings(int group, int type)

AbstractSettings(int group, int type, java.lang.String key)

Method Summary

int	getGroup() Return the Module group as defined by the Settings constants
java.lang.String	getKey() Return the module identifier
Module	getModule(javax.swing.JDesktopPane desktop) Return a Module based on the settings.
java.lang.String	getTitle() Get the title of the module
int	getType() Return the module type as defined by the Setting constants.
void	setGroup(int group) Set the Module group as defined by the Settings constants
void	setKey(java.lang.String key) Set the module identifier.
void	setTitle(java.lang.String title) Set the title of the Module.
void	setType(int type) Set the module type.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractSettings

public AbstractSettings(int group,
                        int type)

AbstractSettings

public AbstractSettings(int group,
                        int type,
                        java.lang.String key)

Method Detail

setTitle

public void setTitle(java.lang.String title)

Set the title of the Module.

Specified by:

setTitle in interface Settings

Parameters:

title - The module title

getTitle

public java.lang.String getTitle()

Get the title of the module

Specified by:

getTitle in interface Settings

Returns:

The module title

getType

public int getType()

Description copied from interface: Settings

Return the module type as defined by the Setting constants.

Specified by:

getType in interface Settings

Returns:

The module type

getGroup

public int getGroup()

Description copied from interface: Settings

Return the Module group as defined by the Settings constants

Specified by:

getGroup in interface Settings

Returns:

The module group

setGroup

public void setGroup(int group)

Description copied from interface: Settings

Set the Module group as defined by the Settings constants

Specified by:

setGroup in interface Settings

Parameters:

group - The module group

setType

public void setType(int type)

Description copied from interface: Settings

Set the module type.

Specified by:

setType in interface Settings

Parameters:

type - a type constant

setKey

public void setKey(java.lang.String key)

Description copied from interface: Settings

Set the module identifier.

Specified by:

setKey in interface Settings

Parameters:

key - The module identifier

getKey

public java.lang.String getKey()

Description copied from interface: Settings

Return the module identifier

Specified by:

getKey in interface Settings

Returns:

The module identifier

getModule

public Module getModule(javax.swing.JDesktopPane desktop)

Description copied from interface: Settings

Return a Module based on the settings.

Specified by:

getModule in interface Settings

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object