org.vizzini.ui.game.simulation
Class AbstractSimulationUISwing

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Panel
              java.applet.Applet
                  javax.swing.JApplet
                      org.vizzini.ui.AbstractApp
                          org.vizzini.ui.game.AbstractGameUISwing
                              org.vizzini.ui.game.simulation.AbstractSimulationUISwing

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, IConcedeListener, IGameListener, IStateListener, IGameUI, ISimulationUI, IOSXApp, IBusyListener, IListener

Direct Known Subclasses:

DefaultSimulationUISwing, GameUISwing

public abstract class AbstractSimulationUISwing
extends AbstractGameUISwing
implements ISimulationUI

Provides base functionality for a simulation game user interface using Swing.

Since:

v0.3

Version:

v0.3

Author:

Jeffrey M. Thompson

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JApplet

JApplet.AccessibleJApplet

Nested classes/interfaces inherited from class java.applet.Applet

Applet.AccessibleApplet

Nested classes/interfaces inherited from class java.awt.Panel

Panel.AccessibleAWTPanel

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JApplet

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

AbstractSimulationUISwing()

Method Summary

protected StatusBar	createStatusBar() Create the status bar.
protected void	fillAdditionalOptionsMenuItems(JMenu optionsMenu) Fill in additional options menu items.
protected void	fillAdditionalViewMenuItems(JMenu viewMenu) Fill in additional view menu items.
protected void	fillToolBar() Fill the tool bar.
protected Action	getPauseAction() Return the pause action.
protected boolean	isConcedeAvailable() Return true if the Concede action is available.
void	newActionPerformed(ActionEvent event) Callback for the new action.
void	pauseActionPerformed(ActionEvent event) Perform the pause action.
void	stateChange(StateEvent event) Respond to state events.
boolean	useToolBar() Return true if a tool bar is desired.

Methods inherited from class org.vizzini.ui.game.AbstractGameUISwing

assignAgentListener, assignAgentListeners, audioActionPerformed, busy, checkActions, checkForFileOverwrite, concede, concedeActionPerformed, fillAdditionalEditMenuItems, fillAdditionalFileMenuItems, fillAdditionalHelpMenuItems, fillAdditionalMenus, fillMenuBar, gameChange, getEnvironmentUI, getFileChooser, getGame, getGameUISupport, getProperties, getStatusManager, init, isAudioOn, openActionPerformed, removeAgentListener, removeAgentListeners, saveActionPerformed, saveAsActionPerformed, setAudioOn, showStatusBarActionPerformed, showToolBarActionPerformed, start, stop

Methods inherited from class org.vizzini.ui.AbstractApp

aboutActionPerformed, cleanup, doMain, getAppName, getFrame, getInitialDimension, getMenuBar, getMenuBarContainer, macOSXRegistration, onlineHelpActionPerformed, preferencesActionPerformed, quitActionPerformed, setCursorBusy, usePreferencesMenu, useSplashScreen

Methods inherited from class javax.swing.JApplet

addImpl, createRootPane, getAccessibleContext, getContentPane, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isRootPaneCheckingEnabled, paramString, remove, setContentPane, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update

Methods inherited from class java.applet.Applet

destroy, getAppletContext, getAppletInfo, getAudioClip, getAudioClip, getCodeBase, getDocumentBase, getImage, getImage, getLocale, getParameter, getParameterInfo, isActive, newAudioClip, play, play, resize, resize, setStub, showStatus

Methods inherited from class java.awt.Panel

addNotify

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getListeners, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, 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, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.vizzini.ui.game.IGameUI

getEnvironmentUI, getGame, init, start

Methods inherited from interface org.vizzini.game.event.IGameListener

gameChange

Methods inherited from interface org.vizzini.util.event.IBusyListener

busy

Methods inherited from interface org.vizzini.game.event.IConcedeListener

concede

Constructor Detail

AbstractSimulationUISwing

public AbstractSimulationUISwing()

Method Detail

newActionPerformed

public void newActionPerformed(ActionEvent event)

Callback for the new action.

Overrides:

newActionPerformed in class AbstractGameUISwing

Since:

v0.3

pauseActionPerformed

public void pauseActionPerformed(ActionEvent event)

Perform the pause action.

Since:

v0.1

stateChange

public void stateChange(StateEvent event)

Respond to state events. Extends the super method to update the simulation date time display.

Specified by:

stateChange in interface IStateListener

Overrides:

stateChange in class AbstractGameUISwing

Since:

v0.3

useToolBar

public boolean useToolBar()

Return true if a tool bar is desired.

Overrides:

useToolBar in class AbstractGameUISwing

Since:

v0.3

createStatusBar

protected StatusBar createStatusBar()

Create the status bar. Overrides the super method to provide a position for the simulation date time display.

Overrides:

createStatusBar in class AbstractGameUISwing

Since:

v0.3

fillAdditionalOptionsMenuItems

protected void fillAdditionalOptionsMenuItems(JMenu optionsMenu)

Fill in additional options menu items. These menu items are placed at the end of the menu.

Overrides:

fillAdditionalOptionsMenuItems in class AbstractGameUISwing

Parameters:

optionsMenu - Options menu.

Since:

v0.3

fillAdditionalViewMenuItems

protected void fillAdditionalViewMenuItems(JMenu viewMenu)

Fill in additional view menu items. These menu items are placed below the Show Status Bar menu item.

Overrides:

fillAdditionalViewMenuItems in class AbstractGameUISwing

Parameters:

viewMenu - View menu.

Since:

v0.3

fillToolBar

protected void fillToolBar()

Fill the tool bar.

Overrides:

fillToolBar in class AbstractGameUISwing

Since:

v0.3

getPauseAction

protected Action getPauseAction()

Return the pause action.

Since:

v0.3

isConcedeAvailable

protected boolean isConcedeAvailable()

Return true if the Concede action is available.

Overrides:

isConcedeAvailable in class AbstractGameUISwing

Since:

v0.3