Package megamek.client.ui.panels.phaseDisplay

Class AbstractPhaseDisplay

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

megamek.client.ui.widget.SkinnedJPanel

megamek.client.ui.panels.phaseDisplay.AbstractPhaseDisplay

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, EventListener, Accessible, BoardViewListener, GameListener, Distractable

Direct Known Subclasses:

ChatLounge, StatusBarPhaseDisplay

public abstract class AbstractPhaseDisplay
extends SkinnedJPanel
implements BoardViewListener, GameListener, Distractable

This is the base class for all the "displays" which take control during the local player's turn. Only one display is shown at each time; the ChatLounge is also a display. The ChatLounge doesn't show the BoardView but most other displays do. Typically, the display itself is the button bar at the bottom of the GUI.

Note that a display being active does not mean that it is also the player's turn. The display should allow inspecting units and other actions even when it's another player's turn. Also, even when it's the local player's turn, a unit is not necessarily selected. The unit that is selected to act (if there is one) is not necessarily the same as the one open in the unit display.

See Also:

• Serialized Form

Nested Class Summary

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

JPanel.AccessibleJPanel

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

JComponent.AccessibleJComponent

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
protected final MegaMekButton	butDone
static final int	DONE_BUTTON_WIDTH

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, 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

Constructors

Modifier	Constructor	Description
protected	AbstractPhaseDisplay(IClientGUI cg)	Creates a phase display using the standard skin settings for phase displays.
protected	AbstractPhaseDisplay(IClientGUI cg, String panelSkin, String buttonSkin)	Creates a phase display using the given skin settings for the button panel and the buttons.

Method Summary

Modifier and Type	Method	Description
void	boardHexHighlighted(BoardViewEvent b)	Sent when Hex is highlighted.
void	finishedMovingUnits(BoardViewEvent b)	Sent when moving units is finished.
void	firstLOSHex(BoardViewEvent b)	Sent when firstLOS is set.
void	gameBoardChanged(GameBoardChangeEvent e)
void	gameBoardNew(GameBoardNewEvent e)
void	gameClientFeedbackRequest(GameCFREvent evt)
void	gameEnd(GameEndEvent e)
void	gameEntityChange(GameEntityChangeEvent e)
void	gameEntityNew(GameEntityNewEvent e)
void	gameEntityNewOffboard(GameEntityNewOffboardEvent e)
void	gameEntityRemove(GameEntityRemoveEvent e)
void	gameMapQuery(GameMapQueryEvent e)
void	gameNewAction(GameNewActionEvent e)
void	gamePhaseChange(GamePhaseChangeEvent e)
void	gamePlayerChange(GamePlayerChangeEvent e)
void	gamePlayerChat(GamePlayerChatEvent e)
void	gamePlayerConnected(GamePlayerConnectedEvent e)
void	gamePlayerDisconnected(GamePlayerDisconnectedEvent e)
void	gameReport(GameReportEvent e)
void	gameSettingsChange(GameSettingsChangeEvent e)
void	gameTurnChange(GameTurnChangeEvent e)
void	gameVictory(PostGameResolution e)
MegaMekButton	getButDone()
IClientGUI	getClientGUI()
void	hexCursor(BoardViewEvent b)	Sent when BoardView 'cursor' is set to Hex.
void	hexMoused(BoardViewEvent b)	Sent when user clicks, double clicks or drags hex.
void	hexSelected(BoardViewEvent b)	Sent when Hex is selected through a call to the select method (this is not a mouse click event, although many mouse clicks lead to the hex being selected).
final boolean	isIgnoringEvents()
protected boolean	isMyTurn()
abstract void	ready()	Tells the display to finish the current player turn and send all planned actions to the server.
void	secondLOSHex(BoardViewEvent b)	Sent when secondLOS is set.
protected void	sendDone()	Sends a Done packet to the server.
final void	setIgnoringEvents(boolean isDistracted)	Specify if the listener should be distracted.
void	unitSelected(BoardViewEvent b)	Sent when Unit is selected.

Methods inherited from class megamek.client.ui.widget.SkinnedJPanel

paintComponent

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface megamek.common.util.Distractable

removeAllListeners

Methods inherited from interface megamek.common.event.GameListener

gamePlayerStrategicAction, gamePollChange, gameScriptedEvent, gameToast, gameUnitChange

Field Details

DONE_BUTTON_WIDTH

public static final int DONE_BUTTON_WIDTH

See Also:

• Constant Field Values

butDone

protected final MegaMekButton butDone

Constructor Details

AbstractPhaseDisplay

protected AbstractPhaseDisplay(IClientGUI cg)

Creates a phase display using the standard skin settings for phase displays.

Parameters:

cg - The IClientGUI parent of this display

AbstractPhaseDisplay

protected AbstractPhaseDisplay(IClientGUI cg,
 String panelSkin,
 String buttonSkin)

Creates a phase display using the given skin settings for the button panel and the buttons.

Parameters:

cg - The IClientGUI parent of this display

See Also:

• SkinSpecification.UIComponents.getComp()

Method Details

isIgnoringEvents

public final boolean isIgnoringEvents()

Specified by:

isIgnoringEvents in interface Distractable

Returns:

true if the listener is currently distracted, i.e. ignoring events.

setIgnoringEvents

public final void setIgnoringEvents(boolean isDistracted)

Description copied from interface: Distractable

Specify if the listener should be distracted. An event that occurs while the listener is distracted is completely ignored, i.e. it is not processed, neither when it arrives nor at any later point.

