net.sf.freecol.client.gui.panel
Class ColonyPanel

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  net.sf.freecol.client.gui.panel.FreeColPanel
                      net.sf.freecol.client.gui.panel.ColonyPanel

All Implemented Interfaces:

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

public final class ColonyPanel
extends FreeColPanel
implements java.awt.event.ActionListener

This is a panel for the Colony display. It shows the units that are working in the colony, the buildings and much more.

See Also:

Serialized Form

Nested Class Summary

class	ColonyPanel.BuildingBox A combo box that contains a list of all the buildings that can be built in this colony.
class	ColonyPanel.BuildingsPanel This panel is a list of the colony's buildings.
class	ColonyPanel.CargoPanel A panel that holds units and goods that represent Units and cargo that are on board the currently selected ship.
class	ColonyPanel.InPortPanel A panel that holds UnitsLabels that represent naval Units that are waiting in the port of the colony.
class	ColonyPanel.OutsideColonyPanel A panel that holds UnitsLabels that represent Units that are standing in front of a colony.
static class	ColonyPanel.ProductionPanel This panel holds the information of the current food, liberty bell and cross production.
class	ColonyPanel.TilePanel A panel that displays the tiles in the immediate area around the colony.
class	ColonyPanel.WarehousePanel A panel that holds goods that represent cargo that is inside the Colony.

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.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

static java.lang.String	COPYRIGHT
static java.lang.String	LICENSE
static java.lang.String	REVISION
static int	SCROLL_AREA_HEIGHT The height of the area in which autoscrolling should happen.
static int	SCROLL_SPEED The speed of the scrolling.

Fields inherited from class net.sf.freecol.client.gui.panel.FreeColPanel

bigHeaderFont, columns, defaultFont, higConst, margin, mediumHeaderFont, smallHeaderFont

Fields inherited from class javax.swing.JComponent

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

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

ColonyPanel(Canvas parent, FreeColClient freeColClient)
The constructor for the panel.

Method Summary

void	actionPerformed(java.awt.event.ActionEvent event) Analyzes an event and calls the right external methods to take care of the user's request.
void	closeColonyPanel() Closes the ColonyPanel.
ColonyPanel.CargoPanel	getCargoPanel() Returns a pointer to the CargoPanel-object in use.
FreeColClient	getClient() Returns a pointer to the FreeColClient which uses this panel.
Colony	getColony() Returns a pointer to the Colony-pointer in use.
Game	getGame() Returns the current Game.
Unit	getSelectedUnit() Returns the currently select unit.
UnitLabel	getSelectedUnitLabel() Returns the currently select unit.
ColonyPanel.TilePanel	getTilePanel() Returns a pointer to the TilePanel-object in use.
ColonyPanel.WarehousePanel	getWarehousePanel() Returns a pointer to the WarehousePanel-object in use.
void	initialize(Colony colony, Game game) Initialize the data on the window.
void	initialize(Colony colony, Game game, Unit preSelectedUnit) Initialize the data on the window.
void	paintComponent(java.awt.Graphics g) Paints this component.
void	refresh() Refreshes this panel.
void	reinitialize()
void	requestFocus()
void	setSelectedUnit(Unit unit) Selects a unit that is located somewhere on this panel.
void	setSelectedUnitLabel(UnitLabel unitLabel) Selects a unit that is located somewhere on this panel.
void	updateBuildingBox()
void	updateBuildingsPanel()
void	updateNameBox()
void	updateWarehouse()

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

enterPressesWhenFocused, getCanvas, getDefaultHeader, getDefaultTextArea, setCancelComponent

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, 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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, 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, transferFocusBackward, 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, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, 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, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

LICENSE

public static final java.lang.String LICENSE

See Also:

Constant Field Values

REVISION

public static final java.lang.String REVISION

See Also:

Constant Field Values

SCROLL_AREA_HEIGHT

public static final int SCROLL_AREA_HEIGHT

The height of the area in which autoscrolling should happen.

See Also:

Constant Field Values

SCROLL_SPEED

public static final int SCROLL_SPEED

The speed of the scrolling.

See Also:

Constant Field Values

Constructor Detail

ColonyPanel

public ColonyPanel(Canvas parent,
                   FreeColClient freeColClient)

The constructor for the panel.

Parameters:

parent - The parent of this panel

freeColClient - The main controller object for the client.

Method Detail

requestFocus

public void requestFocus()

Overrides:

requestFocus in class javax.swing.JComponent

refresh

public void refresh()

Refreshes this panel.

initialize

public void initialize(Colony colony,
                       Game game)

Initialize the data on the window. This is the same as calling: initialize(colony, game, null).

Parameters:

colony - The Colony to be displayed.

game - The Game in which the given Colony is a part of.

initialize

public void initialize(Colony colony,
                       Game game,
                       Unit preSelectedUnit)

Initialize the data on the window.

Parameters:

colony - The Colony to be displayed.

game - The Game in which the given Colony is a part of.

preSelectedUnit - This Unit will be selected if it is not null and it is a carrier located in the given Colony.

reinitialize

public void reinitialize()

updateNameBox

public void updateNameBox()

updateBuildingBox

public void updateBuildingBox()

updateWarehouse

public void updateWarehouse()

updateBuildingsPanel

public void updateBuildingsPanel()

getSelectedUnit

public Unit getSelectedUnit()

Returns the currently select unit.

Returns:

The currently select unit.

getSelectedUnitLabel

public UnitLabel getSelectedUnitLabel()

Returns the currently select unit.

Returns:

The currently select unit.

actionPerformed

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

Analyzes an event and calls the right external methods to take care of the user's request.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Parameters:

event - The incoming action event

closeColonyPanel

public void closeColonyPanel()

Closes the ColonyPanel.

paintComponent

public void paintComponent(java.awt.Graphics g)

Paints this component.

Overrides:

paintComponent in class javax.swing.JComponent

Parameters:

g - The graphics context in which to paint.

setSelectedUnit

public void setSelectedUnit(Unit unit)

Selects a unit that is located somewhere on this panel.

Parameters:

unit - The unit that is being selected.

setSelectedUnitLabel

public void setSelectedUnitLabel(UnitLabel unitLabel)

Selects a unit that is located somewhere on this panel.

Parameters:

unitLabel - The unit that is being selected.

getCargoPanel

public final ColonyPanel.CargoPanel getCargoPanel()

Returns a pointer to the CargoPanel-object in use.

Returns:

The CargoPanel.

getWarehousePanel

public final ColonyPanel.WarehousePanel getWarehousePanel()

Returns a pointer to the WarehousePanel-object in use.

Returns:

The WarehousePanel.

getTilePanel

public final ColonyPanel.TilePanel getTilePanel()

Returns a pointer to the TilePanel-object in use.

Returns:

The TilePanel.

getClient

public final FreeColClient getClient()

Returns a pointer to the FreeColClient which uses this panel.

Returns:

The FreeColClient.

getColony

public final Colony getColony()

Returns a pointer to the Colony-pointer in use.

Returns:

The Colony.

getGame

public final Game getGame()

Returns the current Game.

Returns:

The current Game.