Class AbstractButtonDialog
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
- All Implemented Interfaces:
WindowListener
,ImageObserver
,MenuContainer
,Serializable
,EventListener
,Accessible
,RootPaneContainer
,WindowConstants
- Direct Known Subclasses:
AbstractChoiceDialog
,AbstractIconChooserDialog
,AbstractNagDialog
,AbstractValidationButtonDialog
,AdvancedSearchDialog
,AdvancedSearchMapDialog
,BotConfigDialog
,BotConfigTargetHexDialog
,BotConfigTargetUnitDialog
,CommonSettingsDialog
,CustomMekDialog
,EditBotsDialog
,FloodDialog
,GameOptionsDialog
,LevelChangeDialog
,LOSDialog
,MultiIntSelectorDialog
,PlayerSettingsDialog
,ScenarioChooserDialog
,SkillGenerationDialog
This is the Base Dialog for a dialog with buttons in MegaMek. It extends Base
Dialog, and adds a button panel with base Ok and Cancel buttons. It also
includes an enum tracker for the result of the dialog.
Inheriting classes must call initialize() in their constructors and override
createCenterPane()
The resources associated with this dialog need to contain at least the
following keys:
- "Ok.text" - text for the ok button
- "Ok.toolTipText" - toolTipText for the ok button
- "Cancel.text" - text for the cancel button
- "Cancel.toolTipText" - toolTipText for the cancel button
This is directly tied to MekHQ's AbstractMHQButtonDialog, and any changes
here MUST be verified there.
- See Also:
-
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
ConstructorsModifierConstructorDescriptionprotected
AbstractButtonDialog
(JDialog dialog, JFrame frame, boolean modal, ResourceBundle resources, String name, String title) This constructor is provided for uses cases where this dialog needs another dialog as a parent.protected
AbstractButtonDialog
(JFrame frame, boolean modal, String name, String title) This creates an AbstractButtonDialog using the default resource bundle.protected
AbstractButtonDialog
(JFrame frame, boolean modal, ResourceBundle resources, String name, String title) This creates an AbstractButtonDialog using the specified resource bundle.protected
AbstractButtonDialog
(JFrame frame, String name, String title) This creates a modal AbstractButtonDialog using the default resource bundle. -
Method Summary
Modifier and TypeMethodDescriptionprotected JPanel
protected void
Initializes the dialog's UI and preferences.protected void
okAction()
Action performed when the Ok button is clicked.protected void
This is the default Action Event Listener for the Ok Button's action.void
setResult
(DialogResult result) Sets the dialog to be visible, before returning the resultMethods inherited from class megamek.client.ui.dialogs.abstractDialogs.AbstractDialog
cancelAction, cancelActionPerformed, createCenterPane, 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, setVisible, 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
-
Constructor Details
-
AbstractButtonDialog
This creates a modal AbstractButtonDialog using the default resource bundle. This is the normal constructor to use for an AbstractButtonDialog.- Parameters:
frame
- Frame to connect to.name
- Name for the button.title
- Title of the dialog.
-
AbstractButtonDialog
This creates an AbstractButtonDialog using the default resource bundle. It allows one to create non-modal button dialogs.- Parameters:
frame
- Window frame to connect to.modal
- Whether to open modallyname
- Name on the button.title
- Title of window
-
AbstractButtonDialog
protected AbstractButtonDialog(JFrame frame, boolean modal, ResourceBundle resources, String name, String title) This creates an AbstractButtonDialog using the specified resource bundle. This is not recommended by default. -
AbstractButtonDialog
protected AbstractButtonDialog(JDialog dialog, JFrame frame, boolean modal, ResourceBundle resources, String name, String title) This constructor is provided for uses cases where this dialog needs another dialog as a parent.
-
-
Method Details
-
getResult
-
setResult
-
initialize
protected void initialize()Initializes the dialog's UI and preferences. Needs to be called by child classes for initial setup. Anything that overrides this method MUST end by callingAbstractDialog.finalizeInitialization()
- Overrides:
initialize
in classAbstractDialog
-
createButtonPanel
- Returns:
- the created Button Panel
-
okButtonActionPerformed
This is the default Action Event Listener for the Ok Button's action. This triggers the Ok Action, sets the result to confirmed, and then sets the dialog so that it is no longer visible.- Parameters:
evt
- the event triggering this
-
okAction
protected void okAction()Action performed when the Ok button is clicked. -
showDialog
Sets the dialog to be visible, before returning the result- Returns:
- the result of showing the dialog
-