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

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by javax.swing.JPanel
                  extended by net.sf.freecol.client.gui.panel.FreeColPanel
                      extended by net.sf.freecol.client.gui.panel.ColonyPanel
All Implemented Interfaces:
java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.beans.PropertyChangeListener, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible

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

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.BuildingsPanel
          This panel is a list of the colony's buildings.
 class ColonyPanel.ColonyCargoPanel
          This panel shows the content of a carrier in the colony
 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.
 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.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Nested classes/interfaces inherited from class java.awt.Component
java.awt.Component.BaselineResizeBehavior
 
Field Summary
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
CELLBORDER, emptyMargin, LEFTCELLBORDER, TOPCELLBORDER, TOPLEFTCELLBORDER
 
Fields inherited from class javax.swing.JComponent
TOOL_TIP_TEXT_KEY, 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(Colony colony, Canvas parent)
          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.
 CargoPanel getCargoPanel()
          Returns a pointer to the CargoPanel-object in use.
 Colony getColony()
          Returns a pointer to the Colony-pointer in use.
 java.awt.Dimension getSavedSize()
          Get the SavedSize value.
 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)
          Initialize the data on the window.
 void initialize(Colony colony, Unit preSelectedUnit)
          Initialize the data on the window.
 void propertyChange(java.beans.PropertyChangeEvent e)
           
 void requestFocus()
          The OK button requests focus.
 void setSavedSize(java.awt.Dimension newSavedSize)
          Set the SavedSize value.
 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 updateInPortPanel()
           
 void updateProductionPanel()
           
 void updateTilePanel()
           
 
Methods inherited from class net.sf.freecol.client.gui.panel.FreeColPanel
createEventForwardingMouseListener, createEventForwardingMouseMotionListener, enterPressesWhenFocused, getCanvas, getClient, getController, getDefaultHeader, getDefaultTextArea, getDefaultTextArea, getDefaultTextPane, getDefaultTextPane, getGame, getLibrary, getLinkButton, getModifierFormat, getMyPlayer, isEditable, setCancelComponent, sortModifiers
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, setUI, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, 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, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, 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, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, 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, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, 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, 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
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

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(Colony colony,
                   Canvas parent)
The constructor for the panel.

Parameters:
parent - The parent of this panel
Method Detail

requestFocus

public void requestFocus()
Description copied from class: FreeColPanel
The OK button requests focus.

Overrides:
requestFocus in class FreeColPanel

getSavedSize

public final java.awt.Dimension getSavedSize()
Get the SavedSize value.

Returns:
a Dimension value

setSavedSize

public final void setSavedSize(java.awt.Dimension newSavedSize)
Set the SavedSize value.

Overrides:
setSavedSize in class FreeColPanel
Parameters:
newSavedSize - The new SavedSize value.

initialize

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

Parameters:
colony - The Colony to be displayed.

initialize

public void initialize(Colony colony,
                       Unit preSelectedUnit)
Initialize the data on the window.

Parameters:
colony - The Colony to be displayed.
preSelectedUnit - This Unit will be selected if it is not null and it is a carrier located in the given Colony.

updateInPortPanel

public void updateInPortPanel()

updateTilePanel

public void updateTilePanel()

updateProductionPanel

public void updateProductionPanel()

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
Overrides:
actionPerformed in class FreeColPanel
Parameters:
event - The incoming action event

closeColonyPanel

public void closeColonyPanel()
Closes the ColonyPanel.


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 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.

getColony

public final Colony getColony()
Returns a pointer to the Colony-pointer in use.

Returns:
The Colony.

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent e)
Specified by:
propertyChange in interface java.beans.PropertyChangeListener