Package megamek.client.ui.panels.phaseDisplay

Class MovementDisplay

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

megamek.client.ui.panels.phaseDisplay.StatusBarPhaseDisplay

megamek.client.ui.panels.phaseDisplay.ActionPhaseDisplay

megamek.client.ui.panels.phaseDisplay.MovementDisplay

All Implemented Interfaces:

ActionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, BoardViewListener, KeyBindReceiver, GameListener, IPreferenceChangeListener, Distractable

public class MovementDisplay
extends ActionPhaseDisplay

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class megamek.client.ui.panels.phaseDisplay.StatusBarPhaseDisplay

StatusBarPhaseDisplay.CommandComparator, StatusBarPhaseDisplay.PhaseCommand

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
static final int	CMD_AERO
static final int	CMD_AERO_BOTH
static final int	CMD_AERO_VECTORED
static final int	CMD_AIR_MEK
static final int	CMD_ALL
static final int	CMD_CONVERTER
static final int	CMD_GROUND
static final int	CMD_INF
static final int	CMD_MEK
static final int	CMD_NO_BUTTON
static final int	CMD_NON_INF
static final int	CMD_NON_VECTORED
static final int	CMD_NONE
static final int	CMD_PROTOMEK
static final int	CMD_TANK
static final int	CMD_VTOL
static final int	GEAR_BACKUP
static final int	GEAR_CHARGE
static final int	GEAR_CLEAR_RUBBLE	Used to designate the rubble hex a bulldozer vehicle drives into and clears (TacOps).
static final int	GEAR_DFA
static final int	GEAR_FLIGHTPATH	Used to designate a ground map flight path for an aero on an atmospheric map.
static final int	GEAR_IM_MEL
static final int	GEAR_JUMP
static final int	GEAR_LAND
static final int	GEAR_LANDING_AERO	Used to choose a ground map hex for landing an aero from an atmospheric map (aero-on-ground move off).
static final int	GEAR_LONGEST_RUN
static final int	GEAR_LONGEST_WALK
static final int	GEAR_RAM
static final int	GEAR_SPLIT_S
static final int	GEAR_STRAFE
static final int	GEAR_SUB_MEK_BOOSTERS
static final int	GEAR_SUB_STANDARD
static final int	GEAR_SWIM
static final int	GEAR_TURN
static int	NO_UNIT_SELECTED
static final String	turnDetailsFormat

Fields inherited from class megamek.client.ui.panels.phaseDisplay.ActionPhaseDisplay

butSkipTurn, clientgui, currentEntity, game

Fields inherited from class megamek.client.ui.panels.phaseDisplay.StatusBarPhaseDisplay

buttonsPerGroup, buttonsPerRow, clientGUI, currentButtonGroup, GUIP, MIN_BUTTON_SIZE, numButtonGroups, panButtons, panStatus

Fields inherited from class megamek.client.ui.panels.phaseDisplay.AbstractPhaseDisplay

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

Constructor	Description
MovementDisplay(ClientGUI clientgui)	Creates and lays out a new movement phase display for the specified clientGUI.getClient().

Method Summary

Modifier and Type	Method	Description
void	actionPerformed(ActionEvent ev)
void	clear()	Clears out the currently selected movement data and resets it.
void	computeAeroMovementEnvelope(Entity entity)	Important: You should call computeMovementEnvelope(megamek.common.units.Entity) instead!
void	computeModifierEnvelope()
void	computeMovementEnvelope(Entity suggestion)	Computes all the possible moves for an Entity.
void	finishedMovingUnits(BoardViewEvent b)	Sent when moving units is finished.
void	gamePhaseChange(GamePhaseChangeEvent e)
void	gameTurnChange(GameTurnChangeEvent e)
protected ArrayList<MegaMekButton>	getButtonList()	Returns the list of buttons that should be displayed.
MovePath	getPlannedMovement()
static boolean	hasAtmosphericMapForLiftOff(IGame game, Entity entity)
void	hexMoused(BoardViewEvent boardViewEvent)	Sent when user clicks, double clicks or drags hex.
void	hexSelected(BoardViewEvent event)	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).
void	ready()	Tells the display to finish the current player turn and send all planned actions to the server.
void	selectEntity(int entityID)	Selects an entity, by number, for movement.
void	selectNextPlayer()	Hands over the current turn to the next valid player on the same team as the supplied player.
protected void	setButtons()	set button that should be displayed.
protected void	setButtonsTooltips()	set button tool tips that should be displayed.
protected boolean	shouldPerformClearKeyCommand()
void	unitSelected(BoardViewEvent boardViewEvent)	Sent when Unit is selected.
protected void	updateDonePanel()	toggles the status of the Done and No Nag buttons based on if the current move order is valid

Methods inherited from class megamek.client.ui.panels.phaseDisplay.ActionPhaseDisplay

