Package megamek.client.ui.dialogs.phaseDisplay

Class AbstractChoiceDialog<T>

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Dialog

javax.swing.JDialog

megamek.client.ui.dialogs.abstractDialogs.AbstractDialog

megamek.client.ui.dialogs.buttonDialogs.AbstractButtonDialog

megamek.client.ui.dialogs.phaseDisplay.AbstractChoiceDialog<T>

Type Parameters:

T - Any object type

All Implemented Interfaces:

WindowListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants

Direct Known Subclasses:

DeployElevationChoiceDialog, EntityChoiceDialog, SBFJumpChoiceDialog, TargetChoiceDialog

public abstract class AbstractChoiceDialog<T>
extends AbstractButtonDialog

A modal dialog for presenting options as buttons. Can do single or multi-selection. Sub-classes should define methods for setting the text labels for the buttons as a summary or details of the item. Text label can be HTML or any other JButton legal content.

See Also:

• Serialized Form

Nested Class Summary

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

JDialog.AccessibleJDialog

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

Dialog.AccessibleAWTDialog, Dialog.ModalExclusionType, Dialog.ModalityType

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

Window.AccessibleAWTWindow, Window.Type

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 megamek.client.ui.dialogs.abstractDialogs.AbstractDialog

CLOSE_ACTION, resources

Fields inherited from class javax.swing.JDialog

accessibleContext, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Dialog

DEFAULT_MODALITY_TYPE

Fields inherited from class java.awt.Component

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

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractChoiceDialog(JFrame frame, String title, String message, List<T> targets, boolean isMultiSelect)	This creates a modal AbstractChoiceDialog using the default resource bundle as a Modal dialog.

Method Summary

Modifier and Type	Method	Description
protected Container	createCenterPane()	This is used to create the dialog's center pane
protected abstract void	detailLabel(JToggleButton button, T target)	Override to set button text and/or icon with details about this choice.
List<T>	getChosen()
T	getFirstChoice()
void	setColumns(int columns)
void	setUseDetailed(boolean useDetailed)
void	setVisible(boolean value)
protected abstract void	summaryLabel(JToggleButton button, T target)	Override to set button text and/or icon with summary info about this choice.

Methods inherited from class megamek.client.ui.dialogs.buttonDialogs.AbstractButtonDialog

createButtonPanel, getResult, initialize, okAction, okButtonActionPerformed, setResult, showDialog

Methods inherited from class megamek.client.ui.dialogs.abstractDialogs.AbstractDialog

cancelAction, cancelActionPerformed, finalizeInitialization, fit, fitAndCenter, getFrame, setCustomPreferences, setFrame, setPreferences, setPreferences, windowActivated, windowClosed, windowClosing, windowDeactivated, windowDeiconified, windowIconified, windowOpened

Methods inherited from class javax.swing.JDialog

addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Dialog

addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, show, toBack

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, setName, setPreferredSize, 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

AbstractChoiceDialog

protected AbstractChoiceDialog(JFrame frame,
 String title,
 String message,
 @Nullable
 List<T> targets,
 boolean isMultiSelect)

This creates a modal AbstractChoiceDialog using the default resource bundle as a Modal dialog. concrete classes must call initialize() at the end of the constructor

Parameters:

frame - parent @JFrame that owns this dialog

title - Resource key string only, plain text will result in NPE from Resources

message - HTML or plain text message show at top of dialog

targets - things to chose from

isMultiSelect - if true, allows user to select multiple items. if false first, item chosen will close the window

Method Details

setUseDetailed

public void setUseDetailed(boolean useDetailed)

Parameters:

useDetailed - Enables or disables the useDetailed flag.

setColumns

public void setColumns(int columns)

Parameters:

columns - Number of columns to use. Min: 1

createCenterPane

protected Container createCenterPane()

Description copied from class: AbstractDialog

This is used to create the dialog's center pane

Specified by:

createCenterPane in class AbstractDialog

Returns:

the center pane of the dialog

setVisible

public void setVisible(boolean value)

Overrides:

setVisible in class Dialog

detailLabel

protected abstract void detailLabel(JToggleButton button,
 T target)

Override to set button text and/or icon with details about this choice. Usually this is called then the show details button is depressed

Parameters:

button - A Toggle Button

target - Target to store value?

summaryLabel

protected abstract void summaryLabel(JToggleButton button,
 T target)

Override to set button text and/or icon with summary info about this choice. This is called then the show details button is not depressed

Parameters:

button - A Toggle Button

target - Target to store value?

getFirstChoice

@Nullable
public T getFirstChoice()

Returns:

first chosen item, or null if nothing chosen

getChosen

public List<T> getChosen()

Returns:

list of items picked by user. List will be empty if nothing picked