Specified by:

setIgnoringEvents in interface Distractable

Parameters:

isDistracted - true if the listener should ignore events, false if the listener should pay attention

ready

public abstract void ready()

Tells the display to finish the current player turn and send all planned actions to the server. Planned actions are e.g. movement, attacks or deployment. Usually, the planned actions are all actions that, together, make up a single unit's turn, e.g. all weapon attacks of one unit.

getClientGUI

public IClientGUI getClientGUI()

getButDone

public MegaMekButton getButDone()

sendDone

protected void sendDone()

Sends a Done packet to the server. Shortcut for clientGUI.getClient().sendDone(true).

See Also:

• IClient.sendDone(boolean)

isMyTurn

protected boolean isMyTurn()

Returns:

True when the client determines that it is the local player's turn to act. Shortcut to clientGUI.getClient().isMyTurn().

hexMoused

public void hexMoused(BoardViewEvent b)

Description copied from interface: BoardViewListener

Sent when user clicks, double clicks or drags hex.

Specified by:

hexMoused in interface BoardViewListener

Parameters:

b - an event

hexSelected

public void hexSelected(BoardViewEvent b)

Description copied from interface: BoardViewListener

Sent when Hex is selected through a call to the select method (this is not a mouse click event, although many mouse clicks lead to the hex being selected).

Specified by:

hexSelected in interface BoardViewListener

Parameters:

b - The select event

See Also:

• IBoardView.select(Coords)

hexCursor

public void hexCursor(BoardViewEvent b)

Description copied from interface: BoardViewListener

Sent when BoardView 'cursor' is set to Hex.

Specified by:

hexCursor in interface BoardViewListener

Parameters:

b - an event

boardHexHighlighted

public void boardHexHighlighted(BoardViewEvent b)

Description copied from interface: BoardViewListener

Sent when Hex is highlighted.

Specified by:

boardHexHighlighted in interface BoardViewListener

Parameters:

b - an event

firstLOSHex

public void firstLOSHex(BoardViewEvent b)

Description copied from interface: BoardViewListener

Sent when firstLOS is set.

Specified by:

firstLOSHex in interface BoardViewListener

Parameters:

b - an event

secondLOSHex

public void secondLOSHex(BoardViewEvent b)

Description copied from interface: BoardViewListener

Sent when secondLOS is set.

Specified by:

secondLOSHex in interface BoardViewListener

Parameters:

b - an event

finishedMovingUnits

public void finishedMovingUnits(BoardViewEvent b)

Description copied from interface: BoardViewListener

Sent when moving units is finished.

Specified by:

finishedMovingUnits in interface BoardViewListener

Parameters:

b - an event

unitSelected

public void unitSelected(BoardViewEvent b)

Description copied from interface: BoardViewListener

Sent when Unit is selected.

Specified by:

unitSelected in interface BoardViewListener

Parameters:

b - an event

gamePlayerConnected

public void gamePlayerConnected(GamePlayerConnectedEvent e)

Specified by:

gamePlayerConnected in interface GameListener

gamePlayerDisconnected

public void gamePlayerDisconnected(GamePlayerDisconnectedEvent e)

Specified by:

gamePlayerDisconnected in interface GameListener

gamePlayerChange

public void gamePlayerChange(GamePlayerChangeEvent e)

Specified by:

gamePlayerChange in interface GameListener

gamePlayerChat

public void gamePlayerChat(GamePlayerChatEvent e)

Specified by:

gamePlayerChat in interface GameListener

gamePhaseChange

public void gamePhaseChange(GamePhaseChangeEvent e)

Specified by:

gamePhaseChange in interface GameListener

gameTurnChange

public void gameTurnChange(GameTurnChangeEvent e)

Specified by:

gameTurnChange in interface GameListener

gameReport

public void gameReport(GameReportEvent e)

Specified by:

gameReport in interface GameListener

gameEnd

public void gameEnd(GameEndEvent e)

Specified by:

gameEnd in interface GameListener

gameBoardNew

public void gameBoardNew(GameBoardNewEvent e)

Specified by:

gameBoardNew in interface GameListener

gameBoardChanged

public void gameBoardChanged(GameBoardChangeEvent e)

Specified by:

gameBoardChanged in interface GameListener

gameSettingsChange

public void gameSettingsChange(GameSettingsChangeEvent e)

Specified by:

gameSettingsChange in interface GameListener

gameMapQuery

public void gameMapQuery(GameMapQueryEvent e)

Specified by:

gameMapQuery in interface GameListener

gameEntityNew

public void gameEntityNew(GameEntityNewEvent e)

Specified by:

gameEntityNew in interface GameListener

gameEntityNewOffboard

public void gameEntityNewOffboard(GameEntityNewOffboardEvent e)

Specified by:

gameEntityNewOffboard in interface GameListener

gameEntityRemove

public void gameEntityRemove(GameEntityRemoveEvent e)

Specified by:

gameEntityRemove in interface GameListener

gameEntityChange

public void gameEntityChange(GameEntityChangeEvent e)

Specified by:

gameEntityChange in interface GameListener

gameNewAction

public void gameNewAction(GameNewActionEvent e)

Specified by:

gameNewAction in interface GameListener

gameClientFeedbackRequest

public void gameClientFeedbackRequest(GameCFREvent evt)

Specified by:

gameClientFeedbackRequest in interface GameListener

gameVictory

public void gameVictory(PostGameResolution e)

Specified by:

gameVictory in interface GameListener