alma::acs::logging::preferences::ExpertPrefsDlg Class Reference

Inheritance diagram for alma::acs::logging::preferences::ExpertPrefsDlg:

Collaboration diagram for alma::acs::logging::preferences::ExpertPrefsDlg:

Classes
class	PassVerifier
Public Types
enum	NumberOption { UNLIMITED = ("Unlimited",0), K100 = ("100K",100000), K200 = ("200K",200000), K300 = ("300K",300000), K400 = ("400K",400000), K500 = ("500K",500000) }
enum	TimeOption { UNLIMITED = ("Unlimited",0), H1 = ("1h",60), H3 = ("3h",180), H5 = ("5h",300), H12 = ("12h",720), D1 = ("1d",1440) }
enum	OptionWidgets { MAX_NUM_OF_LOGS = ("Max num. of logs:",null), TIME_FRAME = ("Time frame:",null), MAX_INPUT_RATE, MAX_OUTPUT_RATE, DYNAMIC_DISCARD_LEVEL }
Public Member Functions
	ExpertPrefsDlg (Component owner, UserPreferences prefs)
void	actionPerformed (ActionEvent e)
boolean	okPressed ()
UserPreferences	getPreferences ()
void	setVisible (boolean visible)
Private Member Functions
void	initGUI ()
void	buildWidgets ()
void	ratioWidgets ()
void	enableOption (JCheckBox cB)
Private Attributes
UserPreferences	preferences
UserPreferences	originalPreferences
JButton	okBtn
JButton	cancelBtn
JButton	restoreBtn
boolean	okBtnPressed = false
Component	owner
JComboBox	maxLogsInTableCB = new JComboBox(NumberOption.values())
JComboBox	timeFrameCB = new JComboBox(TimeOption.values())
JTextField	inputRateTF = new JTextField("0",8)
JTextField	outputRateTF = new JTextField("0",8)
JTextField	dynThresholdTF = new JTextField("0",6)
JTextField	dynDampingTF = new JTextField("0",6)
JTextField	dynIntervalTF = new JTextField("0",6)

Detailed Description

A dialog to setup (expert) preferences.

Author:: acaproni

Member Enumeration Documentation

enum alma::acs::logging::preferences::ExpertPrefsDlg::NumberOption

A class containing the options for the number of logs.

Each option is a couple <label, value> where

value is the value of the option
label is a label to show to the user for that option

Enumerator:

UNLIMITED
K100
K200
K300
K400
K500

enum alma::acs::logging::preferences::ExpertPrefsDlg::OptionWidgets

OptionWidgets is essentially used to access the check boxes with a meaningful name.

Author:: acaproni

Enumerator:

MAX_NUM_OF_LOGS
TIME_FRAME
MAX_INPUT_RATE
MAX_OUTPUT_RATE
DYNAMIC_DISCARD_LEVEL

enum alma::acs::logging::preferences::ExpertPrefsDlg::TimeOption

A class containing the options for the time frame of logs

Each option is a couple <label, value> where

value is the value of the option
label is a label to show to the user for that option

Enumerator:

UNLIMITED
H1
H3
H5
H12
D1

Constructor & Destructor Documentation

alma::acs::logging::preferences::ExpertPrefsDlg::ExpertPrefsDlg	(	Component	owner,
		UserPreferences	prefs
	)			`[inline]`

Constructor

Parameters:

	owner	The owner of the dialog
	initialNumOfLogs	The initial value for the num of logs
	initialTimeFrame	The initial value for the time frame (minutes)

References buildWidgets(), alma::acs::logging::preferences::UserPreferences::clone(), alma::acs::logging::preferences::UserPreferences::getMaxInputRate(), alma::acs::logging::preferences::UserPreferences::getMaxNumOfLogs(), alma::acs::logging::preferences::UserPreferences::getMaxOutputRate(), alma::acs::logging::preferences::UserPreferences::getMinuteTimeFrame(), initGUI(), originalPreferences, preferences, ratioWidgets(), and setVisible().

Member Function Documentation

void alma::acs::logging::preferences::ExpertPrefsDlg::actionPerformed ( ActionEvent e ) [inline]

See also:: java.awt.event.ActionListener; java.awt.event.ActionEvent

References cancelBtn, alma::acs::logging::preferences::UserPreferences::clone(), enableOption(), okBtn, okBtnPressed, originalPreferences, preferences, ratioWidgets(), restoreBtn, and setVisible().

void alma::acs::logging::preferences::ExpertPrefsDlg::buildWidgets ( ) [inline, private]

Build the widgets shown in the dialog

References dynDampingTF, dynIntervalTF, dynThresholdTF, inputRateTF, maxLogsInTableCB, outputRateTF, and timeFrameCB.

Referenced by ExpertPrefsDlg().

void alma::acs::logging::preferences::ExpertPrefsDlg::enableOption ( JCheckBox cB ) [inline, private]

Enable or disable the option of the given check box.

Parameters:

cB

The chackbox the enable/disable the option

References dynDampingTF, dynIntervalTF, dynThresholdTF, inputRateTF, maxLogsInTableCB, outputRateTF, and timeFrameCB.

Referenced by actionPerformed(), and ratioWidgets().

UserPreferences alma::acs::logging::preferences::ExpertPrefsDlg::getPreferences ( ) [inline]

Return the user preferences defined in the dialog.

Returns:: The user preferences defined in the dialog.

