dip.gui
Class ClientFrame

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Frame
                  javax.swing.JFrame
                      dip.gui.ClientFrame

All Implemented Interfaces:

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

public class ClientFrame

extends javax.swing.JFrame

The main class for starting the client... everything starts here.

Note that this is not required for non-gui functionality; see dip.misc.TestSuite for an example of using the adjudicator classes without the GUI.

Currently, there is no "server".

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

static java.lang.String	EVT_DISPLAYABLE_POWERS_CHANGED Event indicating the Powers that may be displayed have changed.
static java.lang.String	EVT_MMD_READY Event indicating that MapMetadata object is ready
static java.lang.String	EVT_MODE_CHANGED Event indicating a mode change
static java.lang.String	EVT_MODIFIED_STATE Event indicating that the saved game state doesn't jive with the current state
static java.lang.String	EVT_MULTIPLE_ORDERS_CREATED Event indicating multiple orders were created
static java.lang.String	EVT_MULTIPLE_ORDERS_DELETED Event indicating multiple orders were deleted (cleared)
static java.lang.String	EVT_ORDER_CREATED Event indicating an order was created
static java.lang.String	EVT_ORDER_DELETED Event indicating an order was deleted
static java.lang.String	EVT_ORDERABLE_POWERS_CHANGED Event indicating the Powers for which orders may be entered have changed.
static java.lang.String	EVT_TURNSTATE_ADDED Event indicating a TurnState was added
static java.lang.String	EVT_TURNSTATE_CHANGED Event indicating the current TurnState has changed.
static java.lang.String	EVT_TURNSTATE_REMOVED Event indicating a TurnState was removed
static java.lang.String	EVT_TURNSTATE_RESOLVED Event indicating a TurnState was resolved
static java.lang.String	EVT_VALOPTS_CHANGED Event indicating that order validation options have changed
static java.lang.String	EVT_WORLD_CREATED Event indicating that a World object was created
static java.lang.String	EVT_WORLD_DESTROYED Event indicating the World was destroyed (!)
static java.lang.String	MODE_EDIT Edit Mode: units/ownership/etc. may be changed in this mode.
static java.lang.String	MODE_NONE "None" Mode: no World object is active
static java.lang.String	MODE_ORDER Order Mode: orders may be entered in this mode.
static java.lang.String	MODE_REVIEW Review Mode: Orders from previous turns (or if game has ended) may be reviewed in this mode.

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.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

ClientFrame(java.lang.String[] args)
Create a ClientFrame, the main screen for the GUI Client.

Method Summary

