Package mekhq.gui

Class StratConPanel

java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JPanel
mekhq.gui.StratConPanel
All Implemented Interfaces:
ActionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible
public class StratConPanel extends JPanel implements ActionListener
This panel handles AtB-StratCon GUI interactions with a specific scenario track.
See Also:

  • Field Details

  • Constructor Details

    • StratConPanel

      public StratConPanel(CampaignGUI gui, JLabel infoArea)
      Constructs a StratConPanel instance, given a parent campaign GUI and a pointer to an info area.

  • Method Details

    • getStratConScenarioWizard

      public StratConScenarioWizard getStratConScenarioWizard()

    • getAssignmentUI

      public TrackForceAssignmentUI getAssignmentUI()

    • selectTrack

      public void selectTrack(StratConCampaignState campaignState, StratConTrackState track)
      Handler for when a specific track is selected - switches rendering to that track.

    • scoutCurrentSector

      public void scoutCurrentSector()
      Scouts (permanently reveals) every hex in the currently selected sector, then repaints. Unlike the GM sector reveal, this marks the hexes as revealed, so their contents stay visible afterward.

    • regenerateCurrentSector

      public void regenerateCurrentSector()
      GM tool: clears the current sector and regenerates its terrain (and cities/roads), then repaints. Scenarios, facilities, and assigned forces are left in place.

    • openTerrainPaintDialog

      public void openTerrainPaintDialog()
      GM tool: opens the terrain palette, putting the map into paint mode until the palette is closed.

    • resizeSector

      public void resizeSector()
      GM tool: prompts for new sector dimensions and applies them, growing or shrinking at the right and bottom edges. Warns first when the new size would displace anything.

    • setPaintTerrain

      public void setPaintTerrain(String terrain)
      Sets the terrain the brush lays down. Called by the terrain palette.

    • setPaintBrushRadius

      public void setPaintBrushRadius(int radius)
      Sets the brush radius in hexes: 0 paints a single hex, 1 paints it and its neighbors, and so on.

    • isPaintingTerrain

      public boolean isPaintingTerrain()
      Named for the terrain brush rather than isPainting, which would sit confusingly beside the package-private JComponent.isPainting this panel inherits but cannot override - a reader inside the painting code would have no way to tell the two apart.
      Returns:
      true while the terrain palette is open and clicks paint rather than select.

    • exitPaintMode

      public void exitPaintMode()
      Leaves paint mode, restoring normal selection and panning. Called when the terrain palette closes.

    • getTerrainImage

      public BufferedImage getTerrainImage(String terrainType)
      Returns:
      the map sprite for a terrain type, for the terrain palette to render alongside the name.

    • resetSectorFog

      public void resetSectorFog()
      GM tool: un-reveals every hex in the current sector so scouting can be re-tested, then repaints. Open water is re-revealed, since it never holds fog of war.

    • toggleHiddenObjects

      public void toggleHiddenObjects()
      Toggles the current sector's "GM revealed" state, which shows or hides otherwise-hidden objects (cloaked scenarios, invisible facilities, and unscouted hexes). Formerly the "Reveal/Hide Sector" right-click item.

    • paintComponent

      public void paintComponent(Graphics g)
      Renders the panel, hexes, forces, facilities and all that.
      Overrides:
      paintComponent in class JComponent

    • mouseReleasedHandler

      public void mouseReleasedHandler(MouseEvent e)
      Event handler for when a mouse button is released.

    • getSelectedScenario

      public StratConScenario getSelectedScenario()

    • getCurrentTrack

      public StratConTrackState getCurrentTrack()

    • setCurrentTrack

      public void setCurrentTrack(StratConTrackState track)

    • getSelectedCoords

      public StratConCoords getSelectedCoords()

    • setSelectedCoords

      public void setSelectedCoords(StratConCoords coords)

    • actionPerformed

      public void actionPerformed(ActionEvent evt)
      Handles action events triggered by various StratCon-related commands from the right-click context menu. This method processes user interactions to update the game state, scenarios, facilities, and UI elements based on the selected command and inputs from the context menu.

      The supported commands and their effects are as follows:

      • RIGHT_CLICK_COMMAND_MANAGE_FORCES: Displays the force management UI for the selected coordinates.
        • If no scenario exists at the selected coordinates, the force management UI is directly displayed.
        • If a scenario exists, it only displays the UI if the scenario is unresolved.
      • RIGHT_CLICK_COMMAND_MANAGE_SCENARIO: Displays the scenario wizard with the current scenario at the selected coordinates if the scenario's state is PRIMARY_FORCES_COMMITTED.
      • RIGHT_CLICK_COMMAND_REVEAL_TRACK: Toggles the "GM revealed" state for the current track and updates the menu text to reflect the state ("Hide Track" or "Reveal Track").
      • RIGHT_CLICK_COMMAND_STICKY_FORCE: Toggles the sticky force assignment for a given force ID at the selected track. When toggled:
      • -- If selected, the force is added to the track as sticky.
      • -- If deselected, the force is removed from the track's sticky forces.
      • RIGHT_CLICK_COMMAND_REMOVE_FACILITY: Deletes the facility present at the selected coordinates.
      • RIGHT_CLICK_COMMAND_CAPTURE_FACILITY: Changes the ownership of the facility at the selected coordinates to a different faction or player, as per the rules defined in StratConRulesManager.
      • RIGHT_CLICK_COMMAND_ADD_FACILITY: Adds a new facility to the selected coordinates. The facility's properties (visibility, type, etc.) are copied from the provided source facility.
      • RIGHT_CLICK_COMMAND_REMOVE_SCENARIO: Deletes the currently selected scenario from the campaign.
      Specified by:
      actionPerformed in interface ActionListener
      Parameters:
      evt - the ActionEvent representing the user's action. Contains information about the triggering source and command (e.g., which menu item was selected).

      Behavior:

      • The method retrieves the StratConCoords currently selected by the user, and performs actions based on the provided command string in the event.
      • The scenarios, forces, and facilities of the currentTrack are modified based on the command type, and updates are visually reflected in the UI.
      • If a UI-related command is processed (e.g., displaying the scenario wizard or force assignment UI), the appropriate UI components are updated and made visible to the user.

      General Information: If no valid StratConCoords are selected at the time of the event, the method will terminate with no further action. Certain commands (e.g., RIGHT_CLICK_COMMAND_REVEAL_TRACK, RIGHT_CLICK_COMMAND_ADD_FACILITY) require valid coordinates or source properties to execute successfully.

      If no specific actions from the above list are matched (no corresponding `case`), the method performs no effect.

    • getPreferredSize

      public Dimension getPreferredSize()
      Overrides:
      getPreferredSize in class JComponent

    • isCommitForces

      @Deprecated(since="0.51.0", forRemoval=true) public boolean isCommitForces()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setCommitForces

      public void setCommitForces(boolean commitForces)