alma::acs::gui::util::panel::Frame Class Reference

Inheritance diagram for alma::acs::gui::util::panel::Frame:

[legend]

Collaboration diagram for alma::acs::gui::util::panel::Frame:

[legend]

List of all members.

Classes
class	FrameWindowListener
Public Member Functions
	Frame (String[] params) throws PanelException
void	disconnectACSComponentClient ()
Static Public Member Functions
static void	printUsage (String cmd)
static void	main (String[] args)
Private Member Functions
void	initialize (IPanel pnl) throws PanelException
IPanel	loadPanel (String className) throws PanelException
void	connectACSComponentClient (String className) throws PanelException
void	close ()
Private Attributes
IPanel	panel
AdvancedComponentClient	client = null
Logger	logger = null
ContainerServices	contSvc = null
FrameWindowListener	windowListener = new FrameWindowListener()

---

Detailed Description

The main frame of the application. It is the main window showing the panel inside.

The panel must implement the IPanel interface and extend JComponent. It can also be a JRootPane in order to define its own menu bar.

Author:

acaproni

---

Constructor & Destructor Documentation

alma::acs::gui::util::panel::Frame::Frame

(

String[]

params

)

throws PanelException [inline]

Build the main window with the component inside.

The main window catches window events in order to be able to close the panel before closing.

Parameters:

params

A string of paramters. The first parameter is the component to show in the window.

References connectACSComponentClient(), contSvc, initialize(), loadPanel(), panel, alma::acs::gui::util::panel::IPanel::setACSContainerServices(), alma::acs::gui::util::panel::IPanel::start(), and windowListener.

Referenced by main().

---

Member Function Documentation

void alma::acs::gui::util::panel::Frame::close

(

)

[inline, private]

Release all the resources This is the last operation before closing

References disconnectACSComponentClient(), logger, panel, alma::acs::gui::util::panel::IPanel::stop(), and windowListener.

Referenced by alma::acs::gui::util::panel::Frame::FrameWindowListener::windowClosing().

void alma::acs::gui::util::panel::Frame::connectACSComponentClient

(

String

className

)

throws PanelException [inline, private]

Connect to ACS as component client. It connects the client and the logger.

Parameters:

className

The name of the class of the panel to show in the frame

Exceptions:

Exception

In case of failure connecting to ACS

References client, contSvc, alma::acs::component::client::ComponentClient::getContainerServices(), alma::acs::container::ContainerServicesBase::getLogger(), and logger.

Referenced by Frame().

void alma::acs::gui::util::panel::Frame::disconnectACSComponentClient

(

)

[inline]

Disconnect from ACS

References client, contSvc, logger, and alma::acs::component::client::ComponentClient::tearDown().

Referenced by close().

void alma::acs::gui::util::panel::Frame::initialize

(

IPanel

pnl

)

throws PanelException [inline, private]

Init the GUI

Parameters:

pnl

The IPanel to show in the GUI

Referenced by Frame().

IPanel alma::acs::gui::util::panel::Frame::loadPanel

(

String

className

)

throws PanelException [inline, private]

Load the panel whose class name is in the parameter

Parameters:

className

The class name of the poanel to be shown in the main window

Returns:

A reference to the panel

Referenced by Frame().

static void alma::acs::gui::util::panel::Frame::main

(

String[]

args

)

[inline, static]

The starting point of the application: build the window and load the panel.

Parameters:

args

A list of params. The first parameter is the name of the panel to load.

References Frame(), and printUsage().

static void alma::acs::gui::util::panel::Frame::printUsage

(

String

cmd

)

[inline, static]

Print the usage message on the stdout

Parameters:

cmd

The name of the command

Referenced by main().

---

Member Data Documentation

AdvancedComponentClient alma::acs::gui::util::panel::Frame::client = null [private]

Referenced by connectACSComponentClient(), disconnectACSComponentClient(), and alma::acs::gui::util::panel::Frame::FrameWindowListener::windowClosed().

ContainerServices alma::acs::gui::util::panel::Frame::contSvc = null [private]

Referenced by connectACSComponentClient(), disconnectACSComponentClient(), Frame(), and alma::acs::gui::util::panel::Frame::FrameWindowListener::windowClosed().

Logger alma::acs::gui::util::panel::Frame::logger = null [private]

Referenced by close(), connectACSComponentClient(), disconnectACSComponentClient(), and alma::acs::gui::util::panel::Frame::FrameWindowListener::windowClosed().

IPanel alma::acs::gui::util::panel::Frame::panel [private]

Referenced by close(), Frame(), and alma::acs::gui::util::panel::Frame::FrameWindowListener::windowClosed().

FrameWindowListener alma::acs::gui::util::panel::Frame::windowListener = new FrameWindowListener() [private]

Referenced by close(), Frame(), and alma::acs::gui::util::panel::Frame::FrameWindowListener::windowClosed().

---

The documentation for this class was generated from the following file:

• Frame.java