See also:: preferences

References dynDampingTF, dynIntervalTF, dynThresholdTF, inputRateTF, maxLogsInTableCB, outputRateTF, preferences, alma::acs::logging::preferences::UserPreferences::setDynDamping(), alma::acs::logging::preferences::UserPreferences::setDynThreshold(), alma::acs::logging::preferences::UserPreferences::setDynTime(), alma::acs::logging::preferences::UserPreferences::setMaxInputRate(), alma::acs::logging::preferences::UserPreferences::setMaxLogs(), alma::acs::logging::preferences::UserPreferences::setMaxOutputRate(), alma::acs::logging::preferences::UserPreferences::setTimeFrame(), and timeFrameCB.

Referenced by com::cosylab::logging::LoggingClient::EventHandler::actionPerformed().

void alma::acs::logging::preferences::ExpertPrefsDlg::initGUI ( ) [inline, private]

Builds the GUI

DISABLED

References cancelBtn, dynDampingTF, dynIntervalTF, dynThresholdTF, inputRateTF, maxLogsInTableCB, okBtn, outputRateTF, restoreBtn, and timeFrameCB.

Referenced by ExpertPrefsDlg().

boolean alma::acs::logging::preferences::ExpertPrefsDlg::okPressed ( ) [inline]

Return true if the user pressed the Ok button to approve the changes

References okBtnPressed.

Referenced by com::cosylab::logging::LoggingClient::EventHandler::actionPerformed().

void alma::acs::logging::preferences::ExpertPrefsDlg::ratioWidgets ( ) [inline, private]

Ratio the content of the widgets getting their values from preferences.

Parameters:

	numbOfLogs	The number of logs
	timeFrame	The number of minutes of the time frame

See also:: prefrences

References dynDampingTF, dynIntervalTF, dynThresholdTF, enableOption(), alma::acs::logging::preferences::UserPreferences::getDynThreshold(), alma::acs::logging::preferences::UserPreferences::getMaxInputRate(), alma::acs::logging::preferences::UserPreferences::getMaxNumOfLogs(), alma::acs::logging::preferences::UserPreferences::getMaxOutputRate(), alma::acs::logging::preferences::UserPreferences::getMinuteTimeFrame(), inputRateTF, maxLogsInTableCB, outputRateTF, preferences, and timeFrameCB.

Referenced by actionPerformed(), and ExpertPrefsDlg().

void alma::acs::logging::preferences::ExpertPrefsDlg::setVisible ( boolean visible ) [inline]

Override JDialog.setVisible to show this dialog over the LogsingClient component.

References owner.

Referenced by actionPerformed(), and ExpertPrefsDlg().

Member Data Documentation

JButton alma::acs::logging::preferences::ExpertPrefsDlg::cancelBtn [private]

Referenced by actionPerformed(), and initGUI().

JTextField alma::acs::logging::preferences::ExpertPrefsDlg::dynDampingTF = new JTextField("0",6) [private]

The damping factor for the dynamic discarding of logs

Referenced by buildWidgets(), enableOption(), getPreferences(), initGUI(), and ratioWidgets().

JTextField alma::acs::logging::preferences::ExpertPrefsDlg::dynIntervalTF = new JTextField("0",6) [private]

The time interval for the dynamic discarding of logs

Referenced by buildWidgets(), enableOption(), getPreferences(), initGUI(), and ratioWidgets().

JTextField alma::acs::logging::preferences::ExpertPrefsDlg::dynThresholdTF = new JTextField("0",6) [private]

The threshold for the dynamic discarding of logs

Referenced by buildWidgets(), enableOption(), getPreferences(), initGUI(), and ratioWidgets().

JTextField alma::acs::logging::preferences::ExpertPrefsDlg::inputRateTF = new JTextField("0",8) [private]

The rate of logs from the NC

Referenced by buildWidgets(), enableOption(), getPreferences(), initGUI(), and ratioWidgets().

JComboBox alma::acs::logging::preferences::ExpertPrefsDlg::maxLogsInTableCB = new JComboBox(NumberOption.values()) [private]

The max number of logs in table

Referenced by buildWidgets(), enableOption(), getPreferences(), initGUI(), and ratioWidgets().

JButton alma::acs::logging::preferences::ExpertPrefsDlg::okBtn [private]

Referenced by actionPerformed(), and initGUI().

boolean alma::acs::logging::preferences::ExpertPrefsDlg::okBtnPressed = false [private]

Say if the user pressed the OK or the Cancel button

Referenced by actionPerformed(), and okPressed().

UserPreferences alma::acs::logging::preferences::ExpertPrefsDlg::originalPreferences [private]

The preferences received in the constructor and used to reset.

Referenced by actionPerformed(), and ExpertPrefsDlg().

JTextField alma::acs::logging::preferences::ExpertPrefsDlg::outputRateTF = new JTextField("0",8) [private]

The rate of logs into the table

Referenced by buildWidgets(), enableOption(), getPreferences(), initGUI(), and ratioWidgets().

Component alma::acs::logging::preferences::ExpertPrefsDlg::owner [private]

The component to show this dialog over

Referenced by setVisible().

UserPreferences alma::acs::logging::preferences::ExpertPrefsDlg::preferences [private]

The preferences shown and changed by this panel

This is a copy of the object received in the constructor.
In this implementation this property is filled with the values from the GUI by getPreferences()