game.gui
Class ClashWindow

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Window
                    |
                    +--java.awt.Frame
                          |
                          +--javax.swing.JFrame
                                |
                                +--game.gui.ClashWindow
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, javax.swing.RootPaneContainer, java.io.Serializable, javax.swing.WindowConstants

public class ClashWindow
extends javax.swing.JFrame

This is the main containing window, with the proper game controlling menu. It is also the only window to receive key events. All other frames are inner frames contained within this one.

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
(package private)  javax.swing.JMenuItem aboutItem
          About menu item.
(package private)  javax.swing.JMenu actionMenu
          Action menu needs to be accessible, it is set up by the Coordinator.
(package private)  javax.swing.JMenu fileMenu
          File menu needs to be accessible, it is set up by the Coordinator.
(package private)  javax.swing.JMenu helpMenu
          Help menu
(package private)  javax.swing.JMenu optionMenu
          Option menu needs to be accessible, it is set up by the Coordinator.
(package private)  javax.swing.JInternalFrame rulerFrame
          The ruler frame.
(package private)  javax.swing.JMenu viewMenu
          View menu needs to be accessible, it is set up by the Coordinator.
 
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
ClashWindow()
           
 
Method Summary
 void addToDesktop(javax.swing.JInternalFrame frame)
           
 void closeEvents()
          Close all frames with Events in their title.
protected  javax.swing.JMenuBar createMenuBar()
           
 boolean findFrame(java.lang.String title)
          If the specified frame is present, bring it to the front.
 javax.swing.JMenu getActionMenu()
           
 javax.swing.JDesktopPane getDesktop()
           
 javax.swing.JMenu getFileMenu()
           
 javax.swing.JMenu getHelpMenu()
           
static ClashWindow getInstance()
          Returns an instance of this class.
 javax.swing.JMenu getOptionMenu()
           
 javax.swing.JMenu getViewMenu()
           
 void hideRuler()
          Switch off ruler frame.
 void listEconOptions()
          Constructs the econ frame popup menu.
 void listEventOptions()
          Constructs the econ frame popup menu.
 void listFrames()
          List the open frames so one can be brought to the front.
 void selectFortType()
          Spawns a popup menu to select a String which is the name of the fortification type to be built.
static void setAllEcon(boolean value)
          Set the command line option to see all economies.
 void showFrame(javax.swing.JInternalFrame frame)
          Show a frame on top.
 void showRuler()
          Show ruler details.
 
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

fileMenu

javax.swing.JMenu fileMenu
File menu needs to be accessible, it is set up by the Coordinator.


viewMenu

javax.swing.JMenu viewMenu
View menu needs to be accessible, it is set up by the Coordinator.


actionMenu

javax.swing.JMenu actionMenu
Action menu needs to be accessible, it is set up by the Coordinator.


optionMenu

javax.swing.JMenu optionMenu
Option menu needs to be accessible, it is set up by the Coordinator.


helpMenu

javax.swing.JMenu helpMenu
Help menu


aboutItem

javax.swing.JMenuItem aboutItem
About menu item.


rulerFrame

javax.swing.JInternalFrame rulerFrame
The ruler frame.

Constructor Detail

ClashWindow

public ClashWindow()
Method Detail

getInstance

public static ClashWindow getInstance()
Returns an instance of this class.


setAllEcon

public static void setAllEcon(boolean value)
Set the command line option to see all economies.

Parameters:
value - the value to set.

createMenuBar

protected javax.swing.JMenuBar createMenuBar()

getFileMenu

public javax.swing.JMenu getFileMenu()

getViewMenu

public javax.swing.JMenu getViewMenu()

getActionMenu

public javax.swing.JMenu getActionMenu()

getOptionMenu

public javax.swing.JMenu getOptionMenu()

getHelpMenu

public javax.swing.JMenu getHelpMenu()

getDesktop

public javax.swing.JDesktopPane getDesktop()

addToDesktop

public void addToDesktop(javax.swing.JInternalFrame frame)

showRuler

public void showRuler()
Show ruler details.


showFrame

public void showFrame(javax.swing.JInternalFrame frame)
Show a frame on top.


hideRuler

public void hideRuler()
Switch off ruler frame.


listFrames

public void listFrames()
List the open frames so one can be brought to the front.


findFrame

public boolean findFrame(java.lang.String title)
If the specified frame is present, bring it to the front.

Parameters:
title - the title of the required frame.
Returns:
false if the frame is not present.

closeEvents

public void closeEvents()
Close all frames with Events in their title.


listEconOptions

public void listEconOptions()
Constructs the econ frame popup menu.


selectFortType

public void selectFortType()
Spawns a popup menu to select a String which is the name of the fortification type to be built.


listEventOptions

public void listEventOptions()
Constructs the econ frame popup menu.