Package megamek.client.ui.dialogs.randomArmy

Class ForceGeneratorOptionsView

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

megamek.client.ui.dialogs.randomArmy.ForceGeneratorOptionsView

All Implemented Interfaces:

ActionListener, FocusListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible

public class ForceGeneratorOptionsView
extends JPanel
implements FocusListener, ActionListener

Controls to set options for force generator.

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 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
ForceGeneratorOptionsView(Consumer<ForceDescriptor> onGenerate, GameOptions gameOptions)

Method Summary

Modifier and Type	Method	Description
void	actionPerformed(ActionEvent ev)
ForceDescriptor	buildForceDescriptor()	Builds a ForceDescriptor from the current state of this options view's controls.
void	exportMUL(ForceDescriptor fd)
void	focusGained(FocusEvent evt)
void	focusLost(FocusEvent evt)
void	setClearButtonVisible(boolean visible)	Shows or hides the Clear button.
void	setCurrentYear(int year)
void	setExportMULButtonVisible(boolean visible)	Shows or hides the Export MUL button.
void	setGenerateButtonVisible(boolean visible)	Shows or hides the Generate button.
void	setOnExportMUL(Consumer<ForceDescriptor> handler)	Sets a custom handler for the Export-MUL button.
boolean	setSelectedFaction(String factionCode)	Programmatically picks a faction in the embedded picker.
void	setYearFieldEditable(boolean editable)	Makes the year text field read-only.

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

Constructor Details

ForceGeneratorOptionsView

public ForceGeneratorOptionsView(Consumer<ForceDescriptor> onGenerate,
 GameOptions gameOptions)

Method Details

buildForceDescriptor

public ForceDescriptor buildForceDescriptor()

Builds a ForceDescriptor from the current state of this options view's controls. Public so embedders (e.g. MekHQ's company-generation dialog) can reuse the same input mapping without going through generateForce()'s SwingWorker plumbing. Does not run Ruleset.processRoot(megamek.client.ratgenerator.ForceDescriptor, megamek.client.ratgenerator.Ruleset.ProgressListener) or any IO.

actionPerformed

public void actionPerformed(ActionEvent ev)

Specified by:

actionPerformed in interface ActionListener

setGenerateButtonVisible

public void setGenerateButtonVisible(boolean visible)

Shows or hides the Generate button. Embedders that drive generation through their own controls (e.g. an OK button on a parent dialog) hide the built-in button.

setExportMULButtonVisible

public void setExportMULButtonVisible(boolean visible)

Shows or hides the Export MUL button. Embedders that route the export through their own UI hide it.

setClearButtonVisible

public void setClearButtonVisible(boolean visible)

Shows or hides the Clear button.

setOnExportMUL

public void setOnExportMUL(Consumer<ForceDescriptor> handler)

Sets a custom handler for the Export-MUL button. When non-null, the built-in exportMUL(megamek.client.ratgenerator.ForceDescriptor) call is replaced by this consumer; the panel passes the live ForceDescriptor for the embedder to handle. Pass null to restore default behavior.

setYearFieldEditable

public void setYearFieldEditable(boolean editable)

Makes the year text field read-only. Use this when an embedder anchors the year to an external value (e.g. MekHQ's campaign year) and doesn't want the user editing it on this panel.

setSelectedFaction

public boolean setSelectedFaction(String factionCode)

Programmatically picks a faction in the embedded picker. Embedders (e.g. MekHQ) call this to seed the picker with their campaign's faction so the dialog opens pre-aligned instead of defaulting to "IS". Looks up the FactionRecord from the loaded RATGenerator data; if the code doesn't match a known faction, the picker is left unchanged and false is returned.

The picker's existing ActionListener fires as a result of the setSelectedItem call, so the descriptor is updated as if the user had picked the faction by hand.

Parameters:

factionCode - the short-name faction code (e.g. "CHH", "LC", "FS")

Returns:

true if a matching faction was found and selected; false otherwise

exportMUL

public void exportMUL(ForceDescriptor fd)

setCurrentYear

public void setCurrentYear(int year)

focusGained

public void focusGained(FocusEvent evt)

Specified by:

focusGained in interface FocusListener

focusLost

public void focusLost(FocusEvent evt)

Specified by:

focusLost in interface FocusListener