com.bankframe.fe.ui
Class EPanelContainer

java.lang.Object
  com.bankframe.fe.ui.EPanelContainer

All Implemented Interfaces:

java.awt.event.ActionListener, java.util.EventListener, java.awt.event.KeyListener

Direct Known Subclasses:

SamplePanelContainer, SamplePanelContainer

public abstract class EPanelContainer

extends java.lang.Object

implements java.awt.event.ActionListener, java.awt.event.KeyListener

This class is an abstract class that must be implemented by applications. It provides the top-level container for a BankFrame application. It can load panel drivers depending on a setting in the BankframeFrontendApplication.properties file.

Author:

Stephen J Ryan, Trevor Young

Field Summary

static java.lang.String	COMMS_MANAGER
static java.lang.String	DEFAULT_PANEL (In a future release, the Panel Drivers will be able to dynamically load, meaning that the app.
static java.lang.String	DEFAULT_ROLE
static java.lang.String	FRONTEND_BUNDLE
static java.lang.String	LOAD_DYNAMICALLY
static java.lang.String	MENU_PANEL
static java.lang.String	NUMBER_MENUS

Constructor Summary

EPanelContainer()
The EPanelContainer Constructor.

EPanelContainer(EApplet eApplet)
The class constructor.

When the constructor is called the following is done:
the icons are loaded using the eApplet.loadIcons() method.

EPanelContainer(EApplet eApplet, ECommsManager comms)
Deprecated. as this class uses the new channel management and gets it settings from the BankFrameResource.properties file. Use EPanelContainer(EApplet) instead

Method Summary

void	actionPerformed(java.awt.event.ActionEvent evt) This method handles action events fired from the menu panel.
void	close() This method closes the application by called the close method in the eApplet class.
void	displayDefault() This method is used to display the default panel.
void	displayErrorMessage(java.lang.String msg) This method is used to display an error message to the screen.
void	displayPanel(java.lang.String panelName) This method is used to display an EPanel.
ECommsManager	getCommsMgr() This method returns an instance of the comms manager that this class uses
java.util.ResourceBundle	getFrontendBundle() Deprecated. Use getFrontEndResource() instead
DataPacket	getMessageBuffer() This method gets the messageBuffer DataPacket object.
java.lang.String	getRole() This method returns the role with which the application is being run under.
abstract void	handleInitialData(java.lang.String[] initData) This method is implemented by subclasses to handle initial data.
void	keyPressed(java.awt.event.KeyEvent evt) This method handles keyEvents when a key is pressed.
void	keyReleased(java.awt.event.KeyEvent evt) This method is required by the KeyListener interface.
void	keyTyped(java.awt.event.KeyEvent evt) This method is required by the KeyListener interface.
java.lang.Object	loadClass(java.lang.String className) This method is used to load classes dynamically.
java.util.Vector	sendCommsMessage(DataPacket data) This method send DataPacket to the server using the comms manager.
java.util.Vector	sendCommsMessage(java.util.Vector data) This method sends DataPackets to the server using the comms manager.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PANEL

public static final java.lang.String DEFAULT_PANEL

(In a future release, the Panel Drivers will be able to dynamically load, meaning that the app. server is contacted to determine what panel drivers should be loaded dependent on the application setting and the user's logon role.)

See Also:

Constant Field Values

FRONTEND_BUNDLE

public static final java.lang.String FRONTEND_BUNDLE

See Also:

Constant Field Values

LOAD_DYNAMICALLY

public static final java.lang.String LOAD_DYNAMICALLY

See Also:

Constant Field Values

DEFAULT_ROLE

public static final java.lang.String DEFAULT_ROLE

See Also:

Constant Field Values

NUMBER_MENUS

public static final java.lang.String NUMBER_MENUS

See Also:

Constant Field Values

MENU_PANEL

public static final java.lang.String MENU_PANEL

See Also:

Constant Field Values

COMMS_MANAGER

public static final java.lang.String COMMS_MANAGER

See Also:

Constant Field Values

Constructor Detail

EPanelContainer

public EPanelContainer()

The EPanelContainer Constructor.

EPanelContainer

public EPanelContainer(EApplet eApplet)

The class constructor.

When the constructor is called the following is done:

the icons are loaded using the eApplet.loadIcons() method.

the BankframeFrontend.properties bundle is loaded.

the process managers for the application are loaded.

the defaultPanel & menuPanels are loaded.

the contentPane of the eApplet is set-up.

the menu used by the application to access the processes is created and registered to.

the default menu is displayed.

the initial data is set.

Parameters:

eApplet - EApplet

EPanelContainer

public EPanelContainer(EApplet eApplet,
                       ECommsManager comms)

Deprecated. as this class uses the new channel management and gets it settings from the BankFrameResource.properties file. Use EPanelContainer(EApplet) instead

The class constructor.

When the constructor is called the following is done:

the icons are loaded using the eApplet.loadIcons() method.

the BankframeFrontend.properties bundle is loaded.

the process managers for the application are loaded.

the defaultPanel & menuPanels are loaded.

the contentPane of the eApplet is set-up.

the menu used by the application to access the processes is created and registered to.

the default menu is displayed.

the initial data is set.

Parameters:

eApplet - EApplet

comms - ECommsManager

Method Detail

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent evt)

This method handles action events fired from the menu panel.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Parameters:

evt - the ActionEvent that occured

close

public void close()

This method closes the application by called the close method in the eApplet class.

displayDefault

public void displayDefault()

This method is used to display the default panel.

displayErrorMessage

public void displayErrorMessage(java.lang.String msg)

This method is used to display an error message to the screen.

Parameters:

msg - the error message

displayPanel

public void displayPanel(java.lang.String panelName)

This method is used to display an EPanel.

Parameters:

panelName - the name of the EPanel to display

getCommsMgr

public ECommsManager getCommsMgr()

This method returns an instance of the comms manager that this class uses

Returns:

an instance of the comms manager

getFrontendBundle

public java.util.ResourceBundle getFrontendBundle()

Deprecated. Use getFrontEndResource() instead

This method gets the front end resource bundle

Returns:

the reosurce bundle

getMessageBuffer

public DataPacket getMessageBuffer()

This method gets the messageBuffer DataPacket object.

Returns:

the message buffer as a DataPacket

getRole

public java.lang.String getRole()

This method returns the role with which the application is being run under.

Returns:

the role of the application

handleInitialData

public abstract void handleInitialData(java.lang.String[] initData)

This method is implemented by subclasses to handle initial data.

Parameters:

initData - The data to handle

keyPressed

public void keyPressed(java.awt.event.KeyEvent evt)

This method handles keyEvents when a key is pressed. It is used if numberMenus are used and can display the selected component based on the number entered.

Specified by:

keyPressed in interface java.awt.event.KeyListener

Parameters:

evt - a the KeyEvent that has been generated

keyReleased

public void keyReleased(java.awt.event.KeyEvent evt)

This method is required by the KeyListener interface.

Specified by:

keyReleased in interface java.awt.event.KeyListener

keyTyped

public void keyTyped(java.awt.event.KeyEvent evt)

This method is required by the KeyListener interface.

Specified by:

keyTyped in interface java.awt.event.KeyListener

loadClass

public java.lang.Object loadClass(java.lang.String className)
                           throws UserInterfaceException

This method is used to load classes dynamically.

Parameters:

className - the name of the class

Returns:

the class created from className

Throws:

FrontendException - if the class cannot be instantiated.

UserInterfaceException

sendCommsMessage

public java.util.Vector sendCommsMessage(DataPacket data)

This method send DataPacket to the server using the comms manager.

Parameters:

data - the request DataPacket

Returns:

a vector containing the server response

sendCommsMessage

public java.util.Vector sendCommsMessage(java.util.Vector data)

This method sends DataPackets to the server using the comms manager.

Parameters:

data - a vector of request DataPackets

Returns:

a vector of response DataPackets