Package megamek.client.ui.panels.abstractPanels

Class AbstractPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

megamek.client.ui.panels.abstractPanels.AbstractPanel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

Direct Known Subclasses:

abstractIconChooserPanel, AbstractScrollablePanel, SkillGenerationOptionsPanel

public abstract class AbstractPanel
extends JPanel

This is the default Panel. It handles preferences, resources, and the frame.

Inheriting classes must call initialize() in their constructor and override initialize().

This is directly tied to MekHQ's AbstractMHQPanel, and any changes here MUST be verified there.

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

Modifier and Type	Field	Description
protected final ResourceBundle	resources

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	AbstractPanel(JFrame frame, String name)	This creates an AbstractPanel using the default resource bundle.
protected	AbstractPanel(JFrame frame, String name, boolean isDoubleBuffered)	This creates an AbstractPanel using the default resource bundle and specified double buffered boolean.
protected	AbstractPanel(JFrame frame, String name, LayoutManager layoutManager)	This creates an AbstractPanel using the default resource bundle and specified layout manager.
protected	AbstractPanel(JFrame frame, String name, LayoutManager layoutManager, boolean isDoubleBuffered)	This creates an AbstractPanel using the default resource bundle and specified layout manager and double buffered boolean.
protected	AbstractPanel(JFrame frame, ResourceBundle resources, String name, LayoutManager layoutManager, boolean isDoubleBuffered)	This creates an AbstractPanel using the specified resource bundle, layout manager, and double buffered boolean.

Method Summary

Modifier and Type	Method	Description
JFrame	getFrame()
protected abstract void	initialize()	This initializes the panel, and must be called by inheriting constructors.
protected void	setCustomPreferences(PreferencesNode preferences)	Adds custom preferences to the child panel.
protected void	setPreferences()	This is used to set preferences based on the preference node for this class.
protected void	setPreferences(PreferencesNode preferences)	This sets the base preferences for this class, and calls the custom preferences method

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

Field Details

resources

protected final ResourceBundle resources

Constructor Details

AbstractPanel

protected AbstractPanel(JFrame frame,
 String name)

This creates an AbstractPanel using the default resource bundle.

AbstractPanel

protected AbstractPanel(JFrame frame,
 String name,
 boolean isDoubleBuffered)

This creates an AbstractPanel using the default resource bundle and specified double buffered boolean.

AbstractPanel

protected AbstractPanel(JFrame frame,
 String name,
 LayoutManager layoutManager)

This creates an AbstractPanel using the default resource bundle and specified layout manager.

AbstractPanel

protected AbstractPanel(JFrame frame,
 String name,
 LayoutManager layoutManager,
 boolean isDoubleBuffered)

This creates an AbstractPanel using the default resource bundle and specified layout manager and double buffered boolean.

AbstractPanel

protected AbstractPanel(JFrame frame,
 ResourceBundle resources,
 String name,
 LayoutManager layoutManager,
 boolean isDoubleBuffered)

This creates an AbstractPanel using the specified resource bundle, layout manager, and double buffered boolean. This is not recommended by default.

Method Details

getFrame

public JFrame getFrame()

initialize

protected abstract void initialize()

This initializes the panel, and must be called by inheriting constructors. This MUST end with a call to setPreferences() for this class to work properly.

setPreferences

protected void setPreferences()
                       throws Exception

This is used to set preferences based on the preference node for this class. It is overridden for MekHQ usage

Throws:

Exception - if there's an issue initializing the preferences. Normally this means a component has not had its name value set.

setPreferences

protected void setPreferences(PreferencesNode preferences)
                       throws Exception

This sets the base preferences for this class, and calls the custom preferences method

Throws:

Exception - if there's an issue initializing the preferences. Normally this means a component has not had its name value set.

setCustomPreferences

protected void setCustomPreferences(PreferencesNode preferences)
                             throws Exception

Adds custom preferences to the child panel.

By default, this panel will track no preferences Other preferences can be added by overriding this method.

Parameters:

preferences - the preference node for this panel

Throws:

Exception - if there's an issue initializing the preferences. Normally this means a component has not had its name value set.