checkNagForCrushingBuildings, checkNagForDishonor, checkNagForMASC, checkNagForMechanicalJumpFallDamage, checkNagForNoAction, checkNagForNoUnJamRAC, checkNagForOverheat, checkNagForPSR, checkNagForSprint, checkNagForWiGELanding, checkNagLaunchDoors, clearMarkedHexes, clearMovementSprites, currentEntity, getCurrentEntity, initDonePanelForNewTurn, needNagForCrushingBuildings, needNagForDishonor, needNagForLaunchDoors, needNagForMASC, needNagForMechanicalJumpFallDamage, needNagForNoAction, needNagForNoUnJamRAC, needNagForOther, needNagForOverheat, needNagForPSR, needNagForSprint, needNagForWiGELanding, performDoneNoAction, preferenceChange, removeAllListeners, setupDonePanel, shouldReceiveDoneKeyCommand, updateDonePanelButtons

Methods inherited from class megamek.client.ui.panels.phaseDisplay.StatusBarPhaseDisplay

addToDonePanel, createButton, createToolTip, extendTimer, getRemainingPlayerWithTurns, isTimerExpired, playerNameOrUnknown, setStatusBarText, setStatusBarWithNotDonePlayers, setupButtonPanel, setupStatusBar, shouldReceiveKeyCommands, startTimer, stopTimer

Methods inherited from class megamek.client.ui.panels.phaseDisplay.AbstractPhaseDisplay

boardHexHighlighted, firstLOSHex, gameBoardChanged, gameBoardNew, gameClientFeedbackRequest, gameEnd, gameEntityChange, gameEntityNew, gameEntityNewOffboard, gameEntityRemove, gameMapQuery, gameNewAction, gamePlayerChange, gamePlayerChat, gamePlayerConnected, gamePlayerDisconnected, gameReport, gameSettingsChange, gameVictory, getButDone, getClientGUI, hexCursor, isIgnoringEvents, isMyTurn, secondLOSHex, sendDone, setIgnoringEvents

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

gamePlayerStrategicAction, gamePollChange, gameScriptedEvent, gameToast, gameUnitChange

Field Details

CMD_NONE

public static final int CMD_NONE

See Also:

• Constant Field Values

CMD_MEK

public static final int CMD_MEK

See Also:

• Constant Field Values

CMD_TANK

public static final int CMD_TANK

See Also:

• Constant Field Values

CMD_VTOL

public static final int CMD_VTOL

See Also:

• Constant Field Values

CMD_INF

public static final int CMD_INF

See Also:

• Constant Field Values

CMD_AERO

public static final int CMD_AERO

See Also:

• Constant Field Values

CMD_AERO_VECTORED

public static final int CMD_AERO_VECTORED

See Also:

• Constant Field Values

CMD_CONVERTER

public static final int CMD_CONVERTER

See Also:

• Constant Field Values

CMD_AIR_MEK

public static final int CMD_AIR_MEK

See Also:

• Constant Field Values

CMD_NO_BUTTON

public static final int CMD_NO_BUTTON

See Also:

• Constant Field Values

CMD_PROTOMEK

public static final int CMD_PROTOMEK

See Also:

• Constant Field Values

CMD_AERO_BOTH

public static final int CMD_AERO_BOTH

See Also:

• Constant Field Values

CMD_GROUND

public static final int CMD_GROUND

See Also:

• Constant Field Values

CMD_NON_VECTORED

public static final int CMD_NON_VECTORED

See Also:

• Constant Field Values

CMD_ALL

public static final int CMD_ALL

See Also:

• Constant Field Values

CMD_NON_INF

public static final int CMD_NON_INF

See Also:

• Constant Field Values

NO_UNIT_SELECTED

public static int NO_UNIT_SELECTED

GEAR_LAND

public static final int GEAR_LAND

See Also:

• Constant Field Values

GEAR_BACKUP

public static final int GEAR_BACKUP

See Also:

• Constant Field Values

GEAR_JUMP

public static final int GEAR_JUMP

See Also:

• Constant Field Values

GEAR_CHARGE

public static final int GEAR_CHARGE

See Also:

• Constant Field Values

GEAR_DFA

public static final int GEAR_DFA

See Also:

• Constant Field Values

GEAR_TURN

public static final int GEAR_TURN

See Also:

• Constant Field Values

GEAR_SWIM

public static final int GEAR_SWIM

See Also:

• Constant Field Values

GEAR_RAM

public static final int GEAR_RAM

See Also:

• Constant Field Values

GEAR_IM_MEL

public static final int GEAR_IM_MEL

See Also:

• Constant Field Values

GEAR_SPLIT_S

public static final int GEAR_SPLIT_S

See Also:

• Constant Field Values

GEAR_LONGEST_RUN

public static final int GEAR_LONGEST_RUN

See Also:

• Constant Field Values

GEAR_LONGEST_WALK

public static final int GEAR_LONGEST_WALK

See Also:

• Constant Field Values

GEAR_STRAFE

public static final int GEAR_STRAFE

See Also:

• Constant Field Values

GEAR_FLIGHTPATH

public static final int GEAR_FLIGHTPATH

Used to designate a ground map flight path for an aero on an atmospheric map.

See Also:

• Constant Field Values

GEAR_LANDING_AERO

public static final int GEAR_LANDING_AERO

Used to choose a ground map hex for landing an aero from an atmospheric map (aero-on-ground move off).

