Package megamek.client.ui.swing.sbf

Class SBFActionPhaseDisplay

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

megamek.client.ui.swing.widget.SkinnedJPanel

megamek.client.ui.swing.AbstractPhaseDisplay

megamek.client.ui.swing.StatusBarPhaseDisplay

megamek.client.ui.swing.sbf.SBFActionPhaseDisplay

All Implemented Interfaces:

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

Direct Known Subclasses:

SBFFiringDisplay, SBFMovementDisplay

public abstract class SBFActionPhaseDisplay
extends StatusBarPhaseDisplay

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class megamek.client.ui.swing.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
protected MegaMekButton	butSkipTurn
protected final SBFClientGUI	clientgui
protected final MegaMekController	controller
protected int	currentFormation	The currently selected unit for taking action.

Fields inherited from class megamek.client.ui.swing.StatusBarPhaseDisplay

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

Fields inherited from class megamek.client.ui.swing.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

Modifier	Constructor	Description
protected	SBFActionPhaseDisplay(SBFClientGUI cg)

Method Summary

Modifier and Type	Method	Description
protected final Optional<SBFFormation>	actingFormation()	Returns the formation that is currently selected for action (movement/firing etc), if any, as an optional.
protected void	initDonePanelForNewTurn()
void	preferenceChange(PreferenceChangeEvent e)
protected UIUtil.FixedXPanel	setupDonePanel()
boolean	shouldReceiveDoneKeyCommand()
protected abstract void	updateDonePanel()	called to reset, show, hide and relabel the Done panel buttons.
protected void	updateDonePanelButtons(String doneButtonLabel, String skipButtonLabel, boolean isDoingAction, List<String> turnDetails)	set labels and enables on the done and skip buttons depending on the GUIP getNagForNoAction option

Methods inherited from class megamek.client.ui.swing.StatusBarPhaseDisplay

addToDonePanel, clear, createButton, createToolTip, extendTimer, getButtonList, getRemainingPlayerWithTurns, isTimerExpired, playerNameOrUnknown, setButtons, setButtonsTooltips, setStatusBarText, setStatusBarWithNotDonePlayers, setupButtonPanel, setupStatusBar, shouldReceiveKeyCommands, startTimer, stopTimer

Methods inherited from class megamek.client.ui.swing.AbstractPhaseDisplay

boardHexHighlighted, finishedMovingUnits, firstLOSHex, gameBoardChanged, gameBoardNew, gameClientFeedbackRequest, gameEnd, gameEntityChange, gameEntityNew, gameEntityNewOffboard, gameEntityRemove, gameMapQuery, gameNewAction, gamePhaseChange, gamePlayerChange, gamePlayerChat, gamePlayerConnected, gamePlayerDisconnected, gameReport, gameSettingsChange, gameTurnChange, gameVictory, getClientgui, hexCursor, hexMoused, hexSelected, isIgnoringEvents, ready, secondLOSHex, sendDone, setIgnoringEvents, unitSelected

Methods inherited from class megamek.client.ui.swing.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 java.awt.event.ActionListener

actionPerformed

Methods inherited from interface megamek.common.util.Distractable

removeAllListeners

Methods inherited from interface megamek.common.event.GameListener

gamePlayerStrategicAction, gameScriptedEvent, gameUnitChange

Field Details

currentFormation

protected int currentFormation

The currently selected unit for taking action. Not necessarily equal to the unit shown in the unit viewer.

butSkipTurn

protected MegaMekButton butSkipTurn

clientgui

protected final SBFClientGUI clientgui

controller

protected final MegaMekController controller

Constructor Details

SBFActionPhaseDisplay

protected SBFActionPhaseDisplay(SBFClientGUI cg)

Method Details

setupDonePanel

protected UIUtil.FixedXPanel setupDonePanel()

Overrides:

setupDonePanel in class StatusBarPhaseDisplay

shouldReceiveDoneKeyCommand

public boolean shouldReceiveDoneKeyCommand()

preferenceChange

public void preferenceChange(PreferenceChangeEvent e)

Specified by:

preferenceChange in interface IPreferenceChangeListener

Overrides:

preferenceChange in class StatusBarPhaseDisplay

initDonePanelForNewTurn

protected void initDonePanelForNewTurn()

updateDonePanel

protected abstract void updateDonePanel()

called to reset, show, hide and relabel the Done panel buttons. Override to change button labels and states, being sure to call updateDonePanelButtons(String, String, boolean, java.util.List) to set the button labels and states

updateDonePanelButtons

protected void updateDonePanelButtons(String doneButtonLabel,
 String skipButtonLabel,
 boolean isDoingAction,
 @Nullable
 List<String> turnDetails)

set labels and enables on the done and skip buttons depending on the GUIP getNagForNoAction option

Parameters:

doneButtonLabel -

skipButtonLabel -

isDoingAction - true if user has entered actions for this turn, false if not.

actingFormation

protected final Optional<SBFFormation> actingFormation()

Returns the formation that is currently selected for action (movement/firing etc), if any, as an optional. Note that this can be empty in many cases. E.g., displays are active when it's not the player's turn. When the setting to not auto-select a unit for the player is active, no unit may be selected even in a player's turn. Note that this is not necessarily equal to the unit *viewed* in the unit display.

Returns:

The currently acting formation, if any