void	createWorld(World w) Sets the current World.
void	dbgPrintListeners() Prints the currently registered listeners to stdout.
void	destroyWorld() Destroy the World (!
void	fireChangeMode(java.lang.String newMode) Change the operating mode for this ClientFrame.
void	fireDisplayablePowersChanged(Power[] oldPowers, Power[] newPowers) Fired when displayed orders have changed
void	fireMMDReady(MapMetadata mmd) Fired when the MapMetadata object is ready.
void	fireMultipleOrdersCreated(Orderable[] createdOrders) Fired when multiple orders were created
void	fireMultipleOrdersDeleted(Orderable[] deletedOrders) Fired when multiple orders were deleted
void	fireOrderablePowersChanged(Power[] oldPowers, Power[] newPowers) Fired when Powers for which orders may be entered have changed
void	fireOrderCreated(Orderable newOrder) Fired when an order was created
void	fireOrderDeleted(Orderable deletedOrder) Fired when an order was deleted
void	fireStateModified() Fired if we have modified the World in such a way it is no longer reflected in its saved state.
void	fireTurnStateAdded(TurnState newTS) Fired if we have added a turnstate
void	fireTurnstateChanged(TurnState ts) Indicates to listeners what the current TurnState is.
void	fireTurnStateRemoved() Fired if we have removed a turnstate
void	fireTurnstateResolved(TurnState ts) Indicates that the given TurnState has been Resolved (adjudicated).
void	fireValidationOptionsChanged(ValidationOptions oldOpts, ValidationOptions newOpts) Fired if we change the order Validation Options.
protected void	fireWorldCreated(World w) Fired when the World object was created.
ClientMenu	getClientMenu() Get the Menu component
Power[]	getDisplayablePowers() Returns the Powers which for which orders may be displayed.
GUIOrderFactory	getGUIOrderFactory() Returns the default OrderFactory for generating new Orders.
javax.swing.JSplitPane	getJSplitPane() Get the JSplitPane component
MapMetadata	getMapMetadata() Get MapMetadata (note: may be null)
MapPanel	getMapPanel() Get the MapPanel component
java.lang.String	getMode() Gets the current mode.
OrderFormatOptions	getOFO() Get the user-specified Order Format Options (OFO)
Power[]	getOrderablePowers() Returns the Powers for which orders may be entered.
OrderDisplayPanel	getOrderDisplayPanel() Get the OrderDisplayPanel component
OrderStatusPanel	getOrderStatusPanel() Get the OrderStatusPanel component
PhaseSelector	getPhaseSelector() Get the PhaseSelector component
PersistenceManager	getPM() Get the PersistenceManager component
static java.lang.String	getProgramName() Returns the Client program name.
StatusBar	getStatusBar() Get the StatusBar component
TurnState	getTurnState() Returns the current TurnState.
UndoRedoManager	getUndoRedoManager() Get the UndoRedoManager component
boolean	getValidating() Returns true if we should validate all data files.
ValidationOptions	getValidationOptions() Get the current order validation options settings.
static java.lang.String	getVersion() Returns the Client version; format: major.minor.revision (language)
static int	getVersionMajor() Returns the Client major version
static int	getVersionMinor() Returns the Client minor version
World	getWorld() Returns the current World, or null if no World is loaded.
boolean	isMMDSuppressed() Returns if MapMetadata placement errors are suppressed.
static void	main(java.lang.String[] args) It all starts here ....
void	resolveOrders() Resolve orders.
void	setMMDSuppressed(boolean value) Set if we are suppressing MapMetadata placement errors.
void	setOFO(OrderFormatOptions value) Set the user-specified Order Format Options (OFO)

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

EVT_WORLD_CREATED

public static final java.lang.String EVT_WORLD_CREATED

Event indicating that a World object was created

See Also:

Constant Field Values

EVT_WORLD_DESTROYED

public static final java.lang.String EVT_WORLD_DESTROYED

Event indicating the World was destroyed (!)

See Also:

Constant Field Values

EVT_TURNSTATE_CHANGED

public static final java.lang.String EVT_TURNSTATE_CHANGED

Event indicating the current TurnState has changed.

See Also:

Constant Field Values

EVT_MODIFIED_STATE

public static final java.lang.String EVT_MODIFIED_STATE

Event indicating that the saved game state doesn't jive with the current state

See Also:

Constant Field Values

EVT_TURNSTATE_ADDED

public static final java.lang.String EVT_TURNSTATE_ADDED

Event indicating a TurnState was added

See Also:

Constant Field Values

EVT_TURNSTATE_REMOVED

public static final java.lang.String EVT_TURNSTATE_REMOVED

Event indicating a TurnState was removed

See Also:

Constant Field Values

EVT_TURNSTATE_RESOLVED

public static final java.lang.String EVT_TURNSTATE_RESOLVED

Event indicating a TurnState was resolved

See Also:

Constant Field Values

EVT_MODE_CHANGED

public static final java.lang.String EVT_MODE_CHANGED

Event indicating a mode change

See Also:

Constant Field Values

EVT_VALOPTS_CHANGED

public static final java.lang.String EVT_VALOPTS_CHANGED

Event indicating that order validation options have changed

See Also:

Constant Field Values

EVT_MMD_READY

public static final java.lang.String EVT_MMD_READY

Event indicating that MapMetadata object is ready

See Also:

Constant Field Values

EVT_ORDER_CREATED

public static final java.lang.String EVT_ORDER_CREATED

Event indicating an order was created

See Also:

Constant Field Values

EVT_ORDER_DELETED

public static final java.lang.String EVT_ORDER_DELETED

Event indicating an order was deleted

See Also:

Constant Field Values

EVT_MULTIPLE_ORDERS_CREATED

public static final java.lang.String EVT_MULTIPLE_ORDERS_CREATED

Event indicating multiple orders were created

See Also:

Constant Field Values

EVT_MULTIPLE_ORDERS_DELETED

public static final java.lang.String EVT_MULTIPLE_ORDERS_DELETED

Event indicating multiple orders were deleted (cleared)

See Also:

Constant Field Values

EVT_DISPLAYABLE_POWERS_CHANGED

public static final java.lang.String EVT_DISPLAYABLE_POWERS_CHANGED

Event indicating the Powers that may be displayed have changed.

See Also:

Constant Field Values

EVT_ORDERABLE_POWERS_CHANGED

public static final java.lang.String EVT_ORDERABLE_POWERS_CHANGED

Event indicating the Powers for which orders may be entered have changed.

See Also:

Constant Field Values

MODE_ORDER

public static final java.lang.String MODE_ORDER

Order Mode: orders may be entered in this mode.

See Also:

Constant Field Values

MODE_EDIT

public static final java.lang.String MODE_EDIT

Edit Mode: units/ownership/etc. may be changed in this mode.

See Also:

Constant Field Values

MODE_REVIEW

public static final java.lang.String MODE_REVIEW

Review Mode: Orders from previous turns (or if game has ended) may be reviewed in this mode.

See Also:

Constant Field Values

MODE_NONE

public static final java.lang.String MODE_NONE

"None" Mode: no World object is active

See Also:

Constant Field Values

Constructor Detail

ClientFrame

public ClientFrame(java.lang.String[] args)

Create a ClientFrame, the main screen for the GUI Client.

Method Detail

main

public static void main(java.lang.String[] args)

It all starts here ....

getClientMenu

public ClientMenu getClientMenu()

Get the Menu component

getPM

public PersistenceManager getPM()

Get the PersistenceManager component

getPhaseSelector

public PhaseSelector getPhaseSelector()

Get the PhaseSelector component

getOrderDisplayPanel

public OrderDisplayPanel getOrderDisplayPanel()

Get the OrderDisplayPanel component

getOrderStatusPanel

public OrderStatusPanel getOrderStatusPanel()

Get the OrderStatusPanel component

getMapPanel

public MapPanel getMapPanel()

Get the MapPanel component

getStatusBar

public StatusBar getStatusBar()

Get the StatusBar component

getUndoRedoManager

public UndoRedoManager getUndoRedoManager()

Get the UndoRedoManager component

getValidationOptions

public ValidationOptions getValidationOptions()

Get the current order validation options settings.

setMMDSuppressed

public void setMMDSuppressed(boolean value)

Set if we are suppressing MapMetadata placement errors. This should only be set by Map Editors.

isMMDSuppressed

public boolean isMMDSuppressed()

Returns if MapMetadata placement errors are suppressed.

getOFO

public OrderFormatOptions getOFO()

Get the user-specified Order Format Options (OFO)

setOFO

public void setOFO(OrderFormatOptions value)

Set the user-specified Order Format Options (OFO)

getMapMetadata

public MapMetadata getMapMetadata()

Get MapMetadata (note: may be null)

getOrderablePowers

public Power[] getOrderablePowers()

Returns the Powers for which orders may be entered. If this value is changed, a EVT_ORDERABLE_POWERS_CHANGED property event will be fired.

This is only applicable for phases in which orders may be entered.

getDisplayablePowers

public Power[] getDisplayablePowers()

Returns the Powers which for which orders may be displayed. If this value is changed, a EVT_DISPLAYABLE_POWERS_CHANGED property event will be fired.

This is only applicable for phases in which orders may be entered. For example, in Review mode, all orders should be displayed.

getValidating

public boolean getValidating()

Returns true if we should validate all data files. This may or may not be applicable, depending upon the data file format.

getGUIOrderFactory

public GUIOrderFactory getGUIOrderFactory()

Returns the default OrderFactory for generating new Orders. By default, GUIOrders are used, so the default class should be a GUIOrderFactory or derivative.

getJSplitPane

public javax.swing.JSplitPane getJSplitPane()

Get the JSplitPane component

getWorld

public World getWorld()

Returns the current World, or null if no World is loaded.

createWorld

public void createWorld(World w)

Sets the current World. Uses the GameSetup object to perform additional, as-needed, game setup. A Null argument is not permitted.

destroyWorld

public void destroyWorld()

Destroy the World (! use with caution).

fireWorldCreated

protected void fireWorldCreated(World w)

Fired when the World object was created. This is typically only sent by the GUIGameSetup object.

fireTurnstateChanged

public void fireTurnstateChanged(TurnState ts)

Indicates to listeners what the current TurnState is. It is upto the Listener (such as OrderDisplayPanel and MapPanel) to actually update the GUI.

Note: The OLD event value (TurnState) will always be null for this event; otherwise 'update' events will not fire.

null is not acceptable.

fireTurnstateResolved

public void fireTurnstateResolved(TurnState ts)

Indicates that the given TurnState has been Resolved (adjudicated). May not be null.

Note: The OLD event value (TurnState) will always be null for this event; otherwise 'update' events will not fire.

fireMMDReady

public void fireMMDReady(MapMetadata mmd)

Fired when the MapMetadata object is ready.

getTurnState

public TurnState getTurnState()

Returns the current TurnState.

Returns null if no World (or current TurnState) exists.

fireOrderCreated

public final void fireOrderCreated(Orderable newOrder)

Fired when an order was created

fireOrderDeleted

public final void fireOrderDeleted(Orderable deletedOrder)

Fired when an order was deleted

fireMultipleOrdersCreated

public final void fireMultipleOrdersCreated(Orderable[] createdOrders)

Fired when multiple orders were created

fireMultipleOrdersDeleted

public final void fireMultipleOrdersDeleted(Orderable[] deletedOrders)

Fired when multiple orders were deleted

fireDisplayablePowersChanged

public final void fireDisplayablePowersChanged(Power[] oldPowers,
                                               Power[] newPowers)

Fired when displayed orders have changed

fireOrderablePowersChanged

public final void fireOrderablePowersChanged(Power[] oldPowers,
                                             Power[] newPowers)

Fired when Powers for which orders may be entered have changed

fireStateModified

public final void fireStateModified()

Fired if we have modified the World in such a way it is no longer reflected in its saved state.

fireTurnStateAdded

public final void fireTurnStateAdded(TurnState newTS)

Fired if we have added a turnstate

fireTurnStateRemoved

public final void fireTurnStateRemoved()

Fired if we have removed a turnstate

fireValidationOptionsChanged

public final void fireValidationOptionsChanged(ValidationOptions oldOpts,
                                               ValidationOptions newOpts)

Fired if we change the order Validation Options. New/Old options sent.

fireChangeMode

public final void fireChangeMode(java.lang.String newMode)

Change the operating mode for this ClientFrame.

dbgPrintListeners

public void dbgPrintListeners()

Prints the currently registered listeners to stdout. For debugging only.

getVersion

public static java.lang.String getVersion()

Returns the Client version; format:
major.minor.revision (language)

getVersionMajor

public static int getVersionMajor()

Returns the Client major version

getVersionMinor

public static int getVersionMinor()

Returns the Client minor version

getProgramName

public static java.lang.String getProgramName()

Returns the Client program name.

getMode

public java.lang.String getMode()

Gets the current mode. Use a fireChangeMode() to set the current mode.

resolveOrders

public void resolveOrders()

Resolve orders. Requires an OrderDisplayPanel to be present.