Package net.sf.freecol.client.gui.panel

Class FreeColPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

net.sf.freecol.client.gui.panel.MigPanel

net.sf.freecol.client.gui.panel.FreeColPanel

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible

Direct Known Subclasses:

AboutPanel, BuildQueuePanel, CargoPanel, ChatPanel, ColopediaGameObjectTypePanel, ColopediaPanel, ColorChooserPanel, ConceptDetailPanel, DeclarationPanel, ErrorPanel, EventPanel, FindSettlementPanel, IndianSettlementPanel, InfoPanel, InformationPanel, MainPanel, MapEditorTransformPanel, NewPanel, NewUnitPanel, PortPanel, RecruitPanel, ReportPanel, ServerListPanel, StartGamePanel, StatisticsPanel, StatusPanel, TilePanel, TradeRouteInputPanel, TradeRoutePanel, WorkProductionPanel

public abstract class FreeColPanel
extends MigPanel
implements java.awt.event.ActionListener

Superclass for all panels in FreeCol.

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JPanel.AccessibleJPanel

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	CANCEL
protected boolean	editable
private FreeColClient	freeColClient
protected static java.lang.String	HELP
private static java.util.logging.Logger	logger
protected static int	MARGIN
protected static java.lang.String	NL_SPAN_SPLIT_2
protected static java.lang.String	OK
protected javax.swing.JButton	okButton
protected static java.lang.String	SPAN_SPLIT_2

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	FreeColPanel(FreeColClient freeColClient)	Constructor.
protected	FreeColPanel(FreeColClient freeColClient, java.lang.String uiClassId, java.awt.LayoutManager layout)	Default constructor.

Method Summary

Modifier and Type	Method	Description
void	actionPerformed(java.awt.event.ActionEvent ae)
FreeColPanel	addClosingCallback(java.lang.Runnable runnable)	Add a routine to be called when this panel closes.
javax.swing.JButton	createColonyButton(Colony colony)	Create a button for a colony.
protected ClientOptions	getClientOptions()	Get the client options.
protected FreeColClient	getFreeColClient()	Get the FreeColClient.
protected Game	getGame()	Get the game.
protected GUI	getGUI()	Get the GUI.
protected ImageLibrary	getImageLibrary()	Get the image library.
protected Map	getMap()	Get the map.
protected Player	getMyPlayer()	Get the player.
java.awt.image.BufferedImage	getSmallAbstractUnitImage(AbstractUnit au)	Helper to get a small single abstract unit image.
protected Specification	getSpecification()	Get the game specification.
InGameController	igc()	Get the client controller.
protected boolean	isEditable()	Is this panel editable?
void	removeNotify()
void	requestFocus()
void	setCancelComponent(javax.swing.AbstractButton cancelButton)	Make the given button the CANCEL button.

Methods inherited from class net.sf.freecol.client.gui.panel.MigPanel

getMigLayout, getUIClassID

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, 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, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, 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 Detail

logger

private static final java.util.logging.Logger logger

CANCEL

protected static final java.lang.String CANCEL

See Also:

Constant Field Values

OK

protected static final java.lang.String OK

See Also:

Constant Field Values

HELP

protected static final java.lang.String HELP

See Also:

Constant Field Values

SPAN_SPLIT_2

protected static final java.lang.String SPAN_SPLIT_2

See Also:

Constant Field Values

NL_SPAN_SPLIT_2

protected static final java.lang.String NL_SPAN_SPLIT_2

See Also:

Constant Field Values

MARGIN

protected static final int MARGIN

See Also:

Constant Field Values

freeColClient

private final FreeColClient freeColClient

editable

protected boolean editable

okButton

protected javax.swing.JButton okButton

Constructor Detail

FreeColPanel

protected FreeColPanel(FreeColClient freeColClient)

Constructor.

Parameters:

freeColClient - The FreeColClient for the game.

FreeColPanel

protected FreeColPanel(FreeColClient freeColClient,
                       java.lang.String uiClassId,
                       java.awt.LayoutManager layout)

Default constructor.

Parameters:

freeColClient - The FreeColClient for the game.

uiClassId - An optional L+F class to render this component.

layout - The LayoutManager to be used.

Method Detail

getFreeColClient

protected final FreeColClient getFreeColClient()

Get the FreeColClient.

Returns:

The current FreeColClient.

isEditable

protected final boolean isEditable()

Is this panel editable?

Returns:

True if the panel is editable.

getGame

protected final Game getGame()

Get the game.

Returns:

The current Game.

getMap

protected final Map getMap()

Get the map.

Returns:

The current Map.

getGUI

protected final GUI getGUI()

Get the GUI.

Returns:

The current GUI.

getImageLibrary

protected final ImageLibrary getImageLibrary()

Get the image library.

Returns:

The ImageLibrary.

getSpecification

protected Specification getSpecification()

Get the game specification.

Returns:

The Specification.

getMyPlayer

protected final Player getMyPlayer()

Get the player.

Returns:

The client Player.

getClientOptions

protected final ClientOptions getClientOptions()

Get the client options.

Returns:

The ClientOptions.

igc

public final InGameController igc()

Get the client controller.

Returns:

The client InGameController.

createColonyButton

public javax.swing.JButton createColonyButton(Colony colony)

Create a button for a colony.

Parameters:

colony - The Colony to create a button for.

Returns:

The new button.

setCancelComponent

public final void setCancelComponent(javax.swing.AbstractButton cancelButton)

Make the given button the CANCEL button.

Parameters:

cancelButton - an AbstractButton value

addClosingCallback

public FreeColPanel addClosingCallback(java.lang.Runnable runnable)

Add a routine to be called when this panel closes. Triggered by Canvas.notifyClose.

Parameters:

runnable - Some code to run on close.

Returns:

This panel.

getSmallAbstractUnitImage

public java.awt.image.BufferedImage getSmallAbstractUnitImage(AbstractUnit au)

Helper to get a small single abstract unit image.

Parameters:

au - The AbstractUnit to examine.

Returns:

A suitable BufferedImage.

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent ae)

Specified by:

actionPerformed in interface java.awt.event.ActionListener

removeNotify

public void removeNotify()

Overrides:

removeNotify in class MigPanel

requestFocus

public void requestFocus()

Overrides:

requestFocus in class javax.swing.JComponent