vooga.arcade
Interface IVoogaGUI

All Known Implementing Classes:

ChatTest, UserProfileTest, VoogaGUI

public interface IVoogaGUI

This interface has the methods that must be implemented by the Arcade/GUI in order to have the code appropriately linked.

Author:

Lindsay Kubasik, Ron Murhammer, Vijay Ram

Method Summary

void	addArcadeEventListener(IArcadeEventListener listener) This method is used to add a listener to all of the arcade's events.
int	createNewFrame(java.lang.String frameTitle) This method will open a new window with the given title and place the component in the center panel with the given tab title.
void	fireArcadeEvent(ArcadeEvent e) Allows others to fire an arcade event.
IArcadeFrame	getFrame(int ID) Get the ArcadeFrame given its ID.
void	hideArcade() This method is called to log a user out.
void	removeFrame(int ID) This method removes the frame with the given title.
void	showArcade(VoogaUser user) This method is called after a user is verified.
void	showErrorMessage(java.lang.String message) This method will show the error message in a popup box to the user.
java.lang.String	showInputDialog(java.lang.String message) This method will show a popup box where you can propt a user for input.
void	showMessage(java.lang.String message) This method will show the message in a popup box to the user.

Method Detail

addArcadeEventListener

void addArcadeEventListener(IArcadeEventListener listener)

This method is used to add a listener to all of the arcade's events. When the arcade fires an event, it will call all of its listeners and provide info about the event. Each listener then can determine what it needs to do by examining the info. An example of a listener can be seen in the ArcadeListener class which implements the IArcadeListener interface. It is used by the arcade to process the various events which it fires.

Parameters:

listener - is a listener which extends the IArcadeListener interface

showArcade

void showArcade(VoogaUser user)

This method is called after a user is verified. It shows the main arcade screen where users can select games and many other functions.

hideArcade

void hideArcade()

This method is called to log a user out. It hides the main arcade screen where users can select games and many other functions.

createNewFrame

int createNewFrame(java.lang.String frameTitle)

This method will open a new window with the given title and place the component in the center panel with the given tab title.

Returns:

the frame's ID so that it can be used to communicate with the created frame

getFrame

IArcadeFrame getFrame(int ID)

Get the ArcadeFrame given its ID.

removeFrame

void removeFrame(int ID)

This method removes the frame with the given title.

showMessage

void showMessage(java.lang.String message)

This method will show the message in a popup box to the user.

Parameters:

message -

showErrorMessage

void showErrorMessage(java.lang.String message)

This method will show the error message in a popup box to the user.

Parameters:

message -

showInputDialog

java.lang.String showInputDialog(java.lang.String message)

This method will show a popup box where you can propt a user for input.

Parameters:

message -

Returns:

fireArcadeEvent

void fireArcadeEvent(ArcadeEvent e)

Allows others to fire an arcade event.

Parameters:

e -