gui
Class SimulatorFrame

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Window
                    |
                    +--java.awt.Frame
                          |
                          +--javax.swing.JFrame
                                |
                                +--gui.SimulatorFrame

All Implemented Interfaces:

javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, javax.swing.RootPaneContainer, java.io.Serializable, javax.swing.WindowConstants

public class SimulatorFrame

extends javax.swing.JFrame

This class is a frame for the Simulator. It contains a map which is the JComponent in which agents are added to and moved around. This frame also contains menu items, and is the parent for a Tray JDialog object.

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class javax.swing.JFrame

javax.swing.JFrame.AccessibleJFrame

Nested classes inherited from class java.awt.Frame

java.awt.Frame.AccessibleAWTFrame

Nested classes inherited from class java.awt.Window

java.awt.Window.AccessibleAWTWindow

Nested classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

private javax.swing.JDialog	aboutDialog A dialog for an about window.
private gui.ChartComp	chart The JComponent which is an image of a map.
private controller.Controller	controller The controller which controls the simulation and this frame.
private javax.swing.JMenuBar	mnuBar
private javax.swing.JMenu	mnuEdit
private javax.swing.JMenu	mnuFile
private javax.swing.JMenu	mnuHelp
private javax.swing.JMenuItem	mnuItmAbout
private javax.swing.JMenuItem	mnuItmExit
private javax.swing.JMenuItem	mnuItmTray
private java.awt.ScrollPane	pane The scroll pane to put the ChartComp into.
private javax.swing.JDialog	quitDialog A dialog for an exit confirmation.

Fields inherited from class javax.swing.JFrame

accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from class java.awt.Window

Fields inherited from class java.awt.Container

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

SimulatorFrame(controller.Controller controller, gui.ChartComp chart)
This constructor initializes the frame by taking in the controller/owner of this frame, and the ChartComp to be added to this frame.

Method Summary

void	centerScreen(java.awt.Point pos) This method take the given Point and changes the scroll position of the ScrollPane inorder to make the given Point the center of the view.
void	changeChart(java.lang.String chartName) This method changes the map image/data which the ChartComp is currently displaying.
java.awt.ScrollPane	getChartPane() This method returns the ScrollPane kept inside this frame.
void	init() This method sets up the components for the frame, the menus, and the CompChart to dispaly the map.
void	mnuItmAbout_actionPerformed(java.awt.event.ActionEvent e) This method is the performs the action when the user selects About from this frame menu.
void	mnuItmExit_actionPerformed() This method is called to ask for exit confirmation.
void	mnuItmTray_actionPerformed(java.awt.event.ActionEvent e) This method is the performs the action when the user selects Tray from this frame menu.

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update

Methods inherited from class java.awt.Frame

addNotify, finalize, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setCursor, setExtendedState, setIconImage, setMaximizedBounds, setMenuBar, setResizable, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, hide, isActive, isFocusableWindow, isFocusCycleRoot, isFocused, isShowing, pack, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationRelativeTo, show, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isOpaque, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Detail

controller

private controller.Controller controller

The controller which controls the simulation and this frame.

chart

private gui.ChartComp chart

The JComponent which is an image of a map.

pane

private java.awt.ScrollPane pane

The scroll pane to put the ChartComp into.

aboutDialog

private javax.swing.JDialog aboutDialog

A dialog for an about window.

quitDialog

private javax.swing.JDialog quitDialog

A dialog for an exit confirmation.

mnuBar

private javax.swing.JMenuBar mnuBar

mnuFile

private javax.swing.JMenu mnuFile

mnuEdit

private javax.swing.JMenu mnuEdit

mnuHelp

private javax.swing.JMenu mnuHelp

mnuItmAbout

private javax.swing.JMenuItem mnuItmAbout

mnuItmExit

private javax.swing.JMenuItem mnuItmExit

mnuItmTray

private javax.swing.JMenuItem mnuItmTray

Constructor Detail

SimulatorFrame

public SimulatorFrame(controller.Controller controller,
                      gui.ChartComp chart)

This constructor initializes the frame by taking in the controller/owner of this frame, and the ChartComp to be added to this frame.

Parameters:

controller - The simulator controller.

chart - The map image panel to be displayed in frame.

Method Detail

init

public void init()

This method sets up the components for the frame, the menus, and the CompChart to dispaly the map.

mnuItmExit_actionPerformed

public void mnuItmExit_actionPerformed()

This method is called to ask for exit confirmation.

mnuItmAbout_actionPerformed

public void mnuItmAbout_actionPerformed(java.awt.event.ActionEvent e)

This method is the performs the action when the user selects About from this frame menu. A JDialog is built and shown on the screen.

Parameters:

e - The ActionEvent for the menu selection.

mnuItmTray_actionPerformed

public void mnuItmTray_actionPerformed(java.awt.event.ActionEvent e)

This method is the performs the action when the user selects Tray from this frame menu. It first checks to see if the Tray is alrady visible in the interface, and if not it creates a new Tray, by informing Controller.

Parameters:

e - The ActionEvent for the menu selection.

centerScreen

public void centerScreen(java.awt.Point pos)

This method take the given Point and changes the scroll position of the ScrollPane inorder to make the given Point the center of the view.

Parameters:

pos - The Point to be the new center of displayed chart.

changeChart

public void changeChart(java.lang.String chartName)

This method changes the map image/data which the ChartComp is currently displaying. The method mearly checks that the map data file exists, then call on ChartComp.

Parameters:

chartName - The chart filename to put into the ChartComp.

getChartPane

public java.awt.ScrollPane getChartPane()

This method returns the ScrollPane kept inside this frame. The main purpose is for the controller to get position information from it.

Returns:

ScrollPane The main scrollPane inside this frame.