alma::acs::logging::dialogs::main::LogToolBar Class Reference

Inheritance diagram for alma::acs::logging::dialogs::main::LogToolBar:

Collaboration diagram for alma::acs::logging::dialogs::main::LogToolBar:

Public Member Functions
	LogToolBar (LogTypeHelper initialLogLvl, LogTypeHelper intialDiscardLvl)
void	setEventHandler (ActionListener listener)
JComboBox	getDiscardLevelCB ()
JComboBox	getLogLevelCB ()
JButton	getClearLogsBtn ()
JButton	getPauseBtn ()
JButton	getFiltersBtn ()
JButton	getZoomBtn ()
boolean	clickPauseBtn ()
boolean	pause ()
boolean	unpause ()
void	setEnabled (boolean enabled)
boolean	isPaused ()
void	setZoomable (boolean zoomable)
Static Public Attributes
static final String	pauseStr = "<HTML><FONT size=-2>Pause</FONT>"
static final String	playStr = "<HTML><FONT size=-2>Play</FONT>"
Private Member Functions
void	setupToolBar ()
Private Attributes
JComboBox	logLevelCB
JComboBox	discardLevelCB
JButton	pauseBtn
boolean	pauseBtnPaused
ImageIcon	pauseIcon
ImageIcon	playIcon
JButton	clearLogsBtn
JButton	filtersBtn
JButton	zoomBtn
LogTypeHelper	initialDiscardLevel
LogTypeHelper	initialLogLevel

Detailed Description

The toolbar of the main window

Author:: acaproni

Constructor & Destructor Documentation

alma::acs::logging::dialogs::main::LogToolBar::LogToolBar	(	LogTypeHelper	initialLogLvl,
		LogTypeHelper	intialDiscardLvl
	)			`[inline]`

Constructor

Parameters:

	initialLogLvl	The initial log level to set in the CB
	intialDiscardLvl	The initial discard level to set in the COB

References initialDiscardLevel, initialLogLevel, and setupToolBar().

Member Function Documentation

boolean alma::acs::logging::dialogs::main::LogToolBar::clickPauseBtn ( ) [inline]

The pause has been pressed Change the test and icon in the button.

Returns:: true if the button is in pause

References getPauseBtn(), pauseBtnPaused, pauseIcon, pauseStr, playIcon, and playStr.

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

JButton alma::acs::logging::dialogs::main::LogToolBar::getClearLogsBtn ( ) [inline]

Returns:: The button to clear the logs

References clearLogsBtn.

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

JComboBox alma::acs::logging::dialogs::main::LogToolBar::getDiscardLevelCB ( ) [inline]

Returns:: The discard level CB

References discardLevelCB, and initialDiscardLevel.

Referenced by com::cosylab::logging::LoggingClient::EventHandler::actionPerformed(), com::cosylab::logging::LoggingClient::getDiscardLevel(), com::cosylab::logging::LoggingClient::getEngine(), setEnabled(), and setupToolBar().

JButton alma::acs::logging::dialogs::main::LogToolBar::getFiltersBtn ( ) [inline]

Returns:: The filter button

References filtersBtn.

Referenced by com::cosylab::logging::LoggingClient::EventHandler::actionPerformed(), com::cosylab::logging::LoggingClient::enableFiltersWidgets(), and setupToolBar().

JComboBox alma::acs::logging::dialogs::main::LogToolBar::getLogLevelCB ( ) [inline]

Returns:: The log level CB

References initialLogLevel, and logLevelCB.

Referenced by com::cosylab::logging::LoggingClient::EventHandler::actionPerformed(), com::cosylab::logging::LoggingClient::initialize(), setEnabled(), and setupToolBar().

JButton alma::acs::logging::dialogs::main::LogToolBar::getPauseBtn ( ) [inline]

Returns:: The pause button

References pauseBtn, pauseBtnPaused, pauseIcon, pauseStr, and playIcon.