See Also:

• Constant Field Values

GEAR_CLEAR_RUBBLE

public static final int GEAR_CLEAR_RUBBLE

Used to designate the rubble hex a bulldozer vehicle drives into and clears (TacOps).

See Also:

• Constant Field Values

GEAR_SUB_STANDARD

public static final int GEAR_SUB_STANDARD

See Also:

• Constant Field Values

GEAR_SUB_MEK_BOOSTERS

public static final int GEAR_SUB_MEK_BOOSTERS

See Also:

• Constant Field Values

turnDetailsFormat

public static final String turnDetailsFormat

See Also:

• Constant Field Values

Constructor Details

MovementDisplay

public MovementDisplay(ClientGUI clientgui)

Creates and lays out a new movement phase display for the specified clientGUI.getClient().

Method Details

setButtons

protected void setButtons()

Description copied from class: StatusBarPhaseDisplay

set button that should be displayed.

Specified by:

setButtons in class StatusBarPhaseDisplay

setButtonsTooltips

protected void setButtonsTooltips()

Description copied from class: StatusBarPhaseDisplay

set button tool tips that should be displayed.

Specified by:

setButtonsTooltips in class StatusBarPhaseDisplay

shouldPerformClearKeyCommand

protected boolean shouldPerformClearKeyCommand()

getButtonList

protected ArrayList<MegaMekButton> getButtonList()

Description copied from class: StatusBarPhaseDisplay

Returns the list of buttons that should be displayed.

Specified by:

getButtonList in class StatusBarPhaseDisplay

Returns:

the button list: we need to determine what unit type is selected and then get a button list appropriate for that unit.

selectNextPlayer

public void selectNextPlayer()

Hands over the current turn to the next valid player on the same team as the supplied player. If no player on the team apart from this player has any turns left, it activates this player again.

selectEntity

public void selectEntity(int entityID)

Selects an entity, by number, for movement.

updateDonePanel

protected void updateDonePanel()

toggles the status of the Done and No Nag buttons based on if the current move order is valid

Specified by:

updateDonePanel in class ActionPhaseDisplay

clear

public void clear()

Clears out the currently selected movement data and resets it.

Specified by:

clear in class StatusBarPhaseDisplay

ready

public void ready()

Description copied from class: AbstractPhaseDisplay

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.

Specified by:

ready in class AbstractPhaseDisplay

hexMoused

public void hexMoused(BoardViewEvent boardViewEvent)

Description copied from interface: BoardViewListener

Sent when user clicks, double clicks or drags hex.

Specified by:

hexMoused in interface BoardViewListener

Overrides:

hexMoused in class AbstractPhaseDisplay

Parameters:

boardViewEvent - an event

hasAtmosphericMapForLiftOff

public static boolean hasAtmosphericMapForLiftOff(IGame game,
 Entity entity)

Returns:

True when there is a position on an existing atmospheric map that corresponds to the entity's current ground map. TW p.88

gameTurnChange

public void gameTurnChange(GameTurnChangeEvent e)

Specified by:

gameTurnChange in interface GameListener

Overrides:

gameTurnChange in class AbstractPhaseDisplay

gamePhaseChange

public void gamePhaseChange(GamePhaseChangeEvent e)

Specified by:

gamePhaseChange in interface GameListener

Overrides:

gamePhaseChange in class AbstractPhaseDisplay

computeMovementEnvelope

public void computeMovementEnvelope(Entity suggestion)

Computes all the possible moves for an Entity. The Entity can either be a suggested Entity or the currently selected one.

Parameters:

suggestion - The suggested Entity to use to compute the movement envelope.

computeAeroMovementEnvelope

public void computeAeroMovementEnvelope(Entity entity)

Important: You should call computeMovementEnvelope(megamek.common.units.Entity) instead!

Computes possible moves for entities of Aero units. This is similar to the computeMovementEnvelope(Entity) method; however, it uses the MovePath final velocity to temporarily set unit velocity to draw the move envelope. This method always sets the original entity velocity back to its original.

Parameters:

entity - - Suggested Entity to use to compute Aero move envelope.

computeModifierEnvelope

public void computeModifierEnvelope()

actionPerformed

public void actionPerformed(ActionEvent ev)

finishedMovingUnits

public void finishedMovingUnits(BoardViewEvent b)

Description copied from interface: BoardViewListener

Sent when moving units is finished.

Specified by:

finishedMovingUnits in interface BoardViewListener

Overrides:

finishedMovingUnits in class AbstractPhaseDisplay

Parameters:

b - an event

unitSelected

public void unitSelected(BoardViewEvent boardViewEvent)

Description copied from interface: BoardViewListener

Sent when Unit is selected.

Specified by:

unitSelected in interface BoardViewListener

Overrides:

unitSelected in class AbstractPhaseDisplay

Parameters:

boardViewEvent - an event

getPlannedMovement

@Nullable
public MovePath getPlannedMovement()

hexSelected

public void hexSelected(BoardViewEvent event)

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

Overrides:

hexSelected in class AbstractPhaseDisplay

Parameters:

event - The select event

See Also:

• IBoardView.select(Coords)