Referenced by com::cosylab::logging::LoggingClient::EventHandler::actionPerformed(), clickPauseBtn(), pause(), setupToolBar(), and unpause().

JButton alma::acs::logging::dialogs::main::LogToolBar::getZoomBtn ( ) [inline]

Returns:: The zoom button

References zoomBtn.

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

boolean alma::acs::logging::dialogs::main::LogToolBar::isPaused ( ) [inline]

Returns:: true if the play/pause button is pressed

References pauseBtnPaused.

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

boolean alma::acs::logging::dialogs::main::LogToolBar::pause ( ) [inline]

Set the play/pause button in pause mode

Returns:: The status of the button previous of the command (true means pasused)

References getPauseBtn(), pauseBtnPaused, playIcon, and playStr.

Referenced by com::cosylab::logging::LoggingClient::pause().

void alma::acs::logging::dialogs::main::LogToolBar::setEnabled ( boolean enabled ) [inline]

Enable/Disable all the control in the GUI than can cause the invalidation of the logs

Parameters:

enabled

If true the controls are enabled

References clearLogsBtn, filtersBtn, getDiscardLevelCB(), getLogLevelCB(), and pauseBtn.

Referenced by com::cosylab::logging::LoggingClient::errorAcknowledged(), com::cosylab::logging::LoggingClient::setEnabled(), and com::cosylab::logging::LoggingClient::showErrorMessage().

void alma::acs::logging::dialogs::main::LogToolBar::setEventHandler ( ActionListener listener ) [inline]

Set the event handler for the widgets in the toolbar

Parameters:

listener

The action listener

References clearLogsBtn, discardLevelCB, filtersBtn, logLevelCB, pauseBtn, and zoomBtn.

Referenced by com::cosylab::logging::LoggingClient::initConnections().

void alma::acs::logging::dialogs::main::LogToolBar::setupToolBar ( ) [inline, private]

Builds the toolbar

References discardLevelCB, getClearLogsBtn(), getDiscardLevelCB(), getFiltersBtn(), getLogLevelCB(), getPauseBtn(), getZoomBtn(), logLevelCB, and pauseBtn.

Referenced by LogToolBar().

void alma::acs::logging::dialogs::main::LogToolBar::setZoomable ( boolean zoomable ) [inline]

Set the state of the zoom button

Parameters:

zoomable If true the zoom button is enabled.

References zoomBtn.

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

boolean alma::acs::logging::dialogs::main::LogToolBar::unpause ( ) [inline]

Unpause the play/pause button

Returns:: The status of the button previous of the command (true means pasused)

References getPauseBtn(), pauseBtnPaused, pauseIcon, and pauseStr.

Referenced by com::cosylab::logging::LoggingClient::resume().

Member Data Documentation

JButton alma::acs::logging::dialogs::main::LogToolBar::clearLogsBtn [private]

The button to delete the logs

Referenced by getClearLogsBtn(), setEnabled(), and setEventHandler().

JComboBox alma::acs::logging::dialogs::main::LogToolBar::discardLevelCB [private]

The ComboBox with the discard level in the toolbar (the logs with a level lower then what is shown in this ComboBox are discarded when read from the NC)

Referenced by getDiscardLevelCB(), setEventHandler(), and setupToolBar().

JButton alma::acs::logging::dialogs::main::LogToolBar::filtersBtn [private]

The button to manage filters

Referenced by getFiltersBtn(), setEnabled(), and setEventHandler().

LogTypeHelper alma::acs::logging::dialogs::main::LogToolBar::initialDiscardLevel [private]

The initial discard level

Referenced by getDiscardLevelCB(), and LogToolBar().

LogTypeHelper alma::acs::logging::dialogs::main::LogToolBar::initialLogLevel [private]

The initial log level

Referenced by getLogLevelCB(), and LogToolBar().

JComboBox alma::acs::logging::dialogs::main::LogToolBar::logLevelCB [private]

The ComboBox in the toolbar and its default value (i.e. the log level at startup